Open 3D Engine LyShine Gem API Reference  24.09
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 | Protected Member Functions | Protected Attributes | List of all members
UiCanvasAssetRefComponent Class Reference

Inherits AZ::Component, UiCanvasRefBus::Handler, UiCanvasAssetRefBus::Handler, and UiCanvasManagerNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (UiCanvasAssetRefComponent, "{05BED4D7-E331-4020-9C17-BD3F4CE4DE85}")
 
AZ::EntityId GetCanvas () override
 
AZStd::string GetCanvasPathname () override
 
void SetCanvasPathname (const AZStd::string &pathname) override
 
bool GetIsAutoLoad () override
 
void SetIsAutoLoad (bool isAutoLoad) override
 
bool GetShouldLoadDisabled () override
 
void SetShouldLoadDisabled (bool shouldLoadDisabled) override
 
AZ::EntityId LoadCanvas () override
 
void UnloadCanvas () override
 
void OnCanvasUnloaded (AZ::EntityId canvasEntityId) override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices ([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void LaunchUIEditor (const AZ::Data::AssetId &assetId, const AZ::Data::AssetType &)
 
void Activate () override
 
void Deactivate () override
 
 AZ_DISABLE_COPY_MOVE (UiCanvasAssetRefComponent)
 

Protected Attributes

AzFramework::SimpleAssetReference< LyShine::CanvasAsset > m_canvasAssetRef
 Persistent properties.
 
bool m_isAutoLoad
 
bool m_shouldLoadDisabled
 
AZ::EntityId m_canvasEntityId
 The UI Canvas that is associated with this component entity.
 
The documentation for this class was generated from the following file: