#include <EditorBaseComponentMode.h>
Inherits ComponentModeRequestBus::Handler, and Prefab::PrefabPublicNotificationBus::Handler.
Inherited by AzToolsFramework::BaseShapeComponentMode, and AzToolsFramework::Components::NonUniformScaleComponentMode.
Abstract class to be inherited from by concrete ComponentModes. Exposes ComponentMode interface and handles some useful common functionality all ComponentModes require.
◆ 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 |
◆ 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