This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Downloading and Installing UNIGINE SDK
Project Workflow
Programming Quick Start
1. Basic Concepts
2. Creating and Deleting Nodes at Runtime
3. Creating and Setting Up a Camera
4. Creating and Setting up Light Sources
5. Creating, Applying and Deleting Materials at Runtime
6. Managing Existing Scene Objects
7. Performing Basic Transformations (Move, Rotate, Scale)
8. Making It in Time
9. Managing Intersections
10. Getting and Managing User Inputs
11. Implementing Game Logic and Using Properties
12. Creating User Interface
Getting Started with VR
Classes and Components Overview
System Requirements
Migrating to UNIGINE
Migrating to UNIGINE From Unreal Engine
Content Creation
Programming
Physics
Migrating to UNIGINE From Unity
Content Creation
Programming
Physics
Video Tutorials
Interface
SDK Browser Interface
Editor Interface
Scene Viewport
Essentials
Importing 3D Models
Instancing Nodes
Materials
Lighting
Tracker Tool
Global Illumination
Georeferenced Terrain Generation
Arbitrary Terrain Generation
Content Optimization
Decals
Performance Inspection with Microprofile
Textures
Procedural Texturing
Bit Masking
Audio Sources and Sound Effects
Cached Shadows
Water
Physics
C# Component System
Landscape Terrain
Advanced
Microprofile for Artists
How To
Principles of Operation
Virtual World Structure
World Management
Properties
Hierarchy and Inheritance
Component System
C++ Component System
C# Component System
Rendering
Rendering Sequence
Parallel-Split Shadow Mapping
Interleaved Lights Rendering
Alpha Blending
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
Import System
File System
Asynchronous Data Streaming
SDK Browser
Projects
Licenses
Managing Company Accounts and Licenses
Add-Ons
Airport Assets
Eastern European Countryside
Industrial Assets
Road Tool Constructor
Vegetation
VFX
Weather
Arbitrary Terrain Generation
Georeferenced Terrain Generation
Demos
CIGI
C# Third Person Platformer
Earthworks
Fox Hole
LiDAR
Oil Platform
Oil Refinery
Orbits
Procedural City Generation
Soldier
Superposition
Syncker
Viewer
VR Sample
Winch
UnigineEditor
Interface Overview
Layout Customization
Context Menus
Assets Workflow
Asset Types
Assets and Runtime Files
Organizing Assets
Copying Assets From Other Projects
Project Files
Version Control
Settings and Preferences
Editor Settings and Hotkeys
World Settings
Global Physics Settings
Global Sound Settings
Controls Settings
Working With Projects
Building a Project
Managing Worlds
Scene Navigation
Creating Nodes
Selecting and Positioning Nodes
Organizing Nodes
Exporting Nodes
Instancing Nodes
Adjusting Node Parameters
Transformation and Common Parameters
Visual Representation
Properties
Physics and Sound
Setting Up Materials
Organizing Materials
Forced Shader Compilation
Setting Up Properties
Organizing Properties
Lighting
Environment
Reflections
Setting Up Cameras
Using Visual Helpers
System Menu
Landscape Tool
Creating a Terrain
Creating a Geo-Referenced Terrain
Generating Detail Masks
Generating Vegetation
Generating Spline Objects
Generating Vector Objects
Generating Point Objects
Generating Buildings
Procedural Refinement
Distributed Computing
Sandworm (Experimental)
Starting with Sandworm
Creating a Landscape
Generating Vegetation
Generating Point Objects
Generating Buildings
Using Editor Tools for Specific Tasks
Capturing Screenshots and Frame Sequences
Adding Variations for a More Realistic Environment
Generating Impostors with Impostors Creator
Editing Global Terrain
Editing Landscape Terrain
Mask Editor for Grass and Clutters
Extending Editor Functionality
Creating Your First Editor Plugin
Editing Curves
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
USC Interpreter
Archiver
Resource
Upgrade Script
Runtimes Generator
Built-in Node Types
Nodes
Node
Node Reference
Dummy Node
Layer
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Text Object
Sky
Cloud Layer
Effects
Particle System
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Light Sources Parameters
Omni Light
Projected Light
World Light
Environment Probe
Voxel Probe
Geodetics
Geodetic Pivot
World Objects
World Trigger
World Clutter
Switcher
World Expression
World Spline Graph
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentals
Programming Overview
Engine Architecture
Working with Smart Pointers
Accessing Nodes and Files via Properties
Thread Safety
Matrix Transformations
Camera Matrices
Event Handling Callbacks
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Usage Examples
Working with Landscape Terrain via Code
High-Level Car Physics System (C++)
Custom Import Plugin
Importing Models Directly to Memory
C++ Component System
Customizing Mouse Cursor and Behavior
Basic Object Movements
Creating and Attaching a Cloth
Creating a Car with Wheel Joints
Creating Mirrors Using Viewports (Rendering to Texture) or Materials
A Simple Mechanism Using Joints
Creating Routes
Creating Pylons and Wires Using Ropes
Dynamic Meshes
Enabling Selective Surface-Based Collision
Playing Sounds on Collisions
Intersections
Mesh Class
Working with Console
Sharing Data
Splitting Logic Between Several WorldLogic Classes
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
Handling Ownership When Using Scripts
Cache Files
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
Debugging C# Components
Garbage Collector
C# API Reference
UUSL (Unified UNIGINE Shader Language)
UUSL Keywords
UUSL Common Intrinsic Functions
UUSL GBuffer Structure
UUSL Data Structure
UUSL Parameters
UUSL Textures
UUSL Semantics
UUSL Tessellation
UUSL Compute Shaders
Creating a Custom Shader for Deferred Rendering Pass
Creating a Custom Shader for Forward Rendering Pass
Creating a Custom Shader for Post-Processing
File Formats
Unigine Language Object Notation
Mesh File Formats
Property File Format
Spline File Format
Startup Command-Line Options
Console
Configuration Files
Rebuilding the Engine Tools
Rebuild in Windows via Visual Studio
Semi-automatic Compilation with Build Script
Protecting Your Data with a Password
GUI
Loading and Splash Screens
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
API
Containers
Container Functions
ArrayVector Class
Map Class
Set Class
Common Functionality
Async Class
ScopedLock Class
ScopedReaderLock Class
ScopedReentrantLock Class
ScopedWriterLock Class
Atomic Class
BackoffSpinner Class
Mutex Class
ReentrantMutex Class
RWMutex Class
Blob Class
Checksum Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
Curve2d Class
Expression Class
ExternClass Class
FunctionBase Class
Hash Class
Hasher Class
Image Class
ImageConverter Class
Interpreter Class
Json Class
Log Class
OS Functions
Palette Class
Path Class
Plugin Class
Property Class
PropertyParameter Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
StringArray Class
StringPtr Class
StringStack Class
Thread Class
Timer Class
TypeInfo Class
UlonArg Class
UlonValue Class
UlonNode Class
Unigine Namespace Items
Utils Class
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Input Class
InputGamePad Class
Engine-Related Classes
App Class
BootConfig Class
CustomApp Class
Config Class
Console Class
Editor Class
Engine Class
EnginePtr Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
LoadingScreen Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
SystemDialog Class
SystemInfo Class
UserConfig Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
FileSystem Class
FileSystemAssets Class
FileSystemMount Class
AsyncQueue Class
File System Functions
Package Class
PackageUng Class
UGUID Class
GUI-Related Classes
Gui Class
UserInterface Class
Widget Class
WidgetButton Class
WidgetCanvas Class
WidgetCheckBox Class
WidgetComboBox Class
WidgetDialog Class
WidgetDialogColor Class
WidgetDialogFile Class
WidgetDialogImage Class
WidgetDialogMessage Class
WidgetEditLine Class
WidgetEditText Class
WidgetExternBase Class
WidgetExtern Class
WidgetGridBox Class
WidgetGroupBox Class
WidgetHBox Class
WidgetHPaned Class
WidgetIcon Class
WidgetLabel Class
WidgetListBox Class
WidgetManipulator Class
WidgetManipulatorRotator Class
WidgetManipulatorScaler Class
WidgetManipulatorTranslator Class
WidgetMenuBar Class
WidgetMenuBox Class
WidgetScroll Class
WidgetScrollBox Class
WidgetSlider Class
WidgetSpacer Class
WidgetSpinBox Class
WidgetSpinBoxDouble Class
WidgetSprite Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Math Functionality
Predefined Constants
Geometry Class
Math Common Functions
Math 2D Functions
Math Exponential Functions
Math Matrix Functions
Math Random Functions
Math Trigonometrical Functions
bvec4 Class
dmat4 Class
dvec2 Class
dvec3 Class
dvec4 Class
half Class
hvec2 Class
hvec3 Class
hvec4 Class
ivec2 Class
ivec3 Class
ivec4 Class
mat2 Class
mat3 Class
mat4 Class
quat Class
vec2 Class
vec3 Class
vec4 Class
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodeReference Class
NodeTrigger Class
Objects-Related Classes
Object Class
ObjectBillboards Class
ObjectCloudLayer Class
ObjectDummy Class
ObjectDynamic Class
ObjectExtern Class
ObjectExternBase Class
ObjectGrass Class
ObjectGui Class
ObjectGuiMesh Class
ObjectIntersection Class
ObjectIntersectionNormal Class
ObjectIntersectionTexCoord Class
ObjectMeshStatic Class
ObjectMeshCluster Class
ObjectMeshClutter Class
ObjectMeshDynamic Class
ObjectMeshSkinned Class
ObjectMeshSplineCluster Class
ObjectSky Class
ObjectTerrainGlobal Class
TerrainGlobalDetail Class
TerrainGlobalLod Class
TerrainGlobalLodHeight Class
TerrainGlobalLods Class
TileSet Class
TileSetFile Class
ObjectText Class
ObjectVolumeBox Class
ObjectVolumeOmni Class
ObjectVolumeProj Class
ObjectVolumeSphere Class
ObjectWaterMesh Class
ObjectWaterGlobal Class
Networking Functionality
Socket Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
PathRouteIntersection Class
Physics-Related Classes
Contact Class
ShapeContact Class
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
AppEasyBlend Class
OpenFlightImport Class
Kinect Class
AppOculus Class
AppProjection Class
engine.surround Functions
AppVarjo Class
AppVive Class
AppWall Class
ARTTracker Class
IG Plugin
CIGIConnector Plugin
CIGI::Connector Class
CigiAerosolResponse Class
CigiAnimationNotify Class
CigiArticulatedControl Class
CigiArticulatedShortControl Class
CigiAtmosphereControl Class
CigiCelestialControl Class
CigiComponentControl Class
CigiComponentShortControl Class
CigiEarthModelDef Class
CigiEntityClampedControl Class
CigiEntityControl Class
CigiEnvironmentControl Class
CigiEnvironmentRequest Class
CigiEventNotify Class
CigiHatHotExtResponse Class
CigiHatHotRequest Class
CigiHatHotResponse Class
CigiHostPacket Class
CigiHostUserDefined Class
CigiIGControl Class
CigiIGMessage Class
CigiIGPacket Class
CigiIGUserDefined Class
CigiLosExtResponse Class
CigiLosResponse Class
CigiLosSegmentRequest Class
CigiLosVectorRequest Class
CigiMaritimeControl Class
CigiMaritimeResponse Class
CigiPositionRequest Class
CigiPositionResponse Class
CigiRateControl Class
CigiSegmentDef Class
CigiSegmentNotify Class
CigiSensorControl Class
CigiSensorExtResponse Class
CigiSensorResponse Class
CigiStartOfFrame Class
CigiSymbolCircleDef Class
CigiSymbolClone Class
CigiSymbolControl Class
CigiSymbolLineDef Class
CigiSymbolShortControl Class
CigiSymbolSurfaceDef Class
CigiSymbolTextDef Class
CigiTerrestrialControl Class
CigiTerrestrialResponse Class
CigiTrackerControl Class
CigiTrajectoryDef Class
CigiViewControl Class
CigiViewDef Class
CigiVolumeDef Class
CigiVolumeNotify Class
CigiWaveControl Class
CigiWeatherControl Class
CigiWeatherResponse Class
ComponentBaseInterface
IG Manager Interface
ArticulatedPart Class
CollisionSegment Class
CollisionVolume Class
Component Class
Converter Class
IGConfig Class
Entity Class
ViewBase Class
ViewGroup Class
View Class
SkyMap Class
Meteo Class
Region Class
LightController Class
SymbolsController Class
SymbolsPlane Class
Symbol Class
SymbolPolyline Class
SymbolCircle Class
SymbolText Class
Water Class
IGIntersection Structure
Rendering-Related Classes
Camera Class
EngineExpression Class
Ffp Class
Material Class
Materials Class
Mesh Class
MeshDynamic Class
MeshStatic Class
Primitives Class
Render Class
RenderEnvironmentPreset Class
Renderer Class
RenderContext Class
RenderState Class
RenderTarget Class
Shader Class
CPUShader Class
StructuredBuffer Class
Texture Class
TextureCurve Class
Viewport Class
Content Creation
3D Models Requirements
Art Assets Conversion
Content Optimization
Lights Optimization
Dynamic Reflections Optimization
Water Optimization
Terrain Optimization
Physics Optimization
VR Best Practices
Materials
Hierarchy and Inheritance
Custom Materials
Scriptable Materials
Art Samples
Billboards
Camera Effects
Clouds
Cluster
Clutter
Cross Section
Decals
Environment
Global Illumination
Impostors
Landscape
Lens Flares
Lights
LOD System
Materials
Occluders
Particles
Post Sensors
Reflections
Simlights
SSBevel
SSDirt
Vegetation
Volumetrics
Water
Wildfire
World Spline Graph
Tutorials
Adding Morph Targets
Upgrading to UNIGINE 2.13
API Migration
Console Migration
Content Migration
IG Template
Setting Up Properties
IG Configuration
Environment Settings
Light Settings
Creating Custom Components
Processing User-Defined Packets
Debugging IG Application
IG Host
Troubleshooting
SDK Browser Issues
UnigineEditor Issues
.NET Core Issues
Third-Party Notices
Table of Contents
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

GUI

In This Article:

The current article describes the native GUI, which includes the following:

General info#

Unigine provides flexible Graphic User Interface (GUI), its main features are:

  • Various widgets and containers
  • Dialog windows
  • 3D effects
  • Activation animation
  • Easy skin changing
  • UI files in XML format
  • Localization support
  • True Type fonts support
  • Unicode (UTF8) support
  • IME input support

How to Create GUI Layout#

There are 2 ways to create the GUI layout:

By Scripting#

To create widgets directly from a script, perform the following steps:

  1. Declare all of the widgets as global variables in the script.
  2. Create the corresponding object for each widget.
  3. Define necessary properties for each object (height, width, etc.) by using functions of the corresponding GUI-related classes.
  4. Add root widgets to be rendered in the GUI interface via Gui::addChild().
  5. Add children of the root widgets to be rendered in the GUI interface via Gui::addChild().

By Using UI files#

To create widgets and describe the layout by using User interface (UI) files, perform the following:

  1. Create *.ui file that describes what widgets should be drawn and how they are laid out (see more details).
  2. Declare root widgets (or containers) as global variables in the script.
  3. Load User interface by using the UserInterface() constructor.
  4. Add root widgets to be rendered in the GUI interface via Gui::addChild().

This is faster and more convenient way to create a GUI.

How to Create Custom GUI Skin#

  1. Create all required GUI textures (see details on Skin Layout).
  2. If necessary, create Resource file (RC) where global settings for GUI interface are described.
  3. Use custom skin:
    • If you need to change the system GUI skin (2D GUI), replace files under data/core/gui folder.
    • If ObjectGui or ObjectGuiMesh (that is, monitors positioned in the world) is used, specify a folder with all textures, RC file and the default font in the constructor.
Last update: 2020-11-24
Build: ()