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