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::ComponentModeFramework::ComponentMode Class Referenceabstract

#include <EditorComponentModeBus.h>

Inherited by AzToolsFramework::ComponentModeFramework::ComponentModeRequests.

Public Member Functions

virtual AZ::Uuid GetComponentType () const =0
 The type of the underlying Component this mode is for.
 
virtual AZ::Uuid GetComponentModeType () const =0
 The type of the Component Mode.
 
virtual AZ::ComponentId GetComponentId () const =0
 The Id of the underlying Component this mode is associated with.
 
virtual void Refresh ()=0
 
virtual AZStd::vector< ActionOverride > PopulateActions ()=0
 Notify the ActionManager which actions should be enabled for this Mode.
 
virtual AZStd::vector< ViewportUi::ClusterId > PopulateViewportUi ()=0
 Add UI elements for this ComponentMode onto the Viewport UI system.
 
virtual AZStd::string GetComponentModeName () const =0
 The name for the ComponentMode to be displayed.
 

Detailed Description

Foundational interface for any Component wishing to implement ComponentMode. Components wishing to implement ComponentMode should inherit from EditorBaseComponentMode, not ComponentMode directly.

Member Function Documentation

◆ Refresh()

virtual void AzToolsFramework::ComponentModeFramework::ComponentMode::Refresh ( )
pure virtual

Notify ComponentMode that something external to it has changed and its state should be updated (Manipulators etc).

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