Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzToolsFramework::EditorInteractionSystemViewportSelection Class Referenceabstract

#include <EditorInteractionSystemViewportSelectionRequestBus.h>

Inherits AzToolsFramework::ViewportInteraction::InternalViewportSelectionRequests.

Public Member Functions

virtual const EditorVisibleEntityDataCacheInterface * GetEntityDataCache () const =0
 
virtual void SetHandler (const ViewportSelectionRequestsBuilderFn &interactionRequestsBuilder)=0
 
virtual void SetDefaultHandler ()=0
 

Detailed Description

Interface for system component implementing the ViewportSelectionRequests interface. This interface also includes a setter to set a custom handler also implementing the ViewportSelectionRequests interface to customize editor behavior.

Member Function Documentation

◆ GetEntityDataCache()

virtual const EditorVisibleEntityDataCacheInterface * AzToolsFramework::EditorInteractionSystemViewportSelection::GetEntityDataCache ( ) const
pure virtual

GetEntityDataCache enables callers to get access to the current entity data cache. No assumptions should be made about the lifetime of this pointer, it may get destroyed and recreated every time the Editor interaction handler is changed.

◆ SetDefaultHandler()

virtual void AzToolsFramework::EditorInteractionSystemViewportSelection::SetDefaultHandler ( )
pure virtual

SetDefaultHandler is a utility function to set the default editor handler (currently EditorDefaultSelection). This is useful to call after setting another mode and then wishing to return to normal operation of the editor.

◆ SetHandler()

virtual void AzToolsFramework::EditorInteractionSystemViewportSelection::SetHandler ( const ViewportSelectionRequestsBuilderFn &  interactionRequestsBuilder)
pure virtual

SetHandler takes a factory function to create a new type implementing the ViewportSelectionRequests interface. It provides a handler implementing ViewportSelectionRequests to handle all viewport mouse input and drawing.

The documentation for this class was generated from the following file: