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 Types | Public Member Functions | Static Public Attributes | List of all members
AzToolsFramework::EditorPickModeRequests Class Referenceabstract

#include <ToolsApplicationAPI.h>

Inherits AZ::EBusTraits.

Public Types

using Bus = AZ::EBus< EditorPickModeRequests >
 
using BusIdType = AzFramework::EntityContextId
 

Public Member Functions

virtual void StopEntityPickMode ()=0
 
virtual void PickModeSelectEntity (AZ::EntityId entityId)=0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

Bus for editor requests related to Pick Mode.

Member Function Documentation

◆ PickModeSelectEntity()

virtual void AzToolsFramework::EditorPickModeRequests::PickModeSelectEntity ( AZ::EntityId  entityId)
pure virtual

When in Pick Mode, set the picked entity to the assigned slot(s).

Note
It is only valid to make this request when the editor is in Pick Mode.

◆ StopEntityPickMode()

virtual void AzToolsFramework::EditorPickModeRequests::StopEntityPickMode ( )
pure virtual

Move the Editor out of Pick Mode. Note: The Editor is moved into Pick Mode by a button in the Entity Inspector UI.

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