class UIManager

File location: framework/cauldron/framework/inc/core/uimanager.h

Construction

Return type

Description

Constructor. Creates the UI backend.

Methods

Return type

Description

void

Update (double deltaTime)
Updates the UI for the frame, going through the “UIBackend“.

bool

UIBackendMessageHandler (void* pMessage)
Message handler for the UIManager. Calls through to the “UIBackend“.

UISection *

RegisterUIElements ( const char* name, UISectionType type = UISectionType::Framework )
Registers a new “UISection“.

UISection *

CreateUIElements ( const char* name, UISectionType type = UISectionType::Framework )
Create a new “UISection“.

template <typename T> void

RegisterUIElements (T&& uiSectoin)
Registers a existed “UISection“.

template <typename T> bool

UnregisterUIElements (T&& uiSection)
Unregisters a “UISection“. This will make the “UISection“ stop rendering.

const std::map<uint64_t, UISection *>&

Gets all “UISection“ elements that make up the general layout tab.

Detailed description

Construction

UIManager

Copied!

UIManager ()

Constructor. Creates the UI backend.


Methods

Update

Copied!

void Update (double deltaTime)

Updates the UI for the frame, going through the UIBackend.


UIBackendMessageHandler

Copied!

bool UIBackendMessageHandler (void* pMessage)

Message handler for the UIManager. Calls through to the UIBackend.


RegisterUIElements

Copied!

UISection * RegisterUIElements (
    const char* name,
    UISectionType  type = UISectionType::Framework
)

Registers a new UISection.


CreateUIElements

Copied!

UISection * CreateUIElements (
    const char* name,
    UISectionType  type = UISectionType::Framework
)

Create a new UISection.


RegisterUIElements

Copied!

template <typename T>   void RegisterUIElements (T&& uiSectoin)

Registers a existed UISection.


UnregisterUIElements

Copied!

template <typename T>   bool UnregisterUIElements (T&& uiSection)

Unregisters a UISection. This will make the UISection stop rendering.


GetGeneralLayout

Copied!

const std::map<uint64_t, UISection *>& GetGeneralLayout () const

Gets all UISection elements that make up the general layout tab.