Open 3D Engine LyShine Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
UiCanvasComponent Member List

This is the complete list of members for UiCanvasComponent, including all inherited members.

AbortSequence(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
Activate() override (defined in UiCanvasComponent)UiCanvasComponentprotected
ActiveCancelled() override (defined in UiCanvasComponent)UiCanvasComponent
ActiveChanged(AZ::EntityId m_newActiveInteractable, bool shouldStayActive) override (defined in UiCanvasComponent)UiCanvasComponent
AddElement(AZ::Entity *element, AZ::Entity *parent, AZ::Entity *insertBefore) override (defined in UiCanvasComponent)UiCanvasComponent
AddHorizontalGuide(float position) override (defined in UiCanvasComponent)UiCanvasComponent
AddVerticalGuide(float position) override (defined in UiCanvasComponent)UiCanvasComponent
AZ_COMPONENT(UiCanvasComponent, LyShine::UiCanvasComponentUuid, AZ::Component) (defined in UiCanvasComponent)UiCanvasComponent
CheckForOrphanedElements() override (defined in UiCanvasComponent)UiCanvasComponent
ClearAllInteractables() override (defined in UiCanvasComponent)UiCanvasComponent
CloneAndInitializeCanvas(UiEntityContext *entityContext, const AZStd::string &assetIdPathname, const AZ::Vector2 *canvasSize=nullptr)UiCanvasComponent
CloneCanvas(const AZ::Vector2 &canvasSize) override (defined in UiCanvasComponent)UiCanvasComponent
CloneElement(AZ::Entity *sourceEntity, AZ::Entity *parentEntity) override (defined in UiCanvasComponent)UiCanvasComponent
CloneElementEntityId(AZ::EntityId sourceEntity, AZ::EntityId parentEntity, AZ::EntityId insertBefore) override (defined in UiCanvasComponent)UiCanvasComponent
CreateChildElement(const LyShine::NameType &name) override (defined in UiCanvasComponent)UiCanvasComponent
Deactivate() override (defined in UiCanvasComponent)UiCanvasComponentprotected
DeactivateElements()UiCanvasComponent
DebugDisplayChildElemBounds(IDraw2d *draw2d, const AZ::EntityId entity) const (defined in UiCanvasComponent)UiCanvasComponent
DebugDisplayElemBounds(IDraw2d *draw2d) const (defined in UiCanvasComponent)UiCanvasComponent
DebugInfoCountChildren(const AZ::EntityId entity, bool parentEnabled, DebugInfoNumElements &info) const (defined in UiCanvasComponent)UiCanvasComponent
DebugReportDrawCalls(AZ::IO::HandleType fileHandle, LyShineDebug::DebugInfoDrawCallReport &reportInfo, void *context) const (defined in UiCanvasComponent)UiCanvasComponent
EUiAnimationEvent enum name (defined in IUiAnimationListener)IUiAnimationListener
eUiAnimationEvent_Aborted enum value (defined in IUiAnimationListener)IUiAnimationListener
eUiAnimationEvent_Started enum value (defined in IUiAnimationListener)IUiAnimationListener
eUiAnimationEvent_Stopped enum value (defined in IUiAnimationListener)IUiAnimationListener
eUiAnimationEvent_Updated enum value (defined in IUiAnimationListener)IUiAnimationListener
FindElementByHierarchicalName(const LyShine::NameType &name) override (defined in UiCanvasComponent)UiCanvasComponent
FindElementById(LyShine::ElementId id) override (defined in UiCanvasComponent)UiCanvasComponent
FindElementByName(const LyShine::NameType &name) override (defined in UiCanvasComponent)UiCanvasComponent
FindElementEntityIdByName(const LyShine::NameType &name) override (defined in UiCanvasComponent)UiCanvasComponent
FindElements(AZStd::function< bool(const AZ::Entity *)> predicate, LyShine::EntityArray &result) override (defined in UiCanvasComponent)UiCanvasComponent
FindElementsByName(const LyShine::NameType &name, LyShine::EntityArray &result) override (defined in UiCanvasComponent)UiCanvasComponent
FindInteractableToHandleEvent(AZ::Vector2 point) override (defined in UiCanvasComponent)UiCanvasComponent
FixupCreatedEntities(LyShine::EntityArray topLevelEntities, bool makeUniqueNamesAndIds, AZ::Entity *optionalInsertionPoint) override (defined in UiCanvasComponent)UiCanvasComponent
ForceActiveInteractable(AZ::EntityId interactableId, bool shouldStayActive, AZ::Vector2 point) override (defined in UiCanvasComponent)UiCanvasComponent
ForceEnterInputEventOnInteractable(AZ::EntityId interactableId) override (defined in UiCanvasComponent)UiCanvasComponent
ForceFocusInteractable(AZ::EntityId interactableId) override (defined in UiCanvasComponent)UiCanvasComponent
ForceHoverInteractable(AZ::EntityId interactableId) override (defined in UiCanvasComponent)UiCanvasComponent
GenerateId() (defined in UiCanvasComponent)UiCanvasComponent
GetAnimationSystem() override (defined in UiCanvasComponent)UiCanvasComponent
GetAttachmentImageAsset() override (defined in UiCanvasComponent)UiCanvasComponent
GetAuthoredCanvasSize() override (defined in UiCanvasComponent)UiCanvasComponent
GetCanvasId() override (defined in UiCanvasComponent)UiCanvasComponent
GetCanvasSize() override (defined in UiCanvasComponent)UiCanvasComponent
GetCanvasToViewportMatrix() override (defined in UiCanvasComponent)UiCanvasComponent
GetChildElement(int index) override (defined in UiCanvasComponent)UiCanvasComponent
GetChildElementEntityId(int index) override (defined in UiCanvasComponent)UiCanvasComponent
GetChildElementEntityIds() override (defined in UiCanvasComponent)UiCanvasComponent
GetChildElements() override (defined in UiCanvasComponent)UiCanvasComponent
GetDebugInfoInteractables(AZ::EntityId &activeInteractable, AZ::EntityId &hoverInteractable) const (defined in UiCanvasComponent)UiCanvasComponent
GetDebugInfoNumElements(DebugInfoNumElements &info) const (defined in UiCanvasComponent)UiCanvasComponent
GetDebugInfoRenderGraph(LyShineDebug::DebugInfoRenderGraph &info) const (defined in UiCanvasComponent)UiCanvasComponent
GetDeviceScale() override (defined in UiCanvasComponent)UiCanvasComponent
GetDrawOrder() override (defined in UiCanvasComponent)UiCanvasComponent
GetEditorToGameEntityIdMap()UiCanvasComponentinline
GetEnabled() override (defined in UiCanvasComponent)UiCanvasComponent
GetGuideColor() override (defined in UiCanvasComponent)UiCanvasComponent
GetGuidesAreLocked() override (defined in UiCanvasComponent)UiCanvasComponent
GetHorizontalGuidePositions() override (defined in UiCanvasComponent)UiCanvasComponent
GetHoverInteractable() override (defined in UiCanvasComponent)UiCanvasComponent
GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType &incompatible) (defined in UiCanvasComponent)UiCanvasComponentinlinestatic
GetIsConsumingAllInputEvents() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsMultiTouchSupported() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsNavigationSupported() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsPixelAligned() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsPositionalInputSupported() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsRenderToTexture() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsSnapEnabled() override (defined in UiCanvasComponent)UiCanvasComponent
GetIsTextPixelAligned() override (defined in UiCanvasComponent)UiCanvasComponent
GetKeepLoadedOnLevelUnload() override (defined in UiCanvasComponent)UiCanvasComponent
GetLocalUserIdInputFilter() override (defined in UiCanvasComponent)UiCanvasComponent
GetMousePosition() override (defined in UiCanvasComponent)UiCanvasComponent
GetNavigationRepeatDelay() override (defined in UiCanvasComponent)UiCanvasComponent
GetNavigationRepeatPeriod() override (defined in UiCanvasComponent)UiCanvasComponent
GetNavigationThreshold() override (defined in UiCanvasComponent)UiCanvasComponent
GetNumChildElements() override (defined in UiCanvasComponent)UiCanvasComponent
GetPathname() override (defined in UiCanvasComponent)UiCanvasComponent
GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType &provided) (defined in UiCanvasComponent)UiCanvasComponentinlinestatic
GetRenderTarget(const AZ::RHI::AttachmentId &attachmentId) override (defined in UiCanvasComponent)UiCanvasComponent
GetRenderTargets(LyShine::AttachmentImagesAndDependencies &attachmentImagesAndDependencies) (defined in UiCanvasComponent)UiCanvasComponent
GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType &required) (defined in UiCanvasComponent)UiCanvasComponentinlinestatic
GetRootElement() const (defined in UiCanvasComponent)UiCanvasComponent
GetSequenceLength(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
GetSequencePlayingSpeed(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
GetSequencePlayingTime(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
GetSnapDistance() override (defined in UiCanvasComponent)UiCanvasComponent
GetSnapRotationDegrees() override (defined in UiCanvasComponent)UiCanvasComponent
GetTargetCanvasSize() (defined in UiCanvasComponent)UiCanvasComponent
GetTooltipDisplayElement() override (defined in UiCanvasComponent)UiCanvasComponent
GetUniqueCanvasId() override (defined in UiCanvasComponent)UiCanvasComponent
GetUniqueChildName(AZ::EntityId parentEntityId, AZStd::string baseName, const LyShine::EntityArray *includeChildren) override (defined in UiCanvasComponent)UiCanvasComponent
GetVerticalGuidePositions() override (defined in UiCanvasComponent)UiCanvasComponent
GetViewportToCanvasMatrix(AZ::Matrix4x4 &matrix) override (defined in UiCanvasComponent)UiCanvasComponent
HandleInputEvent(const AzFramework::InputChannel::Snapshot &inputSnapshot, const AZ::Vector2 *viewportPos=nullptr, AzFramework::ModifierKeyMask activeModifierKeys=AzFramework::ModifierKeyMask::None) override (defined in UiCanvasComponent)UiCanvasComponent
HandleInputPositionalEvent(const AzFramework::InputChannel::Snapshot &inputSnapshot, AZ::Vector2 viewportPos) override (defined in UiCanvasComponent)UiCanvasComponent
HandleTextEvent(const AZStd::string &textUTF8) override (defined in UiCanvasComponent)UiCanvasComponent
Init() override (defined in UiCanvasComponent)UiCanvasComponentprotected
Initialize() (defined in UiCanvasComponent)UiCanvasComponentstatic
IsRenderGraphDirty() (defined in UiCanvasComponent)UiCanvasComponentinline
IsSequencePlaying(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
MarkRenderGraphDirty() override (defined in UiCanvasComponent)UiCanvasComponent
OnEntityDeactivated(const AZ::EntityId &entityId) override (defined in UiCanvasComponent)UiCanvasComponent
OnUiAnimationEvent(EUiAnimationEvent uiAnimationEvent, IUiAnimSequence *pAnimSequence) overrideUiCanvasComponentvirtual
OnUiTrackEvent(AZStd::string eventName, AZStd::string valueName, IUiAnimSequence *pAnimSequence) override (defined in UiCanvasComponent)UiCanvasComponentvirtual
PauseSequence(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
PickElement(AZ::Vector2 point) override (defined in UiCanvasComponent)UiCanvasComponent
PickElements(const AZ::Vector2 &bound0, const AZ::Vector2 &bound1) override (defined in UiCanvasComponent)UiCanvasComponent
PlaySequenceRange(const AZStd::string &sequenceName, float startTime, float endTime) override (defined in UiCanvasComponent)UiCanvasComponent
RecomputeChangedLayouts() override (defined in UiCanvasComponent)UiCanvasComponent
RecoverOrphanedElements() override (defined in UiCanvasComponent)UiCanvasComponent
Reflect(AZ::ReflectContext *context) (defined in UiCanvasComponent)UiCanvasComponentstatic
ReinitializeElements() override (defined in UiCanvasComponent)UiCanvasComponent
ReleaseRenderTarget(const AZ::RHI::AttachmentId &attachmentId) override (defined in UiCanvasComponent)UiCanvasComponent
RemoveAllGuides() override (defined in UiCanvasComponent)UiCanvasComponent
RemoveHorizontalGuide(int index) override (defined in UiCanvasComponent)UiCanvasComponent
RemoveOrphanedElements() override (defined in UiCanvasComponent)UiCanvasComponent
RemoveVerticalGuide(int index) override (defined in UiCanvasComponent)UiCanvasComponent
RenderCanvas(bool isInGame, AZ::Vector2 viewportSize, UiRenderer *uiRenderer=nullptr) (defined in UiCanvasComponent)UiCanvasComponent
RenderCanvasInEditorViewport(bool isInGame, AZ::Vector2 viewportSize) override (defined in UiCanvasComponent)UiCanvasComponent
ResetSequence(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
ResumeSequence(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
s_defaultCanvasSize (defined in UiCanvasComponent)UiCanvasComponentstatic
s_defaultGuideColor (defined in UiCanvasComponent)UiCanvasComponentstatic
SaveToXml(const AZStd::string &assetIdPathname, const AZStd::string &sourceAssetPathname) override (defined in UiCanvasComponent)UiCanvasComponent
SaveToXmlString() override (defined in UiCanvasComponent)UiCanvasComponent
ScheduleElementDestroy(AZ::EntityId entityId)UiCanvasComponent
ScheduleElementForTransformRecompute(UiElementComponent *elementComponent) (defined in UiCanvasComponent)UiCanvasComponent
SetAttachmentImageAsset(const AZ::Data::Asset< AZ::RPI::AttachmentImageAsset > &attachmentImageAsset) override (defined in UiCanvasComponent)UiCanvasComponent
SetCanvasSize(const AZ::Vector2 &canvasSize) override (defined in UiCanvasComponent)UiCanvasComponent
SetCanvasToViewportMatrix(const AZ::Matrix4x4 &matrix) override (defined in UiCanvasComponent)UiCanvasComponent
SetDrawOrder(int drawOrder) override (defined in UiCanvasComponent)UiCanvasComponent
SetEnabled(bool enabled) override (defined in UiCanvasComponent)UiCanvasComponent
SetGuideColor(const AZ::Color &color) override (defined in UiCanvasComponent)UiCanvasComponent
SetGuidesAreLocked(bool areLocked) override (defined in UiCanvasComponent)UiCanvasComponent
SetHorizontalGuidePosition(int index, float position) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsConsumingAllInputEvents(bool isConsuming) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsMultiTouchSupported(bool isSupported) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsNavigationSupported(bool isSupported) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsPixelAligned(bool isPixelAligned) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsPositionalInputSupported(bool isSupported) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsRenderToTexture(bool isRenderToTexture) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsSnapEnabled(bool enabled) override (defined in UiCanvasComponent)UiCanvasComponent
SetIsTextPixelAligned(bool isTextPixelAligned) override (defined in UiCanvasComponent)UiCanvasComponent
SetKeepLoadedOnLevelUnload(bool keepLoaded) override (defined in UiCanvasComponent)UiCanvasComponent
SetLocalUserIdInputFilter(AzFramework::LocalUserId localUserId) override (defined in UiCanvasComponent)UiCanvasComponent
SetNavigationRepeatDelay(AZ::u64 navigationRepeatDelay) override (defined in UiCanvasComponent)UiCanvasComponent
SetNavigationRepeatPeriod(AZ::u64 navigationRepeatPeriod) override (defined in UiCanvasComponent)UiCanvasComponent
SetNavigationThreshold(float navigationThreshold) override (defined in UiCanvasComponent)UiCanvasComponent
SetSequencePlayingSpeed(const AZStd::string &sequenceName, float speed) override (defined in UiCanvasComponent)UiCanvasComponent
SetSequenceStopBehavior(IUiAnimationSystem::ESequenceStopBehavior stopBehavior) override (defined in UiCanvasComponent)UiCanvasComponent
SetSnapDistance(float distance) override (defined in UiCanvasComponent)UiCanvasComponent
SetSnapRotationDegrees(float degrees) override (defined in UiCanvasComponent)UiCanvasComponent
SetTargetCanvasSize(bool isInGame, const AZ::Vector2 &targetCanvasSize) override (defined in UiCanvasComponent)UiCanvasComponent
SetTooltipDisplayElement(AZ::EntityId entityId) override (defined in UiCanvasComponent)UiCanvasComponent
SetVerticalGuidePosition(int index, float position) override (defined in UiCanvasComponent)UiCanvasComponent
Shutdown() (defined in UiCanvasComponent)UiCanvasComponentstatic
StartSequence(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
StopSequence(const AZStd::string &sequenceName) override (defined in UiCanvasComponent)UiCanvasComponent
UiCanvasComponent()UiCanvasComponent
UnscheduleElementForTransformRecompute(UiElementComponent *elementComponent) (defined in UiCanvasComponent)UiCanvasComponent
UpdateCanvas(float deltaTime, bool isInGame) (defined in UiCanvasComponent)UiCanvasComponent
UpdateCanvasInEditorViewport(float deltaTime, bool isInGame) override (defined in UiCanvasComponent)UiCanvasComponent
UseRenderTarget(const AZ::Name &renderTargetName, AZ::RHI::Size size) override (defined in UiCanvasComponent)UiCanvasComponent
UseRenderTargetAsset(const AZ::Data::Asset< AZ::RPI::AttachmentImageAsset > &attachmentImageAsset) override (defined in UiCanvasComponent)UiCanvasComponent
~IUiAnimationListener() (defined in IUiAnimationListener)IUiAnimationListenerinlinevirtual
~UiCanvasComponent() override (defined in UiCanvasComponent)UiCanvasComponent