AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode Class Reference

#include <EditorBaseComponentMode.h>

Inherits ComponentModeRequestBus::Handler, and Prefab::PrefabPublicNotificationBus::Handler.

Inherited by AzToolsFramework::BaseShapeComponentMode, and AzToolsFramework::Components::NonUniformScaleComponentMode.

Public Member Functions
AZStd::vector< ActionOverride >	PopulateActions () final
AZStd::vector< ViewportUi::ClusterId >	PopulateViewportUi () final
	Populate the Viewport UI widget for this ComponentMode.
void	PostHandleMouseInteraction () final
	ComponentModeRequestBus ...

Static Public Member Functions
static AZ_CLASS_ALLOCATOR_DECL void	Reflect (AZ::ReflectContext *context)
static void	RegisterActions ()
static void	BindActionsToModes ()
static void	BindActionsToMenus ()

Protected Member Functions
AZ::EntityId	GetEntityId () const
	The EntityId this ComponentMode instance is associated with.
AZ::EntityComponentIdPair	GetEntityComponentIdPair () const
AZ::ComponentId	GetComponentId () const final
	The ComponentId this ComponentMode instance is associated with.
AZ::Uuid	GetComponentType () const final
	The underlying Component type for this ComponentMode.
AZ::Uuid	GetComponentModeType () const
virtual AZStd::vector< ViewportUi::ClusterId >	PopulateViewportUiImpl ()

Detailed Description

Abstract class to be inherited from by concrete ComponentModes. Exposes ComponentMode interface and handles some useful common functionality all ComponentModes require.

Member Function Documentation

BindActionsToMenus()

static void AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode::BindActionsToMenus ( )

inlinestatic

Bind actions to appear in menus. This is provided as guidance but it will not be called automatically; you will need a system component to call it in the OnMenuBindingHook handler.

BindActionsToModes()

static void AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode::BindActionsToModes ( )

inlinestatic

Bind actions to appear in this component mode. This is provided as guidance but it will not be called automatically; you will need a system component to call it in the OnActionContextModeBindingHook handler.

GetEntityComponentIdPair()

AZ::EntityComponentIdPair AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode::GetEntityComponentIdPair ( ) const

inlineprotected

The combined Entity and Component Id to uniquely identify a specific Component on a given Entity. Note: This is required when more than one Component of the same type can exists on an Entity at a time.

PopulateActions()

AZStd::vector< ActionOverride > AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode::PopulateActions ( )

final

ComponentMode interface - populate actions for this ComponentMode. When PopulateActions is called, if a second action override is found with the same key, it should override the existing action if one already exists. (e.g. The 'escape' key will first deselect a vertex, then leave ComponentMode if an action is added to deselect a vertex when one is selected)

Attention

More specific actions come later in the ordering when they are added.

PopulateViewportUiImpl()

virtual AZStd::vector< ViewportUi::ClusterId > AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode::PopulateViewportUiImpl ( )

protectedvirtual

EditorBaseComponentMode interface

See also

To be overridden by derived ComponentModes

RegisterActions()

static void AzToolsFramework::ComponentModeFramework::EditorBaseComponentMode::RegisterActions ( )

inlinestatic

Register additional actions for this component mode. This is provided as guidance but it will not be called automatically; you will need a system component to call it in the OnActionRegistrationHook handler.

---

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

• Code/Framework/AzToolsFramework/AzToolsFramework/ComponentMode/EditorBaseComponentMode.h