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

Inherits AZ::Component, UiSystemBus::Handler, UiSystemToolsBus::Handler, UiFrameworkBus::Handler, CrySystemEventBus::Handler, and ILevelSystemListener.

Public Member Functions

 AZ_COMPONENT (LyShineSystemComponent, lyShineSystemComponentUuid)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void SetLyShineComponentDescriptors (const AZStd::list< AZ::ComponentDescriptor * > *descriptors)
 

Protected Member Functions

void Init () override
 
void Activate () override
 
void Deactivate () override
 
void RegisterComponentTypeForMenuOrdering (const AZ::Uuid &typeUuid) override
 
const AZStd::vector< AZ::Uuid > * GetComponentTypesForMenuOrdering () override
 
const AZStd::list< AZ::ComponentDescriptor * > * GetLyShineComponentDescriptors () override
 
CanvasAssetHandle * LoadCanvasFromStream (AZ::IO::GenericStream &stream, const AZ::ObjectStream::FilterDescriptor &filterDesc) override
 
void SaveCanvasToStream (CanvasAssetHandle *canvas, AZ::IO::FileIOStream &stream) override
 
AZ::SliceComponent * GetRootSliceSliceComponent (CanvasAssetHandle *canvas) override
 
AZ::Entity * GetRootSliceEntity (CanvasAssetHandle *canvas) override
 
AZ::Entity * GetCanvasEntity (CanvasAssetHandle *canvas) override
 
void ReplaceRootSliceSliceComponent (CanvasAssetHandle *canvas, AZ::SliceComponent *newSliceComponent) override
 
void ReplaceCanvasEntity (UiSystemToolsInterface::CanvasAssetHandle *canvas, AZ::Entity *newCanvasEntity) override
 
void DestroyCanvas (CanvasAssetHandle *canvas) override
 
bool HasUiElementComponent (AZ::Entity *entity) override
 
void AddEditorOnlyEntity (AZ::Entity *editorOnlyEntity, EntityIdSet &editorOnlyEntities) override
 
void HandleEditorOnlyEntities (const EntityList &exportSliceEntities, const EntityIdSet &editorOnlyEntityIds) override
 
void OnCrySystemInitialized (ISystem &system, const SSystemInitParams &) override
 
void OnCrySystemShutdown (ISystem &) override
 
void OnUnloadComplete (const char *levelName) override
 
void BroadcastCursorImagePathname ()
 
void LoadPassTemplateMappings ()
 

Protected Attributes

AZStd::unique_ptr< ILyShine > m_lyShine
 
AzFramework::SimpleAssetReference< LmbrCentral::TextureAsset > m_cursorImagePathname
 
AZStd::vector< AZ::Uuid > m_componentTypes
 
AZ::RPI::PassSystemInterface::OnReadyLoadTemplatesEvent::Handler m_loadTemplatesHandler
 

Static Protected Attributes

static const AZStd::list< AZ::ComponentDescriptor * > * m_componentDescriptors
 
The documentation for this class was generated from the following file: