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 | Static Public Member Functions | List of all members
AzToolsFramework::Components::EditorEntityUiSystemComponent Class Referencefinal

A System Component to manage UI overrides for Editor Entities. More...

#include <EditorEntityUiSystemComponent.h>

Inherits AZ::Component, and AzToolsFramework::EditorEntityUiInterface.

Public Member Functions

 AZ_COMPONENT (EditorEntityUiSystemComponent, "{65D3C8AB-7BA7-4FC1-9297-49C9602E32D2}")
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
EditorEntityUiHandlerId RegisterHandler (EditorEntityUiHandlerBase *handler) override
 
void UnregisterHandler (EditorEntityUiHandlerBase *handler) override
 
bool RegisterEntity (AZ::EntityId entityId, EditorEntityUiHandlerId handlerId) override
 
bool UnregisterEntity (AZ::EntityId entityId) override
 
EditorEntityUiHandlerBase * GetHandler (AZ::EntityId entityId) override
 
- Public Member Functions inherited from AzToolsFramework::EditorEntityUiInterface
 AZ_RTTI (EditorEntityUiInterface, "{E9966C1E-EC61-40B4-805D-47A1F0CFF6B0}")
 
virtual EditorEntityUiHandlerId RegisterHandler (EditorEntityUiHandlerBase *handler)=0
 
virtual void UnregisterHandler (EditorEntityUiHandlerBase *handler)=0
 
virtual bool RegisterEntity (AZ::EntityId entityId, EditorEntityUiHandlerId handlerId)=0
 
virtual bool UnregisterEntity (AZ::EntityId entityId)=0
 
virtual EditorEntityUiHandlerBase * GetHandler (AZ::EntityId entityId)=0
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

A System Component to manage UI overrides for Editor Entities.

Member Function Documentation

◆ GetHandler()

EditorEntityUiHandlerBase * AzToolsFramework::Components::EditorEntityUiSystemComponent::GetHandler ( AZ::EntityId  entityId)
overridevirtual

Implements AzToolsFramework::EditorEntityUiInterface.

◆ RegisterEntity()

bool AzToolsFramework::Components::EditorEntityUiSystemComponent::RegisterEntity ( AZ::EntityId  entityId,
EditorEntityUiHandlerId  handlerId 
)
overridevirtual

Implements AzToolsFramework::EditorEntityUiInterface.

◆ RegisterHandler()

EditorEntityUiHandlerId AzToolsFramework::Components::EditorEntityUiSystemComponent::RegisterHandler ( EditorEntityUiHandlerBase *  handler)
overridevirtual

Implements AzToolsFramework::EditorEntityUiInterface.

◆ UnregisterEntity()

bool AzToolsFramework::Components::EditorEntityUiSystemComponent::UnregisterEntity ( AZ::EntityId  entityId)
overridevirtual

Implements AzToolsFramework::EditorEntityUiInterface.

◆ UnregisterHandler()

void AzToolsFramework::Components::EditorEntityUiSystemComponent::UnregisterHandler ( EditorEntityUiHandlerBase *  handler)
overridevirtual

Implements AzToolsFramework::EditorEntityUiInterface.

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