UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Gui

GUI is a flat GUI object that is positioned in the world and to which different widgets are assigned to be displayed.

Basically, a flat GUI object is a flat display, on which GUI is rendered. You can interact with such GUI the same way as with GUI created via the Gui class.

Post-process filters can be applied to a flat GUI object (for example, motion blur or any other).

See also

Creating GUI

You can add a GUI via UnigineEditor and then assign a widget to it via UnigineScript.

To add the GUI:

  1. Run UnigineEditor
  2. On the Menu bar, click Create -> Effects -> GUI.

  3. Place the created GUI in the world and specify the required parameters for it.
  4. In the script, get the GUI via the engine.editor.getNodeByName() (or engine.editor.getNode() if the node index is known) and assign a widget to it by using functions of the ObjectGui class.

Editing GUI

On the Gui tab of the Nodes panel, you can adjust the following parameters of the GUI:

A Gui tab
Billboard Indicates if the GUI is rendered as a billboard.
Billboard is unchecked
Billboard is checked
Background Indicates if the GUI background (black screen) should be rendered.
Depth test Indicates if the depth test should be used for the GUI object.
Mouse show Indicates if the mouse cursor should be rendered in the GUI object.
Control distance Distance at which the GUI object becomes controllable.
Polygon offset Offset of the GUI above the background. This parameter is set to avoid z-fighting.
Physical width Width of the GUI in units.
Physical height Height of the GUI in units.
Screen width Width of the GUI in pixels.
Screen height Height of the GUI in pixels.
Last update: 2017-07-03