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

Inherits UiNavigationBus::Handler.

Public Types

using GetNavigableEntitiesFn = AZStd::function< LyShine::EntityArray(AZ::EntityId)>
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (UiNavigationSettings, AZ::SystemAllocator)
 
 AZ_RTTI (UiNavigationSettings, "{E28DDC8B-F7C6-406F-966C-2F0825471641}")
 
NavigationMode GetNavigationMode () override
 
void SetNavigationMode (NavigationMode navigationMode) override
 
AZ::EntityId GetOnUpEntity () override
 
void SetOnUpEntity (AZ::EntityId entityId) override
 
AZ::EntityId GetOnDownEntity () override
 
void SetOnDownEntity (AZ::EntityId entityId) override
 
AZ::EntityId GetOnLeftEntity () override
 
void SetOnLeftEntity (AZ::EntityId entityId) override
 
AZ::EntityId GetOnRightEntity () override
 
void SetOnRightEntity (AZ::EntityId entityId) override
 
void Activate (AZ::EntityId entityId, GetNavigableEntitiesFn getNavigableFn)
 
void Deactivate ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Attributes

NavigationMode m_navigationMode
 Determines how the next element to get focus is chosen on a navigation event.
 
AZ::EntityId m_onUpEntity
 Entities to receive focus when a navigation event occurs.
 
AZ::EntityId m_onDownEntity
 
AZ::EntityId m_onLeftEntity
 
AZ::EntityId m_onRightEntity
 
AZ::EntityId m_entityId
 
GetNavigableEntitiesFn m_getNavigableEntitiesFunction
 

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