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

Inherits AZ::ComponentBus.

Public Member Functions

virtual void MarkToRecomputeLayout (AZ::EntityId entityId)=0
 
virtual void MarkToRecomputeLayoutsAffectedByLayoutCellChange (AZ::EntityId entityId, bool isDefaultLayoutCell)=0
 
virtual void UnmarkAllLayouts ()=0
 Unmark all elements from needing to recompute their layouts.
 
virtual void RecomputeMarkedLayouts ()=0
 Recompute layouts of marked elements and clear the marked layout list.
 
virtual void ComputeLayoutForElementAndDescendants (AZ::EntityId entityId)=0
 Compute the layout for the specified element and its descendants.
 

Static Public Attributes

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

Member Function Documentation

◆ MarkToRecomputeLayout()

virtual void UiLayoutManagerInterface::MarkToRecomputeLayout ( AZ::EntityId  entityId)
pure virtual

Mark an element to recompute its layout. This is called when something that affects the layout has been modified. (ex. layout element size changed, layout element property changed, layout element child count changed.)

◆ MarkToRecomputeLayoutsAffectedByLayoutCellChange()

virtual void UiLayoutManagerInterface::MarkToRecomputeLayoutsAffectedByLayoutCellChange ( AZ::EntityId  entityId,
bool  isDefaultLayoutCell 
)
pure virtual

Mark the specified element's parent to recompute its layout. The parent uses its child's layout cell values to calculate its layout, so this is called when something that affects the child's layout cell values has been modified. (ex. child's layout cell property changed.) Since a child's layout cell values may affect its parent's layout cell values, the top level parent is marked


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