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.
UiLayoutCellComponent Class Reference

This component allows the default layout cell properties to be overridden. More...

#include <UiLayoutCellComponent.h>

Inherits AZ::Component, and UiLayoutCellBus::Handler.

Public Member Functions

 AZ_COMPONENT (UiLayoutCellComponent, LyShine::UiLayoutCellComponentUuid, AZ::Component)
 
float GetMinWidth () override
 
void SetMinWidth (float width) override
 
float GetMinHeight () override
 
void SetMinHeight (float height) override
 
float GetTargetWidth () override
 
void SetTargetWidth (float width) override
 
float GetTargetHeight () override
 
void SetTargetHeight (float height) override
 
float GetMaxWidth () override
 
void SetMaxWidth (float width) override
 
float GetMaxHeight () override
 
void SetMaxHeight (float height) override
 
float GetExtraWidthRatio () override
 
void SetExtraWidthRatio (float width) override
 
float GetExtraHeightRatio () override
 
void SetExtraHeightRatio (float height) 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 (UiLayoutCellComponent)
 
void InvalidateLayout ()
 Invalidate the layouts affected by layout cell properties. Called when a layout cell property has changed.
 

Protected Attributes

bool m_minWidthOverridden
 Whether the minimum width has been overridden.
 
float m_minWidth
 The minimum width.
 
bool m_minHeightOverridden
 Whether the minimum height has been overridden.
 
float m_minHeight
 The minimum height.
 
bool m_targetWidthOverridden
 Whether the target width has been overridden.
 
float m_targetWidth
 The target width.
 
bool m_targetHeightOverridden
 Whether the target height has been overridden.
 
float m_targetHeight
 The target height.
 
bool m_maxWidthOverridden
 Whether the max width has been overridden.
 
float m_maxWidth
 The max width.
 
bool m_maxHeightOverridden
 Whether the max height has been overridden.
 
float m_maxHeight
 The max height.
 
bool m_extraWidthRatioOverridden
 Whether the extra width ratio has been overridden.
 
float m_extraWidthRatio
 The extra width ratio.
 
bool m_extraHeightRatioOverridden
 Whether the extra height ratio has been overridden.
 
float m_extraHeightRatio
 The extra height ratio.
 

Detailed Description

This component allows the default layout cell properties to be overridden.


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