Forum
Docs (2.18.1) Unsupported SDK
Learn Unsupported SDK

Select Your Language

The documentation is translated into these languages automatically, so its text may contain inaccuracies and errors.

English
Русский
中文
Français
Deutsch
日本語
한국어
Español
Português
Italiano
Türkçe
Svenska
Suomi
Dansk
Nederlands
Norsk
हिन्दी
Tiếng Việt
Bahasa Indonesia
Polski
Limba Română
Magyar
Cрпски
Slovenčina
Slovenščina
Hrvatski
Český
Bosanski
Македонски
Български

This page has been translated automatically.

Click here to view the original English version instead.

in API

Not found

Getting Started

Downloading and Installing UNIGINE SDK

Project Workflow

Programming Quick Start

Programming Quick References

1. Setting Up the Project

2. Creating the Controllable Character

3. Implementing Shooting

4. Generating Physical Objects

5. Implementing Color Zone

6. Playing Background Music

7. Managing Game Rules

8. Creating the End UI

9. Building the Project

Getting Started with VR

Classes and Components Overview

System Requirements

Migrating to UNIGINE

Migrating to UNIGINE From Unreal Engine

Content Creation

Migrating to UNIGINE From Unity

Content Creation

Video Tutorials

SDK Browser Interface

Editor Interface

Importing 3D Models

Instancing Nodes

Global Illumination

Content Optimization

Performance Inspection with Microprofile

Procedural Texturing

Audio Sources and Sound Effects

C# Component System

Landscape Terrain

Volumetric Clouds

Node References: Must-Knows

Georeferenced Terrain Generation Using Sandworm

Microprofile for Artists

Basics

Export 3D Models from Autodesk Maya

Export 3D Models from Blender

Export 3D Models from Cinema 4D

Export 3D Models from Autodesk 3ds Max

Edit Source Code with a Custom IDE

Change the Default World On Startup

Customize Boot Screen

Disable Splash Screen

Use Texture Profiler to Optimize Performance

Use Physical Water To Make Objects Float and Imitate Streams

Configure Levels of Detail (LODs)

Using Autogenerated LODs

Delete Unused Assets from the Final Build

Transfer Assets to Another Project

Swapping and Transforming Objects for More Variations

Using Cluster Brush Editor

Replacing Assets in the Project

Capturing Screenshots and Frame Sequences

Use Cleaner to Delete Unused Assets from a Project

Migrate Scene From Unity To UNIGINE

Fix Excessive Visibility Range For Objects

Create Camera From Current Viewport

Remove Unwanted Particles From a Certain Volume

Lock Camera Transformation

Print User Messages to Console with C#

Access Assets from C# Components

Access Nodes from C# Components

Create C# (.NET) Project

Debug C# Project in Visual Studio Code

Debug C# Project in Visual Studio

Customize Loading Screens

Use World Triggers to Detect Nodes by Their Bounds

Use Physical Triggers to Catch Physical Objects

Use Node Triggers to Detect Changes in Node States

Use Intersections to Select Objects with the Mouse

Handle Contacts on Collision

Create a Final Build for a C# Project

C++ Programming

Create a C++ Project

Create a C++ Project (CMake)

Create a Final Build for a C++ Project

Enable Planar Reflections

Bake Global Illumination to Voxel Probes

Bake Reflections to Environment Probes

Use Cached Shadows

Create Scriptable Materials

Bake Global Illumination to Lightmaps

Reuse Lightmaps for Levels of Detail

Use Particle Systems to Create Fountain with Sparks

Tweak Baked Lighting Dynamically via the Lightmap Color

Combine Baked Lighting and Reflections via Additive Blending

Customize Environment Lighting

Make Thin Geometry Visible at Long Distances

Cut Out Unwanted Reflections in Occluded Areas of Irregular-Shaped Rooms

Create Vertex Color Based Animation for Vegetation

Set Up Adaptive Camera Exposure

Use Surface Custom Texture

Create and Use Flowmaps

Analyse Lighting Using Light Meter

Create a Custom Post-Effect Using Material Editor

Enable Panorama Space Dynamic Global Illumination (PSDGI)

Professional (SIM)

Quick start with IG Template for a Flight Simulator

Principles of Operation

Virtual World Structure

World Management

Hierarchy and Inheritance

Component System

C++ Component System

C# Component System

Rendering Sequence

Parallel-Split Shadow Mapping

Fast approXimate Anti-Aliasing (FXAA)

Temporal Anti-Aliasing (TAA)

Subpixel Reconstruction Anti-Aliasing (SRAA)

Interleaved Lights Rendering

Stereo Rendering

Separate Images Output with Separate Plugin

Quad Buffered Stereo Support

Oculus Rift Output with Oculus Plugin

VR Output with OpenVR Plugin

Varjo Output with Varjo Plugin

Multi-Monitor Rendering

Video Wall Output with Wall Plugin

3 Monitor Output with Surround Plugin

Panoramic Rendering

Projections with Projection Plugin

Upscaling with DLSS and FSR

Physical Bodies

Collision Detection

Simulation of Physics

Asynchronous Data Streaming

Licensing and License Types

License Activation

Managing Company Accounts and Licenses

How to Count Seats and Channels

How to Install and Activate Editor For Sim

Add-Ons

Eastern European Countryside

Docs Sample Content

Industrial Assets

Road Tool Constructor

Georeferenced Terrain Generation

Procedural Generation Assets

Demos

C# Component Samples

Character Controller

Weapon Clipping

World Intersection

C# Third Person Platformer

Landscape Terrain

Physics-Based Animation

Render to Texture

Tracked Vehicle

CPP SIM Samples

Drone Simulator

C# API

Network

Photon Integration Sample

Interface Overview

Layout Customization

Assets Workflow

Assets and Runtime Files

Creating and Importing Assets

FBX Import Guide

CAD Import Guide

Texture Import Guide

Exporting 3D Models From Blender

Exporting 3D Models From Autodesk Maya

Exporting 3D Models From Autodesk 3ds Max

Exporting 3D Models From Maxon Cinema 4D

Organizing Assets

Copying Assets From Other Projects

Optimizing Assets

Content Profiler

Profiling Textures

Profiling Surfaces

Connections Between Assets

Upgrading Assets

Managing Packages

Version Control

Settings and Preferences

Editor Settings and Hotkeys

Render Settings

Visibility Distances

Global Illumination Settings

Subsurface Scattering

Dynamic Reflections

Occlusion Culling

Color Correction

Custom Post Materials

Debug Materials

Custom Composite Materials

Wireframe Color

Global Physics Settings

Global Sound Settings

Controls Settings

Working With Projects

Packing a Final Build for Publishing

Managing Worlds

Scene Navigation

Selecting and Positioning Nodes

Organizing Nodes

Node Dependencies

Exporting Nodes

Instancing Nodes

Adjusting Node Parameters

Transformation and Common Parameters

Visual Representation

Physics and Sound

Geo Coordinates

Setting Up Materials

Organizing Materials

Pre-Compiling Shaders

Setting Up Properties

Organizing Properties

Global Illumination

Bake Lighting Window

Environment Probes

Setting Up Cameras

Using Visual Debugging

Using Visual Helpers

Interface Overwiew

Creating Landscape

Adding Vegetation

Pipelines, Fences, Powerlines

Adding Buildings

Generating the Terrain and Objects

Sources and Their Parameters

Elevation and Imagery

Generation Settings

Distributed Generation and Headless Mode

Output Directories and Files

Questions and Answers

Using Editor Tools for Specific Tasks

Making Cutscenes: Animations & Camera 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

Generating Impostors with Impostors Creator

Editing Global Terrain

Editing Landscape Terrain

Mask Editor for Grass and Clutters

Brightness Tool

Saturation Tool

Replace Color Tool

Draw Mesh Data Tool

Ambient Occlusion Tool

Color Picker Tool

Extending Editor Functionality

Setting Up Environment

Creating Your First Editor Plugin

Managing Assets in Editor Plugins

VR Editor Plugin

UnigineEditor API

Plugins for 3D Editors

Plugins for 3ds Max

Plugins for Maya

Performance Profiling Tools

Performance Profiler

USC Interpreter

Runtimes Generator

Built-in Node Types

Nodes

Landscape Terrain

Landscape Layer Map

Configuring Details

Configuring Visualization and Performance

Importing Heightmaps

Import from World Creator 2

Import from Quadspinner GAEA

Import from World Machine

Import from Houdini

Import from Instant Terra

Global Terrain Details

Terrain for a FlightSim: Best Practices

Water

Grass

Tutorial: Adding Grass

Stars Generator for Billboards

Particle System

Particles Deflector

Particles Spacer

Volumetric Objects

Volume Projected

Fields

Field Animation

Field Shoreline

Physical Trigger

Projected Decal

Orthographic Decal

Light Sources Parameters

Projected Light

Environment Probe

Planar Reflection Probe

World Expression

World Spline Graph

Pathfinding Objects

Navigation Areas

Navigation Sector

Navigation Mesh

Obstacle Sphere

Obstacle Capsule

Player Persecutor

Player Spectator

Programming Overview

Engine Architecture

Execution Sequence

Application Logic System

Engine Initialization

Engine Main Loop

Engine Shutdown

Where to Put Your Code

Working with Smart Pointers

Accessing Nodes and Files via Properties

Matrix Transformations

Camera Matrices

Event Handling Callbacks

Setting Up Development Environment

Windows Development Environment

Linux Development Environment

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

A Car with Wheel Joints

Creating Mirrors Using Viewports (Rendering to Texture) or Materials

Creating A Simple Mechanism Using Joints

Navigation and Pathfinding

Creating Routes

Creating 2D Routes within Navigation Sector with Obstacles

Creating Routes within Connected Navigation Sectors

Creating Pylons and Wires Using Ropes

Enabling Selective Surface-Based Collision

Playing Sounds on Collisions

Working with Console

Splitting Logic Between Several WorldLogic Classes

Using Manipulators to Transform Objects

Making Screenshots at Runtime

Handling Contacts on Collision

Controlling Sound Sources Globally

Making a First-Person Shooter (C#)

C++

Creating C++ Application

Creating C++ Plugin

C++ Integration Samples

Integrating with Frameworks

Unigine Integration into Qt Application

C++ Usage Examples

Extending UnigineScript

Library's Namespace

Variable Export

Constant Export

Function Export

Data Structure Export

UnigineScript Containers

C#

Creating C# Application

Debugging C# Components

Garbage Collector

C# API Reference

C# Integration Samples

Integrating with Frameworks

C# Usage Examples

C# Component System

Extending UnigineScript

UnigineScript Containers

Variable Export

Creating UnigineScript Application

Adding Scripts to the Project

Structure of a Program

Control Statements

Selection Statements

Iteration Statements

Jump Statements

Other Statements

Scope. Namespaces

Object Oriented Programming

Interface Class

Preprocessor Directives

Language Features

System Functions

String Global Functions

Script Debugging

Handling Ownership When Using Scripts

High-Level Systems

UnigineScript Basic Utilities

Unigine::Widgets

User Interfaces for Unigine::Widgets

Objects

app_surround_00

UUSL (Unified UNIGINE Shader Language)

UUSL Common Intrinsic Functions

UUSL GBuffer Structure

UUSL Parameters

UUSL Textures and Buffers

UUSL Tessellation

UUSL Color Spaces

UUSL Pack Utils

UUSL Compute Shaders

Creating a Custom Shader for Post-Processing

ARTTRACK Plugin

FbxImporter Plugin

CadImporter Plugin

Setting Up Projections with AppEasyBlend Plugin

GeodeticsPlugin

GPU Monitoring with GPUMonitor Plugin

LeapMotion Plugin

Ultraleap Plugin

Syncker-Specific Options

Configuring Screens and Projections

Implementing Syncker Logic for a Custom Project

Teslasuit Plugin

Unigine Language Object Notation

Mesh File Formats

Materials Files

XML Base Material File Format

ULON Base Material File Format

User Material File Format

Property File Format

Spline File Format

Materials and Shaders

Abstract Materials

Mesh Transparent

Startup Command-Line Options

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

Window Management

Loading and Splash Screens

Double Precision Coordinates

Performance Analyzer

TCP/UDP Port Numbers

API

Animations-Related Classes

AnimationBind Class

AnimationBindMaterial Class

AnimationBindNode Class

AnimationBindPropertyParameter Class

AnimationBindRuntime Class

AnimationCurve Class

AnimationCurveBool Class

AnimationCurveDouble Class

AnimationCurveFloat Class

AnimationCurveInt Class

AnimationCurveQuat Class

AnimationCurveScalar Class

AnimationCurveString Class

AnimationCurveUGUID Class

AnimationFrame Class

AnimationMask Class

AnimationModifier Class

AnimationModifierBones Class

AnimationModifierBool Class

AnimationModifierDVec2 Class

AnimationModifierDVec3 Class

AnimationModifierDVec4 Class

AnimationModifierDouble Class

AnimationModifierFVec2 Class

AnimationModifierFVec3 Class

AnimationModifierFVec4 Class

AnimationModifierFloat Class

AnimationModifierIVec2 Class

AnimationModifierIVec3 Class

AnimationModifierIVec4 Class

AnimationModifierInfo Class

AnimationModifierInt Class

AnimationModifierMat4 Class

AnimationModifierNode Class

AnimationModifierQuat Class

AnimationModifierScalar Class

AnimationModifierString Class

AnimationModifierTrack Class

AnimationModifierUGUID Class

AnimationModifierVec2 Class

AnimationModifierVec3 Class

AnimationModifierVec4 Class

AnimationObject Class

AnimationObjectMaterial Class

AnimationObjectNode Class

AnimationObjectPropertyParameter Class

AnimationObjectRuntime Class

AnimationObjectTrack Class

AnimationPlayback Class

AnimationTrack Class

Animations Class

Container Functions

ArrayMap Classes

ArrayMap::Iterator Class

ArrayVector Class

Tree::ConstIterator Class

Tree::Iterator Class

Vector::ConstIterator Class

Vector::Iterator Class

VectorStack Class

Common Functionality

ScopedLock Class

ScopedReaderLock Class

ScopedReentrantLock Class

ScopedWriterLock Class

BackoffSpinner Class

ReentrantMutex Class

Callback-Related Classes

CallbackBase Class

CallbackBase1 Class

CallbackBase2 Class

CallbackBase3 Class

CallbackBase4 Class

CallbackBase5 Class

Event-Related Classes

EventConnection Class

EventConnections Class

Checksum-Related Classes

ConsoleVariableFloat Class

ConsoleVariableInt Class

ConsoleVariableString Class

ConsoleVariableVec2 Class

ConsoleVariableVec3 Class

ConsoleVariableVec4 Class

Expression Class

ExternClass Class

FunctionBase Class

File Import Classes

ImportAnimation Class

ImportCamera Class

ImportGeometry Class

ImportLight Class

ImportMaterial Class

ImportMesh Class

ImportNode Class

ImportProcessor Class

ImportScene Class

ImportSurface Class

ImportTexture Class

FBX Export Classes

ImageConverter Class

Interpreter Class

EditorLogic Class

SystemLogic Class

WorldLogic Class

Component System Classes

C++

ComponentBase Class

ComponentSystem Class

ComponentVariable Class

C#

Component Class

ComponentSystem Class

AssetLink Class

AssetLinkNode Class

PropertyParameter Class

Reflection Class

StringArray Class

StringPtr Class

StringStack Class

UlonValue Class

Unigine Namespace Items

Controls-Related Classes

ControlsApp Class

ControlsDummy Class

InputEvent Class

InputEventKeyboard Class

InputEventMouseButton Class

InputEventMouseMotion Class

InputEventMouseWheel Class

InputEventVRAxisMotion Class

InputEventVRButton Class

InputEventVRButtonTouch Class

InputEventVRDevice Class

InputEventSystem Class

InputEventText Class

InputEventTouch Class

InputEventJoyDevice Class

InputEventJoyButton Class

InputEventJoyAxisMotion Class

InputEventJoyPovMotion Class

InputEventPadButton Class

InputEventPadDevice Class

InputEventPadAxisMotion Class

InputEventPadTouchMotion Class

InputGamePad Class

InputJoystick Class

InputVRBaseStation Class

InputVRController Class

InputVRDevice Class

InputVRHead Class

InputVRTracker Class

Engine-Related Classes

BootConfig Class

CustomSystemProxy Class

EnginePtr Class

engine.system Functions

EnginePlugins Class

GameIntersection Class

LoadingScreen Class

Properties Class

SystemDialog Class

SystemInfo Class

UserConfig Class

Visualizer Class

Filesystem Functionality

FileSystem Class

FileSystemAssets Class

FileSystemMount Class

AsyncQueue Class

File System Functions

PackageUng Class

GUI-Related Classes

UserInterface Class

EngineWindow Class

EngineWindowGroup Class

EngineWindowViewport Class

WindowManager Class

WindowEvent Class

WindowEventDpi Class

WindowEventDrop Class

WindowEventGeneric 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

WidgetHitTestArea 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

Math Functionality (C#)

Geometry Class (C#)

Math Common Functions (C#)

Math 2D Functions (C#)

Bounds-Related Classes (C#)

BoundBox Struct (C#)

BoundFrustum Struct (C#)

BoundSphere Struct (C#)

WorldBoundBox Struct (C#)

WorldBoundFrustum Struct (C#)

WorldBoundSphere Struct (C#)

Random Struct (C#)

Bits8 Struct (C#)

Bits16 Struct (C#)

Bits32 Struct (C#)

Bits64 Struct (C#)

bvec4 Struct (C#)

dmat4 Struct (C#)

dvec2 Struct (C#)

dvec3 Struct (C#)

dvec4 Struct (C#)

ivec2 Struct (C#)

ivec3 Struct (C#)

ivec4 Struct (C#)

mat2 Struct (C#)

mat3 Struct (C#)

mat4 Struct (C#)

quat Struct (C#)

vec2 Struct (C#)

vec3 Struct (C#)

vec4 Struct (C#)

Math Functionality (C++)

Predefined Constants

Auxiliary Types

Bounds-Related Classes (C++)

BoundBox Struct

BoundFrustum Struct

BoundSphere Struct

WorldBoundBox Struct

WorldBoundFrustum Struct

WorldBoundSphere Struct

Math Common Functions

Math 2D Functions

Math Exponential Functions

Math Matrix Functions

Math Trigonometrical Functions

BitStream Class

ConcaveConvexCompare Class

Node-Related Classes

NodeAnimationPlayback Class

NodeDummy Class

NodeExtern Class

NodeExternBase Class

NodeLayer 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

GeodeticPivot Class

GeodeticsTransformer Class

Lights-Related Classes

BakeLighting Class

LightEnvironmentProbe Class

LightVoxelProbe Class

LightPlanarProbe 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

ObjectLandscapeTerrain Classes

ObjectLandscapeTerrain Class

TerrainDetail Class

TerrainDetailMask Class

Landscape Class

LandscapeLayerMap Class

LandscapeMapFileCreator Class

LandscapeMapFileCompression Class

LandscapeMapFileSettings Class

LandscapeFetch Class

LandscapeImages Class

LandscapeTextures Class

ObjectMeshStatic Class

ObjectMeshCluster Class

ObjectMeshClutter Class

ObjectMeshDynamic Class

ObjectMeshSkinned Class

BonesRetargeting Class

ObjectMeshSplineCluster Class

ObjectParticles Class

ParticleModifier Class

ParticleModifierScalar Class

ParticleModifierVector Class

ParticlesField Class

ParticlesFieldDeflector Class

ParticlesFieldSpacer Class

ObjectSky 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

WorldClutter Class

WorldExpression Class

WorldExternBase Class

WorldExtern Class

WorldIntersection Class

WorldIntersectionNormal Class

WorldIntersectionTexCoord Class

WorldOccluder Class

WorldOccluderMesh Class

WorldSplineGraph Class

SplineGraph Class

SplinePoint Class

SplineSegment Class

WorldSwitcher Class

WorldTransformBone Class

WorldTransformPath Class

WorldTrigger Class

Networking Functionality

SSLSocket Class

Pathfinding-Related Classes

Navigation Class

NavigationMesh Class

NavigationSector Class

ObstacleBox Class

ObstacleCapsule Class

ObstacleSphere Class

PathRoute Class

PathRouteIntersection Class

Physics-Related Classes

ShapeContact Class

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

GPUMonitor Plugin

GPUMonitor Class

GPUMonitorPlugin Class

EasyBlend Class

Projection Class

engine.surround Functions

ARTTracker Class

DISConnector Plugin

DIS::Connector Class

HLAConnector Plugin

HLA::Connector Class

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

CigiEnvironmentPolygonControl 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

IG Manager Class

Component Class

ComponentBaseInterface

IGIntersection Structure

ArticulatedPart Class

CollisionSegment Class

CollisionVolume Class

Converter Class

LightController Class

MeteoCameraEffects Class

MeteoPositionParam Structure

SymbolsController Class

SymbolsPlane Class

SymbolPolyline Class

SymbolCircle Class

SymbolText Class

ViewGroup Class

WeatherLayer Class

WeatherLayerCloud Class

WeatherLayerPrecipitation Class

ChannelGroup Class

EventDescription Class

EventInstance Class

FMODEnums Class

FMODStructs Class

FMODStudio Class

LeapMotion Plugin

LeapMotion Class

Ultraleap Plugin

Ultraleap Class

UltraleapDevice Class

UltraleapArm Class

UltraleapBone Class

UltraleapFinger Class

UltraleapHand Class

SteamLeaderboard Class

Projections Class

Teslasuit Plugin

TeslaSuitGeneral Class

SuitManager Class

VrpnClient Class

VrpnAnalogDevice Class

VrpnButtonDevice Class

VrpnTrackerDevice Class

Rendering-Related Classes

EngineExpression Class

Materials Class

MeshDynamic Class

MeshStatic Class

Primitives Class

RenderEnvironmentPreset Class

RenderState Class

RenderTarget Class

ResourceFence Class

ResourceExternalMemory Class

CPUShader Class

StructuredBuffer Class

TextureRamp Class

VR-Related Classes

VREyeTracking Class

VRMixedReality Class

VRMarkerObject Class

UnigineEditor Classes

VR & XR Development

VR Input System

VR Console Commands and Variables

VR API Reference

VR Best Practices

Getting Started with VR

Classes and Components Overview

Content Creation

3D Models Requirements

Art Assets Conversion

Content Optimization

Geometry Optimization

Working with Large Number of Objects

Setting Up LODs

Using Impostors

Switching Nodes On and Off

Occlusion Culling

Optimizing Grass

Textures Optimization

Lights Optimization

Dynamic Reflections Optimization

Water Optimization

Terrain Optimization

Physics Optimization

VR Best Practices

Hierarchy and Inheritance

Material Editor

Material Samples

Blackbody Sample

Blend By Height Sample

Cubemap Texture Sample

Custom Code Sample

Custom Subgraphs Sample

Displacement Sample

Dissolve Sample

Energy Shield Sample

Fade By Depth Sample

Fresnel Effect Sample

Hair Shading Sample

Interior Mapping Sample

Multi-Layered Material Sample

Normal From Height Texture Sample

Normal From Height Value Sample

Object-Space Normal Map Sample

Tangent-Space Normal Map Sample

Procedural Tiles Sample

Ramp Texture Sample

UV Tiling and Offset Sample

Vertex Animation Sample

Vertex Color Sample

Reparent to Graph Material

Material Nodes Library

Portal Out Node

Expression Node

Loop Begin Node

Rotate Space Node

Transform Space Node

Compose Float2 Node

Compose Float3 Node

Compose Float4 Node

Compose Int2 Node

Compose Int3 Node

Compose Int4 Node

Compose Float By Exponent Node

Decompose Float By Exponent Node

Color Saturation Node

Flowmap Panner Node

Flowmap Panner Simple Node

RGB To Luma Node

HUE To RGB Node

RGB To HCV Node

RGB To HSV Node

HSV To RGB Node

RGB To HCY Node

HCY To RGB Node

RGB To HCL Node

HCL To RGB Node

RGB To HSL Node

HSL To RGB Node

RGB To YUV Node

YUV To RGB Node

RGB To YCbCr Node

YCbCr To RGB Node

RGB To YCgCo Node

YCgCo To RGB Node

Srgb Inverse Node

Screen UV To View Direction Node

Position to Screen UV Node

Fast Position To Screen Uv Node

Depth To Position Node

Reorient Normal Blend Node

Reorient Vector Blend Node

Normal Reconstruct Z Node

Position to Normal Node

Specular to Metalness Node

Calc Mip Level Node

Calculate TBN Node

Normalization TBN Node

Normal To TBN Node

Parallax Occlusion Mapping Node

Parallax Simple Node

Face Forward Node

Vertex Interpolation Node

Pack Unit Vector To Octahedron Node

Unpack Octahedron To Unit Vector Node

Pack 1212 To 888 Node

Pack 888 To 1212 Node

Pack 88 To 16 Node

Pack 16 To 88 Node

Pack 44 To 8 Node

Pack 8 To 44 Node

Pack 1616 To 8888 Node

Pack 8888 To 1616 Node

Refraction Simple For Thick Objects Node

Refraction Screen UV Offset For Thick Objects Node

Refraction Simple For Thin Objects Node

Refraction Screen UV Offset For Thin Objects Node

Refraction Raymarched Node

Reflection Simple Node

Reflection Raymarched Node

HDRI Raymarched Node

SSAO Raymarched Node

SSGI Raymarched Node

Specular Ambient Occlusion Node

Screen Space Subsurface Scattering Node

Triplanar Color Node

Triplanar Normal Node

Blend By Height Node

Blend By Height Simple Node

Tiling and Offset Node

Normal From Height Value Node

Normal From Height Texture Node

Depth Fade Node

Interior Mapping Texture 2D Node

Interior Mapping Cubemap Node

Fresnel PBR Node

Tree Animation Node

Grass Animation Node

Animation Time Node

Animation Old Time Node

Get Vector From Basis Node

Angle Between Vectors Node

Anisotropic Specular Brdf Node

Hair Shading Node

Ggx Brdf Importance Sampling Node

Replace Color Node

Float Correction By Ramp Node

Color Correction By Ramp Node

Input

Is Auxiliary Pass Node

Is GBuffer Pass Node

Is Shadow Pass Node

Is Baking GI Node

Is Lightmap Node

Is Front Face Node

View Direction Node

Camera Direction Node

Camera Offset Node

Camera Position Node

Camera Near Node

Camera Far Node

Camera INear Node

Camera IFar Node

Matrix Projection Node

Matrix IProjection Node

Matrix Camera Projection Node

Matrix Camera IProjection Node

Matrix Modelview Node

Matrix IModelview Node

Matrix Old Modelview Node

Matrix Old IModelview Delta Node

Matrix Old IModelview Node

Oblique Frustum Plane Node

Screen Resolution Node

Screen IResolution Node

Screen Coord Node

Vertex Tangent Node

Vertex Binormal Node

Vertex Normal Node

Vertex Color Node

Vertex Position Node

Vertex Depth Node

Vertex UV 0 Node

Vertex UV 1 Node

Instance ID Node

Material Mask Node

Vertex Front Face Node

Object Position Node

Object Scale Node

Sun Direction Node

Moon Direction Node

Color (Float3) Node

Color (Float4) Node

Game Scale Node

Logical

Less Or Equal Node

Greater Or Equal Node

Logical And Node

Logical Or Node

Logical Negative Node

Bits Negative Node

Bits Shift Left Node

Bits Shift Right Node

Check Range Node

Decal Distance Fade Gradient Node

Decal Material Mask Node

Decal Matrix Projection Node

Decal Matrix IProjection Node

Decal Plane Node

Decal Projected Normal Node

Decal Projected Position Node

Decal Radius Node

Decal Scene Material Mask Node

Decal Scene Normal Node

Decal Scene Position Node

Math

DDX Coarse Node

DDY Coarse Node

Base-E Logarithm Node

Base-2 Logarithm Node

Base-10 Logarithm Node

Base-2 Exponential Node

Base-E Exponential Node

Divide Int Node

Reciprocal Node

Maximum Possible Float Node

Maximum Possible Half Node

Maximum Possible Int Node

Minimum Possible Float Node

Minimum Possible Int Node

Square Root Node

Reciprocal Square Root Node

Multiply And Add Node

Smooth Step Node

Length Squared Node

Dot Product Node

Lerp Contrast Preserving Node

Inverse Lerp Node

Golden Ratio Node

Reverse Bits Node

Is Infinity Node

First Bit High Node

First Bit Low Node

Matrix

Compose Matrix2 By Column Node

Compose Matrix2 By Row Node

Compose Matrix3 Node

Compose Matrix3 By Column Node

Compose Matrix3 By Row Node

Compose Matrix4 Node

Compose Matrix4 By Column Node

Compose Matrix4 By Row Node

Get Matrix Column Node

Get Matrix Row Node

Get Matrix Value Node

Set Matrix Column Node

Set Matrix Row Node

Set Matrix Value Node

Determinant Node

Orthonormalize Node

Inverse Transform Node

Decompose Euler Node

Rotate Euler Node

Rotate Axis Node

Decompose Transform Node

Compose Transform Node

Matrix Multiply 3x3 Node

Matrix Multiply 4x4 Node

Perspective Node

Cube Transform Node

Matrix Object To Absolute World Node

Matrix Object To Camera World Node

Matrix Object To View Node

Matrix View To Object Node

Matrix View To Absolute World Node

Matrix View To Camera World Node

Matrix Absolute World To View Node

Matrix Absolute World To Object Node

Matrix Camera World To View Node

Matrix Camera World To Object Node

ArcTangent Node

2-Argument ArcTangent Node

Hyperbolic Cosine Node

Hyperbolic Sine Node

Hyperbolic Tangent Node

Degrees To Radians Node

Radians To Degrees Node

Light Map Texture Node

Surface Custom Texture Node

Texture 2D Node

Texture 2D Array Node

Texture 2D Int Node

Texture 3D Node

Texture Cube Node

Sample Texture Node

Texture Resolution Node

Texture Buffer GBuffer Albedo Node

Texture Buffer GBuffer Normal Node

Texture Buffer GBuffer Shading Node

Texture Buffer GBuffer Velocity Node

Texture Buffer Curvature Node

Texture Buffer Auxiliary Node

Texture Buffer Depth Node

Texture Buffer Depth Opacity Node

Texture Buffer Depth Opacity Fast Node

Texture Buffer Direct Lights Node

Texture Buffer Indirect Lights Node

Texture Buffer Indirect Diffuse Final Node

Texture Buffer Indirect Specular Final Node

Texture Buffer Screen Color Node

Texture Buffer Screen Color Old Node

Texture Buffer Screen Color Old Reprojection Node

Texture Buffer Screen Color Opacity Node

Texture Buffer Clouds Screen Node

Texture Buffer GBuffer Material Mask Node

Texture Buffer Normal Fast Node

Texture Buffer Refraction Node

Texture Buffer Refraction Mask Node

Texture Buffer SSAO Node

Texture Buffer SSGI Node

Texture Buffer SSR Node

Texture Buffer Transparent Blur Node

Texture Buffer Auto Exposure Node

Texture Buffer Auto White Balance Node

Texture Buffer Bent Normal Node

Texture Buffer DOF Mask Node

Texture Ramp R Node

Texture Ramp RG Node

Texture Ramp RGB Node

Texture Ramp RGBA Node

Bayer Noise Node

Blue Noise Node

Blue Noise TAA Node

Blue Noise 256x256 Static Node

Blue Noise 256x256 Animated Node

Blue Noise Temporal Node

Vogel Disk Node

Hammersley Node

Alpha Fade Noise TAA Node

Checker Noise Node

Fibonacci Sphere Node

Fibonacci Hemisphere Node

Built-in Base Materials

billboards_base

billboards_cloud_base

billboards_impostor_base

decal_terrain_hole_base

grass_impostor_base

landscape_terrain_base

landscape_terrain_detail_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

water_mesh_base

Postprocess Materials

Debug Materials

debug_materials

Custom Materials

Scriptable Materials

Animated Character

Camera Effects and Color Correction

Car Visualization

Custom Post Effects

World Spline Graph

Material Examples

Materials Hierarchy

Multi-layered Material

Retroflective Shading

Subsurface Scattering

Transparent Materials

Triplanar Mapping

Unlit Materials

Global Illumination

Adding Morph Targets

Vegetation: Authoring Tips

Creating Weather Effects

Cloud and Container Deployment

Docker Container Configuration

Running UNIGINE-Based Application in Docker Container

Developing UNIGINE-Project in Docker Container

Upgrading to UNIGINE 2.18.1

Console Migration

Content Migration

IG Configuration

Environment Settings

Entity-Related Properties

Creating Custom Components

Processing User-Defined Packets

Debugging IG Application

IG Editor Plugin

VR-Based IG Template

Troubleshooting

SDK Browser Issues

UnigineEditor Issues

Application Crashes

Antivirus Recommendations

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.

No language code for this page. You can select other language.

No language code for this page,
shown in other instead.

Video Tutorials
Interface
SDK Browser Interface

Video Tutorial: SDK Browser Interface Overview

NoticeSubtitles are available for each tutorial in English, Russian, and Chinese.

Beginners
Artists
Editor
Interface
SDK Browser
Tutorial

Warning

The tutorial is deprecated.

In this tutorial:

Signing in
Downloading and installing SDK
Activating SDK
Browser settings
Creating a new project
Opening Editor and IDE
Running a project
Using the content of Add-Ons
Running Demos
Documentation, forum and support

Last update: 2024-04-19

Help improve this article

Was this article helpful?

0 out of 0 users found it helpful

Report a problem related to this article

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

You have already voted

What kind of problem related to this article would you like to report?

Type :

Details *:

UNIGINE © 2005-2024. All rights reserved. Our Privacy Policy Terms

Login

Email:

Password:

Forgot your password?

We use cookies to ensure that we give you the best experience on our website. Click here for more information.

Got it