This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Terminology
Project Workflow
Hardware Requirements
Principles of Operation
Virtual World Structure
World Management
Rendering
Rendering Sequence
Scattering
Alpha Blending
Shading
HDR Rendering
Temporal Anti-Aliasing
Postprocessing
Panoramic Rendering with AppPanorama Plugin
Projections with AppProjection Plugin
Current Viewport Grabbing with AppGrabber Plugin
Hiding Shading Artifacts with AppBorder Plugin
DirectX 11 Software Rendering with AppLevel Plugin
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
File System
Tools
SDK Browser
Projects
Licenses
UnigineEditor
Overview
Controls
Managing Worlds
Scene Navigation
Setting Up Cameras
Importing Nodes
Selecting and Positioning Nodes
Organizing Nodes
Rendering Settings
Camera Effects
Setting Up Materials
Setting Up Properties
Setting Up Physics
Terrain Editor
Terrain Grabber
System Menu
Video Grabber
Mask Editor
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
ResourceEditor
MeshViewer
NormalCombiner
NormalMapper
AmbientMapper
AlphaMapper
ImageDDS
ImageTTF
Launcher
Launcher Structure
Launcher Customization
Browser Functions
JS Functions
Log Functions
USC Interpreter
Archiver
Resource
Terrain
MeshImport
Upgrade Script
Built-in Objects
Nodes
Node
Node Reference
Dummy Node
Layer
Pivot
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Text Object
Sky
Effects
Particle System
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Light Sources Parameters
Omni Light
Projected Light
World Light
Environment Probe
Geodetics
Geodetic Pivot
World Objects
World Layer
Sector
Portal
World Trigger
World Cluster
World Clutter
Switcher
World Expression
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentials
Programming Overview
Engine Architecture
Typical Architecture of a Unigine-Based Application
Memory Management
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Mac OS X Development Environment
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
High-Level Systems
Basic Utilities
Unigine::Schemer
Unigine::Skinner
Input System
Character System
KeyLine System
Dialogs Script
Cache Files
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
C# API Reference
UUSL (Unified UNIGINE Shader Language)
UUSL Data Types and Common Intrinsic Functions
UUSL Parameters
UUSL Textures
UUSL Semantics
UUSL Tessellation
Creating of Custom Shader for Deferred Rendering Pass
Creating of Custom Shader for Forward Rendering Pass
Creating of Custom Shader for Post-Processing
File Formats
Mesh File Formats
Material File Format
Startup Command-Line Options
Console
Rebuilding the Engine and Tools
Rebuild in Windows via Visual Studio
Rebuild in Mac OS X via Xcode
Semi-automatic Compilation with Build Script
Manual Compilation with SCons
Preprocessor Macros for Rebuilding the Engine
Protecting Your Data with a Password
GUI
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
API
Core Library
Containers
Tree::ConstIterator Class (C++)
Tree::Iterator Class (C++)
Tree< Key, Data > Class Template (C++)
Map Class (C++)
ArrayMap Class (C++)
ArrayMap::Iterator Class (C++)
Vector::ConstIterator Class (C++)
Vector::Iterator Class (C++)
Vector< > Class Template (C++)
ArrayVector Class (C++)
Engine Classes
Engine Class (UnigineScript)
Engine Class (C++)
App Class
Config Class
Console Class
Editor Class
Filesystem Class
Game Class
Materials Class
Memory Class (UnigineScript)
Memory Class (C++)
Physics Class
Profiler Class
Properties Class
Sound Class
Splash Class
Visualizer Class
World Class
Unigine Namespace Functions (C++)
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
Rendering-Related Classes
Render Class
Renderer Class
RenderState Class
Material Class
Shader Class
Texture Class
TextureRender Class
Mesh Class
Camera Class
Viewport Class
FFP Class
Physics-Related Classes
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Bounds-Related Classes
BoundBox Class (UnigineScript)
BoundBox Class (C++)
BoundFrustum Class (UnigineScript)
BoundFrustum Class (C++)
BoundSphere Class (UnigineScript)
BoundSphere Class (C++)
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
WidgetSprite Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
PathRouteIntersection Class
Utility Classes
TypeInfo Class (C++)
Thread Class (C++)
Stream Class (C++)
StreamBase Class (C++)
Timer Class (C++)
Resource Class (C++)
Ptr< Type > Class Template (C++)
FunctionBase Class (C++)
CallbackBase Class (C++)
Checksum Class (C++)
Compress Class (C++)
ExternClass< Class > Class Template (C++)
Variable Class (C++)
ConsoleVariableFloat Class (C++)
ConsoleVariableInt Class (C++)
ConsoleVariableString Class (C++)
Package Class (C++)
GameIntersection Class
Path Class
Property Class
Content Creation
Content Pipeline
3D Models Requirements
Art Assets Conversion
Content Optimization
Materials
Hierarchy and Inheritance
Custom Materials
Tutorials
Adding Morph Targets
Setting Up Object LODs
Adding Sun, Sky and Clouds
Adding Impostors to Clutters
Unigine Demos
Migrating from UNIGINE 2.1.1 to UNIGINE 2.2
API Migration
Startup CLIs Migration
Console Migration
Content Migration
Table of Contents
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

GUI

In This Article:

There are 2 types of the GUI supported by Unigine:

  • Unigine native GUI

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 (hight, 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: 03.07.2017
Build: ()