Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

GUI Mesh

A GUI mesh is a non-flat GUI object based on an arbitrary mesh. If the mesh contains several surfaces, the same GUI will be rendered on each of them.

The GUI will be rendered according to the UV mapping of surfaces.

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

See also#

  • The ObjectGuiMesh class to edit GUI meshes via API
  • A set of samples located in the data/samples/objects/ directory:

Creating GUI Mesh#

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

To add the GUI mesh:

  1. Run the project with UnigineEditor.
  2. On the Menu bar, click Create -> GUI -> GUI Mesh.

  3. Specify a mesh on which the GUI will be rendered.
  4. Place the GUI mesh in the world and specify the required parameters for it.
  5. In the script, get the GUI object via the engine.editor.getNodeByName() (or engine.editor.getNode() if you have the node index) and assign a widget to it by using functions of the ObjectGuiMesh class.

Editing GUI Mesh#

In the Gui Mesh section of the Node tab, you can adjust the following parameters of the GUI mesh:

Node tab, Gui Mesh section
Show Mouse Indicates if the mouse cursor should be rendered in the GUI mesh.
Control Distance Distance at which the GUI mesh becomes controllable.
Screen Width Width of the GUI object in pixels.
Screen Height Height of the GUI object in pixels.
Last update: 2019-02-14