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#

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

To add the GUI:

1. Run the project with UnigineEditor.
2. On the Menu bar, click Create -> GUI -> 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.world.getNodeByName() (or engine.world.getNodeById() if the node index is known) and assign a widget to it by using functions of the ObjectGui class.

In the Node tab of the Parameters window, you can adjust the following parameters of the GUI object:

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.
Show Mouse	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.