This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
What's Inside?
Project Workflow
Migrating to Unigine
Migrating to Unigine From UnrealEngine
Migrating to Unigine From Unity
Programming Quick Start
1. Basic Scene Objects and Coordinate System
2. Logging and Printing Messages to Console
3. Saving and Loading a World
4. Closing the Application
5. Working with Smart Pointers
6. Creating and Deleting Nodes at Runtime
7. Creating and Setting Up a Camera
8. Creating and Setting up Light Sources
9. Creating, Applying and Deleting Materials at Runtime
10. Managing Existing Scene Objects
11. Performing Basic Transformations (Move, Rotate, Scale)
12. Making It in Time
13. Managing Intersections
14. Getting and Managing User Inputs
15. Implementing Game Logic and Using Properties
16. Creating User Interface
System Requirements
Principles of Operation
Virtual World Structure
World Management
Properties
Hierarchy and Inheritance
Custom Component System
Rendering
Rendering Sequence
Scattering
PSSM
Temporal Anti-Aliasing
Alpha Blending
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
Import System
File System
SDK Browser
Projects
Licenses
Add-Ons
Kinect2 Add-On
Tutorials Content Add-On
Vegetation Add-On
VRPN Add-On
UnigineEditor
Interface Overview
Layout Customization
Assets Workflow
Asset Types
Assets and Runtime Files
Organizing Assets
Copying Assets From Other Projects
Project Files
Version Control
Settings and Preferences
Editor Hotkeys
Global Physics Settings
Global Sound Settings
Working With Projects
Managing Worlds
Scene Navigation
Creating and Importing Nodes
Selecting and Positioning Nodes
Organizing Nodes
Exporting Nodes
Instancing Nodes
Adjusting Node Parameters
Transformation and Common Parameters
Visual Representation
Properties
Physics
Setting Up Materials
Organizing Materials
Setting Up Properties
Organizing Properties
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
Using Editor Tools for Specific Tasks
Capturing Screenshots and Frame Sequences
Adding Variations for a More Realistic Environment
Manual Terrain Modification
Mask Editor for Grass and Clutters
Bake Lighting
FAQ
Switching From the Previous Version of the Editor
Tools
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
USC Interpreter
Tileset File
Archiver
Resource
MeshImport
Upgrade Script
Built-in Node Types
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
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 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
Fundamentals
Programming Overview
Engine Architecture
Typical Architecture of a Unigine-Based Application
Memory Management
Accessing Nodes and Files via Properties
Matrix Transformations
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Usage Examples
Custom Component System
Basic Object Movements
Creating and Attaching a Cloth
Creating a Car with Suspension 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
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
Cache Files
C++
Creating C++ Application
Creating C++ Plugin
C#
Creating C# Application
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
Mesh File Formats
Property File Format
Spline File Format
Startup Command-Line Options
Console
Configuration File
Rebuilding the Engine and Tools
Rebuild in Windows via Visual Studio
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
How to Generate Shader Cache
API
Containers
Container Functions
ArrayVector Class
Map Class
Set Class
Common Functionality
Async Class
Atomiclock Class
Blob Class
CallbackBase Class
Checksum Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
Expression Class
ExternClass Class
FunctionBase Class
Hash Class
Hasher Class
Image Class
Interpreter Class
Json Class
Log Class
OS Functions
Path Class
Plugin Class
Property Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
StringArray Class
StringPtr Class
StringStack Class
System Functions
Thread Class
Timer Class
TypeInfo Class
Unigine Namespace Items
Utils Class
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
ControlsJoystick Class
ControlsSixAxis
ControlsXPad360 Class
Engine-Related Classes
App Class
Config Class
Console Class
Editor Class
Engine Class
EnginePtr Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
Splash Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
FileSystem Class
FileSystemAssets 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
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
NodePivot Class
NodeReference Class
NodeTrigger 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
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
AppEasyBlendInterface Class
ColladaImport Class
OpenFlightImport Class
engine.grabber Functions
engine.kinect Functions
engine.oculus Functions
AppProjectionInterface Class
engine.surround Functions
engine.vive Functions
engine.wall Functions
CIGI Client Plugin
CIGI Client interface
IArticulatedPart Class
IComponent Class
IEntity Class
IViewBase Class
IView Class
IViewGroup Class
ICigiHostPacket Class
ICigiArticulatedControl Class
ICigiArticulatedShortControl Class
ICigiAtmosphereControl Class
ICigiCelestialControl Class
ICigiComponentControl Class
ICigiComponentShortControl Class
ICigiEntityControl Class
ICigiEntityClampedControl Class
ICigiEnvironmentControl Class
ICigiEnvironmentRequest Class
ICigiIGControl Class
ICigiMaritimeControl Class
ICigiRateControl Class
ICigiSensorControl Class
ICigiSymbolCircleDef Class
ICigiSymbolClone Class
ICigiSymbolControl Class
ICigiSymbolShortControl Class
ICigiSymbolLineDef Class
ICigiSymbolSurfaceDef Class
ICigiSymbolTextDef Class
ICigiTerrestrialControl Class
ICigiTrackerControl Class
ICigiViewControl Class
ICigiWaveControl Class
ICigiWeatherControl Class
ICigiViewDef Class
ICigiEarthModelDef Class
ICigiSegmentDef Class
ICigiTrajectoryDef Class
ICigiVolumeDef Class
ICigiHatHotRequest Class
ICigiIGPacket Class
ICigiStartOfFrame Class
ICigiAerosolResponse Class
ICigiHatHotResponse Class
ICigiHatHotExtResponse Class
ICigiLosResponse Class
ICigiLosExtResponse Class
ICigiLosSegmentRequest Class
ICigiLosVectorRequest Class
ICigiMaritimeResponse Class
ICigiPositionRequest Class
ICigiPositionResponse Class
ICigiSensorResponse Class
ICigiSensorExtResponse Class
ICigiTerrestrialResponse Class
ICigiWeatherResponse Class
Rendering-Related Classes
Camera Class
Ffp Class
Material Class
Materials Class
Mesh Class
Primitives Class
Render Class
RenderEnvironmentPreset Class
Renderer Class
RenderContext Class
RenderState Class
Shader Class
StructuredBuffer Class
Texture Class
TextureRender Class
Viewport Class
Content Creation
3D Models Requirements
Art Assets Conversion
Content Optimization
Materials
Hierarchy and Inheritance
Custom Materials
Samples
Tutorials
Adding Morph Targets
Setting Up Object LODs
Adding Impostors to Clutters
Video Tutorials
Interface
Interface Overview
The Scene Viewport
Essentials
Importing 3D Models
Instancing Nodes
Materials
Lighting
Tracker Tool
Global Illumination
Migrating to UNIGINE 2.7
API Migration
Console Migration
Content Migration
Old Editor Workflow Projects
Assets Workflow Projects
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.

What's Inside?

In This Article:

UNIGINE engine is a fully-featured 3D platform designed for creation of interactive virtual worlds with a photo-realistic quality. This powerful and extremely flexible solution is used for real-time simulation (transportation, military training, etc.), visualization (architecture, media installations, etc.) and game development.

However, UNIGINE is not some sort of application building constructor: it is a very robust, feature-rich, and optimized software library with a set of tools. So you will need some people in the team with programming skills (preferrably C++) to utilize the UNIGINE power for your projects. Please also note that some features are optional, depending on the SDK edition (Entertainment / Engineering / Sim).

UNIGINE provides support for Windows and Linux.

For more details, see hardware requirements.

Renderer

The UNIGINE image generator provides a near-photorealistic rendering of visual scenes based on sophisticated shading and lighting models, accurate atmosphere model, advanced special effects and lifelike post-processing.

  • Physically based rendering (PBR)
  • GGX BRDF: realistic speck from light sources
  • Ultra-quality environment probes
  • Energy conservation model
  • Microfiber effect for fabric
  • Cinematic post-effects: SSAO, motion blur, chromatic aberrations, grain effect, sharpness filter, etc.
  • Atmospheric light scattering for realistic simulation of the atmosphere
  • Excellent rendering of vast, detailed masses of vegetation
  • Configurable forward and deferred rendering
  • Support for GLSL, HLSL and UUSL languages for shaders
  • Support for both DirectX 11 and OpenGL 4.x

Image Output Schemas

UNIGINE handles various image output schemas:

Scene Manager

Built-in advanced scene manager is designed for handling virtual worlds of unprecedented scale filled with thousands of objects.

  • Support for 64-bit double precision of coordinates
  • Scene graph providing nodes hierarchy, easy control over nodes and branches relative object-space transformations, spatial multi-tree subdivision
  • Asynchronous data streaming
  • Advanced LOD system
  • Increased camera precision
  • Procedural placement of big amount of objects
  • Sectors / portals system for optimization of complex indoor scenes
  • Support for geo-coordinates
  • Extremely fast intersection / line of sight tests
  • Increased visibility distance

Built-in Objects

UNIGINE provides a set of built-in objects allowing you to create a complex, dynamic virtual world:

  • Nodes serve to organize other nodes into a hierarchy, create new pivot points and triggers
  • Light sources represent different kinds of the scene illumination: global, omni-directional, projected, etc.
  • Objects represent imitations of entities present in the real world: objects, sky, terrains, water, etc.
  • Effects contain particles systems, physical fields, volumetric objects, decals, etc.
  • Players represent different kinds of cameras

Physics Engine

There is a built-in physics engine available. Please take into the account that it is designed primarily for "game-level" physics simulation: for accurate simulation of physical processes (e.g.: flight dynamics model) it is recommeded to use the specialized solutions.

  • Collision detection and rigid body physics
  • Rag dolls
  • Various joints, motors and springs
  • Deformable cloth and rope physics
  • Dynamic destruction of objects
  • Force fields
  • Fluid buoyancy and two-way interaction
  • Time reverse feature

Application Programming Interfaces

You can choose among powerful UNIGINE APIs:
  • C++ API for maximum performance and seamless integration with the existing code base
  • C# API for a good balance between speed and ease of use
  • Fast iterative scripting with UnigineScript, featuring instant compilation

Input Systems

UNIGINE handles various user input schemas:
  • Standard PC keyboards and mice
  • Multi-touch screens
  • Gamepads and joysticks
  • Head trackers
  • 6 DOF positioning devices
  • Motion capture systems

There is also our API for adding custom devices.

Audio System

Multi-channel audio system with support for:

  • 3D effects
  • Sound occlusion
  • Reverberation zones

Graphical User Interface

There are several ways to implement GUIs in UNIGINE-powered applications:

Tools

  • UnigineEditor provides the core functionality for creation and editing of virtual worlds for UNIGINE-based applications. It allows you to easily view and modify virtual worlds by adding, transforming and editing the nodes.
  • SDK browser for easy access to the SDK components and updates
  • Performance profiling tools
  • A set of other utilities for data conversion and compression
Last update: 2018-04-26
Build: ()