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

Inherits ComponentBus.

Classes

struct  Padding
 Padding (in pixels) inside the edges of an element. More...
 

Public Types

enum  HorizontalOrder { LeftToRight, RightToLeft }
 Horizontal order used by layout components.
 
enum  VerticalOrder { TopToBottom, BottomToTop }
 Vertical order used by layout components.
 

Public Member Functions

virtual bool IsUsingLayoutCellsToCalculateLayout ()=0
 Get whether this layout component uses layout cells to calculate its layout.
 
virtual bool GetIgnoreDefaultLayoutCells ()=0
 Get whether this layout component should bypass the default layout cell values calculated by its children.
 
virtual void SetIgnoreDefaultLayoutCells (bool ignoreDefaultLayoutCells)=0
 Set whether this layout component should bypass the default layout cell values calculated by its children.
 
virtual IDraw2d::HAlign GetHorizontalChildAlignment ()=0
 Get the horizontal child alignment.
 
virtual void SetHorizontalChildAlignment (IDraw2d::HAlign alignment)=0
 Set the horizontal child alignment.
 
virtual IDraw2d::VAlign GetVerticalChildAlignment ()=0
 Get the vertical child alignment.
 
virtual void SetVerticalChildAlignment (IDraw2d::VAlign alignment)=0
 Set the vertical child alignment.
 
virtual bool IsControllingChild (AZ::EntityId childId)=0
 Find out whether this layout component is currently overriding the transform of the specified element.
 
virtual AZ::Vector2 GetSizeToFitChildElements (const AZ::Vector2 &childElementSize, int numChildElements)=0
 Get the size the element needs to be to fit a specified number of child elements of a certain size.
 

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: