class UISection

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

Construction

Return type

Description
UISection (uint64_t id, const char* name, UISectionType type)
Constructor. Creates the UI section.

Methods

Return type

Description

template <typename T, typename… U> T*
RegisterUIElement (U&&… u)
Create and registers a “UIElement“.

template <typename T> void
RegisterUIElement (T&& element)
Registers an existed “UIElement“.

template <typename T, typename… U> T*
RegisterUIElementWithPriority (uint32_t priority, U&&… u)
Create and registers a “UIElement“ with priority.

template <typename T, typename… U> T*
CreateUIElement (U&&… u)
Create a “UIElement“.

template <typename T, typename… U> T*
CreateUIElementWithPriority (uint32_t priority, U&&… u)
Create a “UIElement“ with priority.

template <typename T> bool
UnregisterUIElement (T&& element)
Unregisters an existed “UIElement“. This will make the “UIElement“ stop rendering.

const char*
GetSectionName () const
Get the section description.

const std::map<uint64_t, UIElement *>&
GetElements () const
Get the “UIElement“ s in this section.

uint64_t
ID () const
Get the ID of this section. ID represents the priority, lower ID means higher priority.

bool
Shown () const
Check the section is shown.

void
Show (bool show)
Show or hide the element.

void
Release ()
Release UISection.

Detailed description

Construction

UISection

Copied!

UISection (uint64_t id, const char* name, UISectionType  type)

Constructor. Creates the UI section.

Methods

RegisterUIElement

Copied!

template <typename T, typename... U>    T* RegisterUIElement (U&&... u)

Create and registers a UIElement.

RegisterUIElement

Copied!

template <typename T>   void RegisterUIElement (T&& element)

Registers an existed UIElement.

RegisterUIElementWithPriority

Copied!

template <typename T, typename... U>    T* RegisterUIElementWithPriority (
    uint32_t priority,
    U&&... u
)

Create and registers a UIElement with priority.

CreateUIElement

Copied!

template <typename T, typename... U>    T* CreateUIElement (U&&... u)

Create a UIElement.

CreateUIElementWithPriority

Copied!

template <typename T, typename... U>    T* CreateUIElementWithPriority (
    uint32_t priority,
    U&&... u
)

Create a UIElement with priority.

UnregisterUIElement

Copied!

template <typename T>   bool UnregisterUIElement (T&& element)

Unregisters an existed UIElement. This will make the UIElement stop rendering.

GetSectionName

Copied!

const char* GetSectionName () const

Get the section description.

GetElements

Copied!

const std::map<uint64_t, UIElement *>& GetElements () const

Get the UIElement s in this section.

ID

Copied!

uint64_t ID () const

Get the ID of this section. ID represents the priority, lower ID means higher priority.

Shown

Copied!

bool Shown () const

Check the section is shown.

Show

Copied!

void Show (bool show)

Show or hide the element.

Release

Copied!

void Release ()

Release UISection.