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
Migrating to UNIGINE 2.0
Commad-Line Options Migration
Console Migration
C++ API Migration
Unigine Namespace Functions
Unigine World Functions
Unigine::App Class
Unigine::CallbackBase Class
Unigine::Checksum Class
Unigine::dmat4 Struct
Unigine::ivec and Unigine::dvec Structures
Unigine::Editor Class
Unigine::Engine Class
Unigine::Ffp Class
Unigine::File Class
Unigine::FileSystem Class
Unigine::Game Class
Unigine::Gui Struct
Unigine::Image::Pixel Struct
Unigine::Image Class
Unigine::mat4 Struct
Unigine::Material Class
Unigine::Materials Class
Unigine::Memory Class
Unigine::Mesh Class
Unigine::Node Class
Unigine::Object Class
Unigine::ObjectBillboard Class
Unigine::ObjectBillboards Class
Unigine::ObjectDummy Class
Unigine::ObjectDynamic Class
Unigine::ObjectExtern Class
Unigine::ObjectExternBase Class
Unigine::ObjectMeshCluster Class
Unigine::ObjectMesh Class
Unigine::ObjectMeshSkinned Class
Unigine::ObjectMeshDynamic Class
Unigine::ObjectTerrain Class
Unigine::Physics Class
Unigine::Player Class
Unigine::PlayerDummy Class
Unigine::Property Class
Unigine::Properties Class
Unigine::Ptr< Type > Class Template
Unigine::Render Class
Unigine::Shader Class
Unigine::Sound Class
Unigine::State Class
Unigine::Stream Class
Unigine::String Class
Unigine::Texture Class
Unigine::TextureRender Class
Unigine::Thread Class
Unigine::UserInterface Class
Unigine::Variable Class
Unigine::Vector< > Class Template
Unigine::Visualizer Class
Unigine::Widget Class
Unigine::WidgetButton Class
Unigine::WidgetCanvas Class
Unigine::WidgetCheckBox Class
Unigine::WidgetComboBox Class
Unigine::WidgetDialog Class
Unigine::WidgetEditLine Class
Unigine::WidgetEditText Class
Unigine::WidgetExtern Class
Unigine::WidgetGridBox Class
Unigine::WidgetGroupBox Class
Unigine::WidgetHBox Class
Unigine::WidgetHPaned Class
Unigine::WidgetIcon Class
Unigine::WidgetLabel Class
Unigine::WidgetListBox Class
Unigine::WidgetMenuBar Class
Unigine::WidgetMenuBox Class
Unigine::WidgetScroll Class
Unigine::WidgetScrollBox Class
Unigine::WidgetSlider Class
Unigine::WidgetSpacer Class
Unigine::WidgetSpinBox Class
Unigine::WidgetSprite Class
Unigine::WidgetTabBox Class
Unigine::WidgetTreeBox Class
Unigine::WidgetVBox Class
Unigine::WidgetVPaned Class
Unigine::WidgetWindow Class
Unigine::Xml Class
Content Migration
Principles of Operation
Virtual World Structure
World Management
Rendering
Rendering Sequence
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
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
File System
Tools
SDK Browser
Projects
UnigineEditor
Overview
Controls
Managing Worlds
Scene Navigation
Setting Up Cameras
Importing Nodes
Selecting and Positioning Nodes
Organizing Nodes
Rendering Settings
Setting Up Materials
Setting Up Properties
Setting Up Physics
Terrain Editor
Terrain Grabber
System Menu
Video Grabber
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
Sky
Effects
Particle System
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Omni Light
Projected Light
World Light
Environment Probe
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
Programming Overview
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Mac OS X Development Environment
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
Engine Architecture
Execution Sequence
Where to Put Your Code: Update(), Flush() or Render()
Typical Architecture of a Unigine-Based Application
Memory Management
Mesh File Formats
Old Mesh File Formats
Material File Format
Protecting Your Data with a Password
GUI
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
How to Generate Shaders Cache
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
The Language
Structure of a Program
Data Types
Operators
Functions
Scope. Namespaces
Object Oriented Programming
Interface Class
Preprocessor Directives
Templates
Language Features
Core Library
Engine Library
Variables
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
GameIntersection Class
Material Class
Mesh Class
Path Class
Property 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
Plugins Library
AutodeskImport Class
ColladaImport Class
OpenFlightImport Class
engine.border Functions
engine.grabber Functions
engine.oculus Functions
engine.projection Functions
engine.surround Functions
engine.wall Functions
engine.kinect Functions
High-Level Systems
Basic Utilities
Unigine::Schemer
Unigine::Skinner
Input System
Character System
KeyLine System
Dialogs Script
Samples
Usage Examples
Intersections
Mesh Class
Dynamic Meshes
Working with Console
Creating Routes
Matrix Transformations
Basic Object Movements
Cache Files
Script Debugging
C++ API
Creating C++ Application
Creating C++ Plugin
API Reference
Unigine Namespace Functions
Unigine::App Class
Unigine::ArrayMap Class
Unigine::ArrayMap::Iterator Class
Unigine::ArrayVector Class
Unigine::AtomicLock Class
Unigine::BoundBox Class
Unigine::BoundFrustum Class
Unigine::BoundSphere Class
Unigine::Blob Class
Unigine::CallbackBase Class
Unigine::Compress Class
Unigine::Checksum Class
Unigine::Config Class
Unigine::Console Class
Unigine::ConsoleVariableFloat Class
Unigine::ConsoleVariableInt Class
Unigine::ConsoleVariableString Class
Unigine::Controls Class
Unigine::Decal Class
Unigine::DecalMesh Class
Unigine::DecalOrtho Class
Unigine::DecalProj Class
Unigine::Editor Class
Unigine::Engine Class
Unigine::EnginePtr Class
Unigine::ExternClass< Class > Class Template
Unigine::Ffp Class
Unigine::Field Class
Unigine::FieldAnimation Class
Unigine::FieldSpacer Class
Unigine::File Class
Unigine::FileSystem Class
Unigine::FunctionBase Class
Unigine::Game Class
Unigine::Gui Class
Unigine::Image Class
Unigine::Interpreter Class
Unigine::Light Class
Unigine::LightOmni Class
Unigine::LightEnvironmentProb Class
Unigine::LightProj Class
Unigine::LightWorld Class
Unigine::Log Class
Unigine::Map Class
Unigine::Material Class
Unigine::Materials Class
Unigine::Memory Class
Unigine::Mesh Class
Unigine::Node Class
Unigine::NodeReference Class
Unigine::NodeDummy Class
Unigine::NodeExtern Class
Unigine::NodeExternBase Class
Unigine::NodeLayer Class
Unigine::NodePivot Class
Unigine::NodeTrigger Class
Unigine::Object Class
Unigine::ObjectExtern Class
Unigine::ObjectExternBase Class
Unigine::ObjectBillboards Class
Unigine::ObjectDummy Class
Unigine::ObjectDynamic Class
Unigine::ObjectGui Class
Unigine::ObjectGuiMesh Class
Unigine::ObjectMeshCluster Class
Unigine::ObjectMeshClutter Class
Unigine::ObjectMeshDynamic Class
Unigine::ObjectMeshSkinned Class
Unigine::ObjectMeshStatic Class
Unigine::ObjectParticles Class
Unigine::ObjectSky Class
Unigine::ObjectVolumeBox Class
Unigine::ObjectVolumeOmni Class
Unigine::ObjectVolumeProj Class
Unigine::ObjectVolumeSphere Class
Unigine::ObjectTerrain Class
Unigine::ObjectWater Class
Unigine::ObjectWaterMesh Class
Unigine::Package Class
Unigine::Path Class
Unigine::Physical Class
Unigine::PhysicalForce Class
Unigine::PhysicalNoise Class
Unigine::PhysicalTrigger Class
Unigine::PhysicalWater Class
Unigine::PhysicalWind Class
Unigine::Physics Class
Unigine::Player Class
Unigine::PlayerActor Class
Unigine::PlayerDummy Class
Unigine::PlayerPersecutor Class
Unigine::PlayerSpectator Class
Unigine::Plugin Class
Unigine::Property Class
Unigine::Properties Class
Unigine::Ptr< Type > Class Template
Unigine::Set Class
Unigine::Render Class
Unigine::Renderer Class
Unigine::Resource Class
Unigine::Shader Class
Unigine::Socket Class
Unigine::Sound Class
Unigine::Splash Class
Unigine::State Class
Unigine::Stream Class
Unigine::StreamBase Class
Unigine::String Class
Unigine::Texture Class
Unigine::TextureRender Class
Unigine::Thread Class
Unigine::Timer Class
Unigine::Tree::ConstIterator Class
Unigine::Tree::Iterator Class
Unigine::Tree::Node Class
Unigine::Tree< Key, Data > Class Template
Unigine::TypeInfo Class
Unigine::UserInterface Class
Unigine::Variable Class
Unigine::Vector::ConstIterator Class
Unigine::Vector::Iterator Class
Unigine::Vector< > Class Template
Unigine::Visualizer Class
Unigine::Widget Class
Unigine::WidgetButton Class
Unigine::WidgetCanvas Class
Unigine::WidgetCheckBox Class
Unigine::WidgetComboBox Class
Unigine::WidgetDialog Class
Unigine::WidgetDialogColor Class
Unigine::WidgetDialogFile Class
Unigine::WidgetDialogImage Class
Unigine::WidgetDialogMessage Class
Unigine::WidgetEditLine Class
Unigine::WidgetEditText Class
Unigine::WidgetExtern Class
Unigine::WidgetExternBase Class
Unigine::WidgetGridBox Class
Unigine::WidgetGroupBox Class
Unigine::WidgetHBox Class
Unigine::WidgetHPaned Class
Unigine::WidgetIcon Class
Unigine::WidgetLabel Class
Unigine::WidgetListBox Class
Unigine::WidgetMenuBar Class
Unigine::WidgetMenuBox Class
Unigine::WidgetScroll Class
Unigine::WidgetScrollBox Class
Unigine::WidgetSlider Class
Unigine::WidgetSpacer Class
Unigine::WidgetSpinBox Class
Unigine::WidgetSprite Class
Unigine::WidgetTabBox Class
Unigine::WidgetTreeBox Class
Unigine::WidgetVBox Class
Unigine::WidgetVPaned Class
Unigine::WidgetWindow Class
Unigine::World Class
Unigine::WorldExtern Class
Unigine::WorldExternBase Class
Unigine::WorldIntersection Class
Unigine::WorldIntersectionNormal Class
Unigine::WorldIntersectionTexCoord Class
Unigine::WorldLayer Class
Unigine::WorldPortal Class
Unigine::WorldSector Class
Unigine::WorldSwitcher Class
Unigine::WorldTrigger Class
Unigine::WorldClutter Class
Unigine::WorldCluster Class
Unigine::WorldOccluder Class
Unigine::WorldOccluderMesh Class
Unigine::WorldOccluderTerrain Class
Unigine::WorldTransformPath Class
Unigine::WorldTransformBone Class
Unigine::WorldExpression Class
Unigine::Xml Class
Unigine::bvec4 Struct
Unigine::dmat4 Struct
Unigine::dvec2 Struct
Unigine::dvec3 Struct
Unigine::dvec4 Struct
Unigine::ivec2 Struct
Unigine::ivec3 Struct
Unigine::ivec4 Struct
Unigine::mat4 Struct
Unigine::quat Struct
Unigine::vec2 Struct
Unigine::vec3 Struct
Unigine::vec4 Struct
Unigine::Ffp::Vertex Struct
Unigine::Image::Pixel Struct
Unigine::Mesh::Weight Struct
Unigine::ObjectMeshDynamic::Vertex Struct
Unigine::ObjectDynamic::Attribute Struct
Unigine::Image::Pixelf Union
Unigine::Image::Pixeli Union
Integration Samples
Unigine Integration into SDL Application
Unigine Integration into Qt Application
Usage Examples
Library's Namespace
Variable Export
Constant Export
Function Export
Class Export
Data Structure Export
Callbacks
Serialization
App Class
UnigineScript Containers
C++ Plugins
CIGI Protocol Support via CigiClient Plugin
Secure SSL Connection via SSLSocket Plugin
GPU Monitoring with GPUMonitor Plugin
Razer Hydra Support via Sixense Plugin
Renderer Customization via Renderer Plugin
C# API
Creating C# Application
C# API Reference
C# Integration Samples
Application with Direct3D11 via SlimDX Library
Application with Direct3D11 via SharpDX Library
Application with OpenGL via OpenTK Library
C# Usage Examples
Callbacks
UnigineScript Containers
Variable Export
Plugin Class
Package Class
Widget Dialog
Content Creation
Content Pipeline
Art Assets Conversion
Content Optimization
Materials
Hierarchy and Inheritance
Custom Materials
Tutorials
Adding Object into a New World
Adding Animated Object into the Loaded World
Adding Morph Targets
Setting Up Object LODs
Adding Sun, Sky and Clouds
Adding Water
Adding Grass
Adding Impostors to Clutters
Unigine Demos
Table of Contents
注意！ 这个版本的文档是过时的，因为它描述了一个较老的SDK版本！请切换到最新SDK版本的文档。
注意！ 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

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 game development, real-time simulation (military, transportation, training, etc.) and visualization (architecture, media installations, etc.). UNIGINE provides quick and easy solutions for starting, developing and releasing of your projects.

UNIGINE provides support for Windows, Linux and Mac OS X and features multi-API renderer (DirectX 11 / OpenGL).

For more details, see hardware requirements.

Image Generator

The UNIGINE image generator provides a near-photorealistic rendering of visual scenes based on sophisticated shading (with support for the most advanced Shader Model 5.0).

  • Atmospheric light scattering based on Rayleigh and Mie models with support for physical parameters like turbidity, altitude, depolarization and more
  • Life-like post-processing: HDR, motion blur, DOF with a bokeh effect
  • 5 different types of light sources: world (global illumination), spot, omnidirectional, projected, light probes
  • Screen-space ambient occlusion
  • Dynamic soft shadows with support for PSSM technology
  • Hardware tessellation
  • Configurable forward and deferred rendering
  • Hierarchical built-in materials system
  • Stereo rendering
  • Multi-monitor rendering
  • GLSL and HLSL languages for custom shaders

Scene Manager

Built-in scene manager is designed for handling virtual worlds of unprecedented scale.

  • Support for 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
  • Vegetation generation

Built-in Objects

UNIGINE provides a set of built-in objects allowing you to create a world containing practically all of the objects organizing a real life scene:

  • 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
  • World Objects are invisible nodes used for world management
  • Sound Objects represent sound sources and reverberations
  • Pathfinding Objects represent objects used for pathfinding

Physics Engine

  • 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

Animation System

Articulated parts can be controlled programmatically by means of our C++ API or UnigineScript code or via visual configuration (our Skinner tool). There is also support for importing skinned mesh animation from different standard formats.

Audio System

Multi-channel audio system with support for:

  • 3D effects
  • Sound occlusion
  • Reverberation zones

Pathfinding System

Any AI agent can use our built-in 2D/3D pathfinding module, featuring dynamic obstacle management, and deferred route detection.

Graphical User Interface

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

  • Native GUI (comprehensive set of widgets with 2D/3D effects and localization support)
  • Integration into Qt 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.
  • Plugins used for import / export data to / from the engine
  • Plugins used for compressing data
  • Plugins used for upgrading data

Flexible Scripting Systems

Developers have freedom to choose among powerful UNIGINE APIs:

  • Fast iterative scripting with UnigineScript featuring instant compilation, and thousands of useful functions
  • C++ API for maximum performance and seamless integration with the existing code base
  • C# API replicating all the C++ functionality for convenient coding

Input and Output Systems

UNIGINE Sim handles various user input schemes:

  • Standard PC keyboard and mouse
  • Multi-touch screen
  • Gamepad or joystick
  • Head tracker
  • 6DOF positioning device

There is also our C++ API for adding custom devices.

High Level Systems

UNIGINE provides a set of high-level systems for fast and convenient content creation and optimization:

Last update: 2017-07-03
Build: ()