This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Art Samples
Tutorials

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 object 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 code, get the GUI via the World.getNodeByName() (or World.getNodeById() if the node index is known) and assign a widget to it by using functions of the ObjectGui class.

Editing GUI#

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

Node tab
Billboard

Indicates if the GUI is rendered as a billboard.

Billboard is disabled
Billboard is enabled
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.
Last update: 2021-04-29
Build: ()