Open 3D Engine LyShine Gem API Reference
23.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level
1
2
3
]
AssetDropHelpers
Helpers for dragging and dropping assets from the asset browser to the UI Editor
ComponentHelpers
ComponentTypeData
LyShine
Common types used across the
LyShine
UI system
LyShineBuilder
LyShineBuilderComponent
IRenderGraph
LyShineRequests
FontAsset
CanvasAsset
UCol
UiPrimitiveVertex
UiPrimitive
UiCanvasBuilderWorker
LyShineFeatureProcessor
LyShineModule
LyShinePass
Manages child passes at runtime that render to render targets
LyShineChildPass
RttChildPass
LyShineSystemComponent
RenderNode
PrimitiveListRenderNode
MaskRenderNode
RenderTargetRenderNode
RenderGraph
DynamicQuad
RenderToTextureRequests
Ebus to handle render target requests
LyShineEditor
LyShineEditorSystemComponent
SerializeHelpers
SerializedEntry
TextMarkup
Tag
Tag
base class. All tags can have child tags
TextTag
Contains text data
BoldTag
Indicates that child elements should be bolded
ItalicTag
Indicates that child elements should be italicized
AnchorTag
Defines clickable regions of text (links)
FontTag
Allows modifying font display properties, such as face and color
ImageTag
Contains data to display an image
UiLayoutHelpers
LayoutCellSize
UiSerialize
AnimationData
UiSpline
TSpline
SplineKey
SplineKeyEx
BezierSpline
TrackSplineInterpolator
TrackSplineInterpolator< Vec2 >
ViewportHelpers
ElementEdges
Indicates which edges of an element are under consideration
SelectedAnchors
Indicates which anchors of an element are under consideration
GizmoParts
Indicates which parts of a transform gizmo are under consideration
AbstractSplineWidget
KeyTime
SSplineInfo
AbstractTimelineWidget
AlignToolbarSection
AnchorPresetsWidget
AssetTreeEntry
CAbstractUndoAnimNodeTransaction
CAbstractUndoSequenceTransaction
CAbstractUndoTrackEventMove
CAbstractUndoTrackEventTransaction
CAbstractUndoTrackTransaction
CanvasSizeToolbarSection
CanvasSizeToolbar provides controls to configure the canvas size
CanvasSizePresets
Simple encapsulation of canvas size width and height presets, along with descriptions
CDraw2d
Implementation of
IDraw2d
interface for 2D drawing in screen space
DeferredLine
DeferredPrimitive
DeferredQuad
DeferredRectOutline
DeferredText
Draw2dShaderData
CellSelectRectItem
A custom rect item that allows us to get a mouse press event
CLyShine
CLyShine
is the full implementation of the
ILyShine
interface
CommandCanvasPropertiesChange
CommandCanvasSize
CommandCanvasSizeToolbarIndex
CommandHierarchyItemCreate
CommandHierarchyItemCreateFromData
CommandHierarchyItemDelete
CommandHierarchyItemRename
CommandHierarchyItemReparent
CommandHierarchyItemToggleIsExpanded
CommandHierarchyItemToggleIsSelectable
CommandHierarchyItemToggleIsVisible
CommandPropertiesChange
ComponentButton
CoordinateSystemToolbarSection
CSprite
CUiAnimationContext
CUiAnimAzEntityNode
CUiAnimEventNode
CUiAnimNode
SParamInfo
CUiAnimNodeGroup
CUiAnimParamType
CUiAnimSequence
CUiAnimStringTable
CUiAnimViewAnimNode
CUiAnimViewAnimNodeBundle
CUiAnimViewAnimNodeFactory
CUiAnimViewCurveEditor
CUiAnimViewDialog
CUiAnimViewDopeSheetBase
CUiAnimViewEventNode
CUiAnimViewFindDlg
ObjName
CUiAnimViewKeyBundle
CUiAnimViewKeyConstHandle
CUiAnimViewKeyHandle
CUiAnimViewKeyPropertiesDlg
CUiAnimViewKeyUIControls
CUiAnimViewNode
CUiAnimViewNodesCtrl
CRecord
CUiAnimViewSequence
CUiAnimViewSequenceManager
CUiAnimViewSequenceNoNotificationContext
CUiAnimViewSequenceNotificationContext
CUiAnimViewSplineCtrl
CUiAnimViewTrack
CUiAnimViewTrackBundle
CUiAnimViewTrackEventKeyUIControls
CUiAnimViewTrackFactory
CUiAnimViewTrackMemento
CUiAnimViewTrackPropsDlg
CUiAVCustomizeTrackColorsDlg
CUiAVEventsDialog
CUiAVNewSequenceDialog
CUiAVSequenceProps
CUiTrackEventTrack
CUndoAnimKeySelection
CUndoAnimNodeAdd
CUndoAnimNodeRemove
CUndoAnimNodeRename
CUndoAnimNodeReparent
CUndoSequenceAdd
CUndoSequenceChange
CUndoSequenceRemove
CUndoSequenceSettings
CUndoTrackAdd
CUndoTrackEventAdd
CUndoTrackEventMoveDown
CUndoTrackEventMoveUp
CUndoTrackEventRemove
CUndoTrackEventRename
CUndoTrackObject
CUndoTrackRemove
Draw2dHelper
EditorWindow
UiCanvasTabMetadata
EnterPreviewToolbar
FindEntityItemModel
FindEntitySortFilterProxyModel
FindEntityWidget
HierarchyClipboard
HierarchyHeader
HierarchyItem
HierarchyMenu
HierarchyWidget
IDraw2d
Class for 2D drawing in screen space
ImageOptions
Struct used to pass additional image options
RenderState
TextOptions
Struct used to pass additional text options - mostly ones that do not change from call to call
VertexPosColUV
Used to pass in arrays of vertices (e.g. to DrawQuad)
ILyShine
The
ILyShine
interface provides access to the other interfaces provided by the UI module
ISplineCtrlUndo
ISplineSet
ISprite
Borders
SpriteSheetCell
Defines the UV-extents of a particular "cell" in a sprite-sheet. 9-slice information for the cell is also stored
IUiAnimationCallback
Callback-class
IUiAnimationContextListener
IUiAnimationListener
IUiAnimationSystem
IUiAnimNode
IUiAnimNodeOwner
IUiAnimNodeUiAnimator
IUiAnimSequence
IUiAnimSequenceOwner
IUiAnimStringTable
IUiAnimTrack
IUiAnimViewKeyBundle
IUiAnimViewSequenceListener
IUiAnimViewSequenceManagerListener
IUiTrackEventListener
Track event listener
LegacyVectorPropertyHandlerBase
LyShineDebug
Class for drawing test displays for testing the
LyShine
functionality
DebugInfoDrawCallReport
DebugInfoRenderGraph
Shared structures used for debug console commands
DebugInfoTextureUsage
LyShinePassDataRequests
LyShinePassRequests
MainToolbar
ModeToolbar
NewElementToolbarSection
PivotPresetsWidget
PlayingUIAnimSequence
PresetButton
PreviewActionLog
PreviewAnimationList
PreviewCanvasSizeToolbarSection
PreviewCanvasSizeToolbarSection
provides controls to configure the preview canvas size
PreviewToolbar
PropertiesContainer
PropertiesWidget
PropertiesWrapper
PropertyAnchorCtrl
PropertyAssetDirectorySelectionCtrl
PropertyDirectoryCtrl
PropertyEntityIdComboBoxCtrl
PropertyHandlerAnchor
PropertyHandlerChar
PropertyHandlerDirectory
PropertyHandlerEntityIdComboBox
PropertyHandlerLayoutPadding
PropertyHandlerOffset
PropertyHandlerPivot
PropertyHandlers
PropertyHandlerSprite
PropertyHandlerUiParticleColorKeyframe
PropertyHandlerUiParticleFloatKeyframe
PropertyHandlerVec2
PropertyHandlerVec3
PropertyHandlerVec4
PropertyPivotCtrl
PropertySpriteCtrl
PropertyUiParticleColorKeyframeCtrl
PropertyUiParticleFloatKeyframeCtrl
ReferenceCanvasSizeToolbarSection
RulerWidget
The
RulerWidget
is drawn above or to the left of the
ViewportWidget
SlicerEdit
SlicerManipulator
On-screen control used to modify border info for 9-slicing sprites
SlicerView
SplineWidget
SpriteBorderEditor
Visual sprite editor used to configure slicing and sprite-sheet properties for a given sprite
SUiAnimContext
Structure passed to Animate function
TimelineWidget
TUiAnimSplineTrack
TUiAnimTrack
UiAnimateEntityInterface
UiAnimationInterface
UiAnimationNotifications
UiAnimationSystem
UiAnimNodeInterface
UiAnimParamData
UiAnimUndo
Helper class for using the
UiAnimUndoManager
UiAnimUndoManager
UiAnimUndoObject
UiAnimViewCurveEditorDialog
UiBoolTrack
UiButtonComponent
UiButtonInterface
UiButtonNotifications
UiCanvasActionNotification
Interface class that listeners need to implement to be notified of canvas actions
UiCanvasAssetRefComponent
UiCanvasAssetRefInterface
UiCanvasAssetRefNotifications
UiCanvasComponent
DebugInfoNumElements
UiCanvasComponentImplementationInterface
UiCanvasEnabledStateNotification
UiCanvasFileObject
UiCanvasInputNotifications
UiCanvasInterface
UiCanvasLuaInterface
Mirrors the UiCanvasBus for use in Lua
UiCanvasLuaProxy
This component serves as the bridge between UiCanvasBus and UiCanvasLuaBus
UiCanvasManager
UiCanvasManagerInterface
UiCanvasManagerNotification
Interface class that listeners need to implement to be notified of canvas manager changes
UiCanvasNotificationLuaInterface
Defines the Lua-specific variant of UiCanvasNotificationBus
UiCanvasNotificationLuaProxy
Listens for UiCanvasNotificationBus actions and forwards the calls to the Lua-specific version
UiCanvasOnMeshComponent
UiCanvasOnMeshInterface
UiCanvasOrderNotification
UiCanvasPixelAlignmentNotification
UiCanvasProxyRefComponent
UiCanvasProxyRefInterface
UiCanvasRefInterface
UiCanvasRefNotifications
UiCanvasSizeNotification
Interface class that listeners need to implement to be notified of canvas size or scale changes
UiCanvasUpdateNotification
UiCheckboxComponent
UiCheckboxInterface
UiCheckboxNotifications
UiClickableTextInterface
ClickableTextRect
Defines an area of interaction for clickable text, along with metadata
UiClickableTextNotifications
UiClipboard
UiCompoundSplineTrack
UiCursorInterface
UiDraggableComponent
UiDraggableInterface
UiDraggableNotifications
UiDropdownComponent
UiDropdownInterface
UiDropdownNotifications
UiDropdownOptionComponent
UiDropdownOptionInterface
UiDropdownOptionNotifications
UiDropTargetComponent
UiDropTargetInterface
UiDropTargetNotifications
UiDynamicLayoutComponent
This component supports dynamic creation of child elements
UiDynamicLayoutInterface
UiDynamicScrollBoxComponent
CachedElementInfo
DisplayedElement
ElementIndexInfo
Section
UiDynamicScrollBoxDataInterface
Interface class that provides data needed to display a list of elements
UiDynamicScrollBoxElementNotifications
UiDynamicScrollBoxInterface
UiEditorAnimationInterface
UiEditorAnimationStateInterface
UiEditorAnimationEditState
UiEditorAnimListenerInterface
Listener class that any UI Editor Animation class can implement to get notifications
UiEditorCanvasInterface
UiEditorChangeNotificationInterface
UiEditorDLLInterface
Interface class that the UI Editor needs to implement
UiEditorEntityContext
InstantiatingEditorSliceParams
UiEditorEntityContextNotification
Bus for receiving events/notifications from the UI editor entity context component
UiEditorEntityContextRequests
UiEditorInernalRequests
Interface class that the UI Editor needs to implement
UiEditorInterface
UiEditorRefreshDirectoryNotificationInterface
Notify components who store directories as properties when directory contents change
UiElementChangeNotification
UiElementComponent
UiElementInterface
UiElementLuaInterface
Mirrors the UiElementBus for use in Lua
UiElementLuaProxy
This component serves as the bridge between UiElementBus and UiElementLuaBus
UiElementNotifications
UiEntityContext
UiEntityContextNotification
Bus for receiving events/notifications from the UI entity context
UiEntityContextRequests
UiFaderComponent
UiFaderInterface
UiFaderNotifications
Interface class that listeners need to implement
UiFlipbookAnimationComponent
UiFlipbookAnimationInterface
UiFlipbookAnimationNotifications
Allows listeners to be aware of events, like loop completion, occurring
UiGameEntityContext
InstantiatingDynamicSlice
UiGameEntityContextNotifications
Bus for receiving notifications from the UI game entity context component
UiGameEntityContextRequests
Bus for making requests to the UI game entity context
UiGameEntityContextSliceInstantiationResults
UiImageComponent
UiImageInterface
UiImageSequenceComponent
Image component capable of indexing and displaying from multiple image files in a directory
UiImageSequenceInterface
UiIndexableImageInterface
Defines an interface for working with indexable image types, such as sprite-sheets or image sequences
UiInitializationInterface
UiInteractableActionsInterface
UiInteractableActiveNotifications
UiInteractableComponent
UiInteractableInterface
UiInteractableNotifications
UiInteractableStateAction
UiInteractableStateAlpha
UiInteractableStateColor
UiInteractableStateFont
UiInteractableStatesInterface
UiInteractableStateSprite
UiInteractionMaskInterface
UiLayoutCellComponent
This component allows the default layout cell properties to be overridden
UiLayoutCellDefaultInterface
UiLayoutCellInterface
UiLayoutColumnComponent
This component overrides the transforms of immediate children to organize them into a horizontal row
UiLayoutColumnInterface
UiLayoutControllerInterface
BusHandlerOrderCompare
Priority will be used for ordering, lower priority number means it gets called earlier
UiLayoutFitterComponent
UiLayoutFitterInterface
UiLayoutGridComponent
This component overrides the transforms of immediate children to organize them into a grid
UiLayoutGridInterface
UiLayoutInterface
Padding
Padding
(in pixels) inside the edges of an element
UiLayoutManager
UiLayoutManagerInterface
UiLayoutRowComponent
This component overrides the transforms of immediate children to organize them into a vertical column
UiLayoutRowInterface
UiMarkupButtonComponent
UiMarkupButtonInterface
UiMarkupButtonNotifications
UiMaskComponent
UiMaskInterface
UiNavigationInterface
UiNavigationSettings
UiParticle
UiParticleInitialParameters
UiParticleRenderParameters
UiParticleUpdateParameters
UiParticleEmitterComponent
UiParticleEmitterInterface
Bus for making requests to the
UiParticleEmitterComponent
ParticleColorKeyframe
ParticleFloatKeyframe
UiRadioButtonCommunicationInterface
UiRadioButtonComponent
UiRadioButtonGroupCommunicationInterface
UiRadioButtonGroupComponent
UiRadioButtonGroupInterface
UiRadioButtonGroupNotifications
UiRadioButtonInterface
UiRadioButtonNotifications
UiRenderControlInterface
UiRenderer
UI render interface
BaseState
UiShaderData
UiRenderInterface
UiScrollableInterface
UiScrollableNotifications
UiScrollableToScrollerNotifications
UiScrollBarComponent
UiScrollBarInterface
UiScrollBoxComponent
UiScrollBoxInterface
UiScrollBoxNotifications
Interface class that listeners need to implement to receive scroll box change notifications
UiScrollerInterface
UiScrollerNotifications
UiScrollerToScrollableNotifications
UISliceLibraryFilter
UISliceLibraryFilter
locates all of the UI slices so that they can be instantiated via "Element from Slice Library" menu function
UiSliceManager
UiSliderComponent
UiSliderInterface
UiSliderNotifications
UiSpawnerComponent
UiSpawnerInterface
Bus for making requests to the
UiSpawnerComponent
UiSpawnerNotifications
UiSpriteSettingsChangeNotification
Interface class that listeners need to implement to be notified of changes to the sprite settings
UiSpriteSourceNotificationInterface
Notify listeners when sprite image sources change
UiStateActionManager
UiSystemInterface
UiSystemToolsInterface
CanvasAssetHandle
UiTextComponent
DrawBatch
OverflowInfo
Overflow information based on available width. Used for wrapping
DrawBatchLine
A single line of text that can be composed of multiple
DrawBatch
objects
DrawBatchLines
InlineImage
An inline image to be displayed within the text
LineOffsets
Simple container for left/right AZ::Vector2 offsets
UiTextComponentOffsetsSelector
Helper class for calculating offsets for visualizing multi-line selection
UiTextInputComponent
UiTextInputInterface
UiTextInputNotifications
UiTextInterface
UiTooltipComponent
UiTooltipDataPopulatorInterface
UiTooltipDisplayComponent
UiTooltipDisplayInterface
UiTooltipDisplayNotifications
Interface class that listeners need to implement to be notified of tooltip display events
UiTooltipInterface
UiTransform2dComponent
UiTransform2dInterface
Anchors
Offsets
UiTransformChangeNotification
Interface class that listeners need to implement
UiTransformInterface
Rect
Struct that stores the bounds of an axis-aligned rectangle
RectPoints
Struct that stores the 4 points of a (transformed) rectangle and provides access either as an array or via access functions
UIVectorPropertyHandlerBase
UiVisualInterface
UndoStack
UndoStackExecutionScope
ViewportAddGuideInteraction
Class used while an "Add guide" interaction is in progress in move or anchor mode
ViewportAlign
ViewportAlign
contains static function that implement alignment operations on elements
ViewportAnchor
ViewportCanvasBackground
Responsible for drawing an image background behind any canvas
ViewportDragInteraction
Abstract base class for drag interactions in the UI Editor viewport window
ViewportElement
ViewportHighlight
ViewportIcon
ViewportInteraction
TranslationAndScale
ViewportMoveGuideInteraction
Class used while a "Move guide" interaction is in progress in move or anchor mode
ViewportMoveInteraction
Class used while a move interaction is in progress in move or anchor mode
ViewportNudge
ViewportPivot
ViewportSnap
ViewportWidget
Generated on Thu Apr 20 2023 21:34:20 for Open 3D Engine LyShine Gem API Reference by
1.8.5