Skip to content
Alessandro Febretti edited this page Feb 18, 2015 · 25 revisions

module omegaToolkit wraps omegaTookit::ui::UiModule

Base class for graphical user interface support.

Methods

Method(s) Description
UiModule instance() static Returns an instance of the UiModule class
UiModule createAndInitialize() Creates and initializes an instance of the UiModule class
WidgetFactory getWidgetFactory() Returns an instance of WidgetFactory. WidgetFactory can be used to create widgets
Container getUi() Returns the root ui Container widget.
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.

Methods

  • UiModule instance() static: Returns an instance of the UiModule class

  • UiModule createAndInitialize(): Creates and initializes an instance of the UiModule class.

  • WidgetFactory getWidgetFactory(): Returns an instance of WidgetFactory. WidgetFactory can be used to create widgets.

  • Container getUi(): Returns the root ui Container widget.

  • 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(bool enabled), bool isGamepadInteractionEnabled(): Sets or checks if gamepad interaction in enabled in the UI

  • setPointerInteractionEnabled(bool enabled), bool getPointerInteractionEnabled(): Sets or checks if pointer interaction in enabled in the UI

Clone this wiki locally