Open 3D Engine LyShine Gem API Reference  24.09
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
UiLayoutColumnComponent Class Reference

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

#include <UiLayoutColumnComponent.h>

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

Public Member Functions

 AZ_COMPONENT (UiLayoutColumnComponent, LyShine::UiLayoutColumnComponentUuid, 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 float GetSpacing () override
 
virtual void SetSpacing (float spacing) override
 
virtual UiLayoutInterface::VerticalOrder GetOrder () override
 
virtual void SetOrder (UiLayoutInterface::VerticalOrder order) 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 (UiLayoutColumnComponent)
 
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.
 
void ApplyLayoutWidth (float availableWidth)
 
void ApplyLayoutHeight (float availableHeight)
 

Protected Attributes

UiLayoutInterface::Padding m_padding
 the padding (in pixels) inside the edges of this element
 
float m_spacing
 the spacing (in pixels) between child elements
 
UiLayoutInterface::VerticalOrder m_order
 the order that the child elements are placed in
 
IDraw2d::HAlign m_childHAlignment
 Child alignment.
 
IDraw2d::VAlign m_childVAlignment
 
bool m_ignoreDefaultLayoutCells
 Whether the layout is to ignore the children's default layout cell values.
 

Detailed Description

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

Member Function Documentation

◆ ApplyLayoutWidth()

void UiLayoutColumnComponent::ApplyLayoutWidth ( float  availableWidth)
protected

Helper functions to set the child elements' transform properties. Element widths are calculated first since layout cell height properties can depend on element widths

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