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.
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
UiLayoutGridComponent Class Reference

This component overrides the transforms of immediate children to organize them into a grid. More...

#include <UiLayoutGridComponent.h>

Inherits AZ::Component, UiLayoutControllerBus::Handler, UiLayoutBus::Handler, UiLayoutGridBus::Handler, UiLayoutCellDefaultBus::Handler, and UiTransformChangeNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (UiLayoutGridComponent, LyShine::UiLayoutGridComponentUuid, AZ::Component)
 
virtual void ApplyLayoutWidth () override
 
virtual void ApplyLayoutHeight () override
 
virtual bool IsUsingLayoutCellsToCalculateLayout () override
 
virtual bool GetIgnoreDefaultLayoutCells () override
 
virtual void SetIgnoreDefaultLayoutCells (bool ignoreDefaultLayoutCells) override
 
virtual IDraw2d::HAlign GetHorizontalChildAlignment () override
 
virtual void SetHorizontalChildAlignment (IDraw2d::HAlign alignment) override
 
virtual IDraw2d::VAlign GetVerticalChildAlignment () override
 
virtual void SetVerticalChildAlignment (IDraw2d::VAlign alignment) override
 
virtual bool IsControllingChild (AZ::EntityId childId) override
 
virtual AZ::Vector2 GetSizeToFitChildElements (const AZ::Vector2 &childElementSize, int numChildElements) override
 
virtual UiLayoutInterface::Padding GetPadding () override
 
virtual void SetPadding (UiLayoutInterface::Padding padding) override
 
virtual AZ::Vector2 GetSpacing () override
 
virtual void SetSpacing (AZ::Vector2 spacing) override
 
virtual AZ::Vector2 GetCellSize () override
 
virtual void SetCellSize (AZ::Vector2 size) override
 
virtual UiLayoutInterface::HorizontalOrder GetHorizontalOrder () override
 
virtual void SetHorizontalOrder (UiLayoutInterface::HorizontalOrder order) override
 
virtual UiLayoutInterface::VerticalOrder GetVerticalOrder () override
 
virtual void SetVerticalOrder (UiLayoutInterface::VerticalOrder order) override
 
virtual StartingDirection GetStartingDirection () override
 
virtual void SetStartingDirection (StartingDirection direction) override
 
float GetMinWidth () override
 
float GetMinHeight () override
 
float GetTargetWidth (float maxWidth) override
 
float GetTargetHeight (float maxHeight) override
 
float GetExtraWidthRatio () override
 
float GetExtraHeightRatio () override
 
void OnCanvasSpaceRectChanged (AZ::EntityId entityId, const UiTransformInterface::Rect &oldRect, const UiTransformInterface::Rect &newRect) override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 
 AZ_DISABLE_COPY_MOVE (UiLayoutGridComponent)
 
AZ::Vector2 GetChildrenBoundingRectSize (const AZ::Vector2 childElementSize, int numChildElements)
 Get the bounding rect size of the children.
 
void InvalidateLayout ()
 Called on a property change that has caused this element's layout to be invalid.
 
void InvalidateParentLayout ()
 Called when a property that is used to calculate default layout cell values has changed.
 
void CheckLayoutFitterAndRefreshEditorTransformProperties () const
 Refresh the transform properties in the editor's properties pane.
 

Protected Attributes

UiLayoutInterface::Padding m_padding
 the padding (in pixels) inside the edges of this element
 
AZ::Vector2 m_spacing
 the vertical and horizontal spacing between child elements in pixels
 
AZ::Vector2 m_cellSize
 the width and height of child elements in pixels
 
UiLayoutInterface::HorizontalOrder m_horizontalOrder
 the order that the child elements are placed in
 
UiLayoutInterface::VerticalOrder m_verticalOrder
 
StartingDirection m_startingDirection
 
IDraw2d::HAlign m_childHAlignment
 Child alignment.
 
IDraw2d::VAlign m_childVAlignment
 
UiTransform2dInterface::Offsets m_origOffsets
 
bool m_origOffsetsInitialized
 

Detailed Description

This component overrides the transforms of immediate children to organize them into a grid.

Member Data Documentation

◆ m_origOffsets

UiTransform2dInterface::Offsets UiLayoutGridComponent::m_origOffsets
protected

The original offsets. Used to get a bounding size that is used to calculate the number of rows or columns that fit within the bounds

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