Getting Started

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

Video Tutorials

Interface Overview

The Scene Viewport

Importing 3D Models

Instancing Nodes

Global Illumination

Georeferenced Terrain Generation

Principles of Operation

Virtual World Structure

World Management

Hierarchy and Inheritance

Custom Component System

Rendering Sequence

Temporal Anti-Aliasing

Stereo Rendering

NVIDIA 3D Vision Output with App3DVision Plugin

NVIDIA 3D Vision Surround Output with App3DSurround Plugin

Separate Images Output with AppSeparate Plugin

Quad Buffered Stereo Support

Oculus Rift Output with AppOculus Plugin

HTC Vive Output with AppVive Plugin

Multi-Monitor Rendering

Video Wall Output with AppWall Plugin

3 Monitor Output with AppSurround Plugin

Panoramic Rendering

Projections with AppProjection Plugin

Physical Bodies

Collision Detection

Simulation of Physics

Add-Ons

Tutorials Content Add-On

Vegetation Add-On

Interface Overview

Layout Customization

Assets Workflow

Assets and Runtime Files

Creating and Importing Assets

FBX Import Guide

Texture Import Guide

Organizing Assets

Copying Assets From Other Projects

Version Control

Settings and Preferences

Render Settings

Visibility Distances

Global Illumination

Vegetation Parameters

Occlusion Culling

Screen-Space Materials

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

Setting Up Materials

Organizing Materials

Forced Shader Compilation

Setting Up Properties

Organizing Properties

Setting Up Cameras

Using Visual Helpers

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

Making Cutscenes With Camera Motion Control

Basic Operations in Tracker

Creating Type-Specific Tracks

Running Tracks in Application

Capturing Screenshots and Frame Sequences

Adding Variations for a More Realistic Environment

Manual Terrain Modification

Mask Editor for Grass and Clutters

FAQ

Switching From the Previous Version of the Editor

Built-in Node Types

Nodes

Terrain

Terrain Material

Global Terrain Details

Water

Grass

Tutorial: Adding Grass

Stars Generator for Billboards

Particle System

Volumetric Objects

Volume Projected

Fields

Field Animation

Field Shoreline

Physical Trigger

Projected Decal

Orthographic Decal

Light Sources Parameters

Projected Light

Environment Probe

Occluder Terrain

World Expression

Pathfinding Objects

Navigation Areas

Navigation Sector

Navigation Mesh

Obstacle Sphere

Obstacle Capsule

Player Persecutor

Player Spectator

Programming Overview

Engine Architecture

Execution Sequence

Where to Put Your Code: Update(), Flush() or Render()

Typical Architecture of a Unigine-Based Application

Memory Management

Accessing Nodes and Files via Properties

Matrix Transformations

Camera Matrices

Setting Up Development Environment

Windows Development Environment

Linux Development Environment

Custom Import Plugin

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

Enabling Selective Surface-Based Collision

Playing Sounds on Collisions

Working with Console

Creating UnigineScript Application

Adding Scripts to the Project

Script Debugging

High-Level Systems

UnigineScript Basic Utilities

Unigine::Widgets

User Interfaces for Unigine::Widgets

app_surround_00

app_surround_01

C++

Creating C++ Application

Creating C++ Plugin

Integration Samples

Unigine Integration into SDL Application

Unigine Integration into Qt Application

C++ Usage Examples

Library's Namespace

Variable Export

Constant Export

Function Export

Data Structure Export

UnigineScript Containers

CIGI Protocol Support via CigiClient Plugin

Implementing CIGI Client Logic for a Custom Project

HLA Support via HLAClient Plugin

Implementing HLA Client Logic for a Custom Project

LeapMotion Plugin

Secure SSL Connection via SSLSocket Plugin

Syncker-Specific Options

Configuring Screens and Projections

Implementing Syncker Logic for a Custom Project

GPU Monitoring with GPUMonitor Plugin

Renderer Customization via Renderer Plugin

Setting Up Projections with AppEasyBlend Plugin

C#

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

UnigineScript Containers

Variable Export

UUSL (Unified UNIGINE Shader Language)

UUSL Common Intrinsic Functions

UUSL GBuffer Structure

UUSL Data Structure

UUSL Parameters

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

Mesh File Formats

Materials Files

Base Material File Format

User Material File Format

Property File Format

Spline File Format

Startup Command-Line Options

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

Double Precision Coordinates

Performance Analyzer

API

Container Functions

ArrayMap Classes

ArrayMap::Iterator Class

ArrayVector Class

Tree::ConstIterator Class

Tree::Iterator Class

Vector::ConstIterator Class

Vector::Iterator Class

Common Functionality

Atomiclock Class

CallbackBase Class

ConsoleVariableFloat Class

ConsoleVariableInt Class

ConsoleVariableString Class

Expression Class

ExternClass Class

FunctionBase Class

File Import Classes

Data Structures

ImportProcessor Class

ImportScene Class

Interpreter Class

EditorLogic Class

SystemLogic Class

WorldLogic Class

Component System Classes

ComponentBase Class

ComponentSystem Class

Reflection Class

StringArray Class

StringPtr Class

StringStack Class

System Functions

Unigine Namespace Items

Controls-Related Classes

ControlsApp Class

ControlsDummy Class

ControlsJoystick Class

ControlsSixAxis

ControlsXPad360 Class

Engine-Related Classes

EnginePtr Class

engine.system Functions

EnginePlugins Class

GameIntersection Class

Properties Class

Visualizer Class

Filesystem Functionality

FileSystem Class

FileSystemAssets Class

AsyncQueue Class

File System Functions

PackageUng Class

GUI-Related Classes

UserInterface 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

Bounds-Related Classes

BoundFrustum Class

BoundSphere Class

WorldBoundBox Class

WorldBoundFrustum Class

WorldBoundSphere Class

Math Common Functions

Math 2D Functions

Math Exponential Functions

Math Matrix Functions

Math Random Functions

Math Trigonometrical Functions

Node-Related Classes

NodeDummy Class

NodeExtern Class

NodeExternBase Class

NodeLayer Class

NodePivot Class

NodeReference Class

NodeTrigger Class

Decals-Related Classes

DecalMesh Class

DecalOrtho Class

DecalProj Class

Field-Related Classes

FieldAnimation Class

FieldHeight Class

FieldShoreline Class

FieldSpacer Class

FieldWeather Class

Geodetics-Related Classes

Ellipsoid Class

DatasetRasterPosResolver Class

DatasetSpatialReference Class

DatasetCoordinateTransformer Class

GeodeticPivot Class

Lights-Related Classes

BakeLighting Class

LightEnvironmentProbe Class

LightVoxelProbe Class

LightOmni Class

LightProj Class

LightWorld Class

LightLensFlare Class

Objects-Related Classes

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

ObjectParticles Class

ObjectSky Class

ObjectTerrain Class

ObjectTerrainGlobal Class

TerrainGlobalDetail Class

TerrainGlobalLod Class

TerrainGlobalLodHeight Class

TerrainGlobalLods Class

TileSetFile Class

ObjectText Class

ObjectVolumeBox Class

ObjectVolumeOmni Class

ObjectVolumeProj Class

ObjectVolumeSphere Class

ObjectWaterMesh Class

ObjectWaterGlobal Class

Players-Related Classes

PlayerActor Class

PlayerDummy Class

PlayerPersecutor Class

PlayerSpectator Class

Sound Nodes-Related Classes

AmbientSource Class

SoundReverb Class

SoundSource Class

World Nodes-Related Classes

WorldCluster Class

WorldClutter Class

WorldExpression Class

WorldExternBase Class

WorldExtern Class

WorldIntersection Class

WorldIntersectionNormal Class

WorldIntersectionTexCoord Class

WorldLayer Class

WorldOccluder Class

WorldOccluderMesh Class

WorldOccluderTerrain Class

WorldPortal Class

WorldSector Class

WorldSplineGraph Class

SplineGraph Class

WorldSwitcher Class

WorldTransformBone Class

WorldTransformPath Class

WorldTrigger Class

Networking Functionality

Pathfinding-Related Classes

Navigation Class

NavigationMesh Class

NavigationSector Class

ObstacleBox Class

ObstacleCapsule Class

ObstacleSphere Class

PathRoute Class

PathRouteIntersection Class

Physics-Related Classes

PhysicsIntersection Class

PhysicsIntersectionNormal Class

Bodies-Related Classes

BodyCloth Class

BodyDummy Class

BodyFracture Class

BodyParticles Class

BodyRagDoll Class

BodyRigid Class

BodyWater Class

Joints-Related Classes

JointBall Class

JointCylindrical Class

JointFixed Class

JointHinge Class

JointParticles Class

JointPath Class

JointPrismatic Class

JointSuspension Class

JointWheel Class

Physical Nodes-Related Classes

PhysicalForce Class

PhysicalTrigger Class

PhysicalNoise Class

PhysicalWater Class

PhysicalWind Class

Shapes-Related Classes

ShapeCapsule Class

ShapeConvex Class

ShapeCylinder Class

ShapeSphere 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

IViewBase 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

HLA Client Plugin

Interface Plugin

InterfaceWindow Class

Engine Interface Class

LeapMotion Plugin

LeapMotionInterface Class

LeapMotionArm Class

LeapMotionBone Class

LeapMotionFinger Class

LeapMotionHand Class

ManagerInterface Class

SynckerInterface Class

MasterInterface Class

SlaveInterface Class

VrpnAnalogDevice Class

VrpnButtonDevice Class

VrpnTrackerDevice Class

Rendering-Related Classes

Materials Class

MeshDynamic Class

Primitives Class

RenderEnvironmentPreset Class

RenderContext Class

RenderState Class

StructuredBuffer Class

TextureRender Class

Content Creation

3D Models Requirements

Art Assets Conversion

Content Optimization

Hierarchy and Inheritance

Built-in Base Materials

billboards_base

billboards_cloud_base

billboards_impostor_base

grass_impostor_base

Physically Based Materials

render_composite

terrain_global_base

volume_cloud_base

volume_fog_base

volume_light_base

volume_omni_base

volume_proj_base

volume_shaft_base

water_global_base

Postprocess Materials

post_blur_radial

post_filter_rgb2rgbl

post_filter_rgb2yuv

post_filter_sobel

post_filter_wet

post_hblur_mask

post_vblur_mask

post_hblur_cube and post_vblur_cube

Debug Materials

debug_materials

Custom Materials

Adding Morph Targets

Setting Up Object LODs

Adding Impostors to Clutters

Migrating to UNIGINE 2.7.1

Console Migration

Table of Contents

Iteration Statements

Articles in This Section

for

while

do-while

forloop

foreach

foreachkey

Last update: 2018-06-04

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)