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.
UiLayoutGridInterface Class Referenceabstract

Inherits AZ::ComponentBus.

Public Types

enum class  StartingDirection { HorizontalOrder , VerticalOrder }
 Used to determine which direction to start the layout with.
 

Public Member Functions

virtual UiLayoutInterface::Padding GetPadding ()=0
 Get the padding (in pixels) inside the edges of the element.
 
virtual void SetPadding (UiLayoutInterface::Padding padding)=0
 Set the padding (in pixels) inside the edges of the element.
 
virtual AZ::Vector2 GetSpacing ()=0
 Get the spacing (in pixels) between child elements.
 
virtual void SetSpacing (AZ::Vector2 spacing)=0
 Set the spacing (in pixels) between child elements.
 
virtual AZ::Vector2 GetCellSize ()=0
 Get the size (in pixels) of a child element in this layout.
 
virtual void SetCellSize (AZ::Vector2 size)=0
 Set the size (in pixels) of a child element in this layout.
 
virtual UiLayoutInterface::HorizontalOrder GetHorizontalOrder ()=0
 Get the horizontal order for this layout.
 
virtual void SetHorizontalOrder (UiLayoutInterface::HorizontalOrder order)=0
 Set the horizontal order for this layout.
 
virtual UiLayoutInterface::VerticalOrder GetVerticalOrder ()=0
 Get the vertical order for this layout.
 
virtual void SetVerticalOrder (UiLayoutInterface::VerticalOrder order)=0
 Set the vertical order for this layout.
 
virtual StartingDirection GetStartingDirection ()=0
 Get the starting direction for this layout.
 
virtual void SetStartingDirection (StartingDirection direction)=0
 Set the starting direction for this layout.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 Only one component on a entity can implement the events.
 

The documentation for this class was generated from the following file: