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

#include <UiLayoutControllerBus.h>

Inherits AZ::ComponentBus.

Classes

struct  BusHandlerOrderCompare
 Priority will be used for ordering, lower priority number means it gets called earlier. More...
 

Public Member Functions

virtual void ApplyLayoutWidth ()=0
 Set elements' width transform properties.
 
virtual void ApplyLayoutHeight ()=0
 Set elements' height transform properties.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::MultipleAndOrdered
 Events are ordered, each handler may set its priority.
 

Protected Member Functions

virtual unsigned int GetPriority () const
 

Static Protected Attributes

static const unsigned int k_defaultPriority = 100
 

Detailed Description

This interface can to be implemented by any component that wants to modify transform properties of elements are runtime using the Layout system. The methods in this interface will be called by the LayoutManager whenever the element is told to recompute its layout. Because an element might have multiple components that implement this interface, the handlers will be sorted by priority (lower priority number gets called earlier).


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