Programming
Fundamentals
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
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.

Notice
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 Guiclass.

See also

  • An ObjectGuiMeshclass to edit GUI meshes via UnigineScript
  • 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 UnigineEditor
  2. On the Menu bar, click Create -> Effects -> 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()(orengine.editor.getNode()if you have the node index) and assign a widget to it by using functions of theObjectGuiMeshclass.

Editing GUI Mesh

On the Gui tab of the Nodespanel, you can adjust the following parameters of the GUI mesh:

A Gui tab
Mouse show 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: 2017-07-03