UiModule

module omegaToolkit wraps omegaTookit::ui::UiModule

Base class for graphical user interface support.

Methods

instance

static UiModule instance()

Returns an instance of the UiModule class

createAndInitialize

UiModule createAndInitialize()

Creates and initializes an instance of the UiModule class

activateWidget

☑️ VERSION 12.3 activateWidget(Widget widget)

Sets the specified widget as active

getWidgetFactory

WidgetFactory getWidgetFactory()

Returns an instance of WidgetFactory. WidgetFactory can be used to create widgets.

getUi

Container getUi()

Returns the root ui Container widget.

setCullingEnabled

isCullingEnabled

setCullingEnabled(bool enabled) bool isCullingEnabled()

Enabled or disables widget culling. When culling is enabled, 2D mode widgets are drawn only if they are within the viewport boundaries. Defaults to true.

setGamepadInteractionEnabled

isGamepadInteractionEnabled

☑️ VERSION 6.3 setGamepadInteractionEnabled(bool enabled) bool isGamepadInteractionEnabled()

Sets or checks if gamepad interaction in enabled in the UI.

setPointerInteractionEnabled

getPointerInteractionEnabled

☑️ VERSION 6.3 setPointerInteractionEnabled(bool enabled) bool getPointerInteractionEnabled()

Sets or checks if pointer interaction in enabled in the UI.