Forum
Docs (2.3) 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

Project Workflow

Basic Tutorial: Importing FBX Model

Hardware Requirements

Principles of Operation

Virtual World Structure

World Management

Rendering Sequence

Temporal Anti-Aliasing

Hiding Shading Artifacts with AppBorder Plugin

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

ARTTRACK Add-On

Game Framework Add-On

LVC Game Add-On

Perception Neuron Add-On

Tutorials Content Add-On

Vegetation Add-On

Managing Worlds

Scene Navigation

Setting Up Cameras

Importing Nodes

Selecting and Positioning Nodes

Organizing Nodes

Exporting Nodes

Rendering Settings

Setting Up Materials

Setting Up Properties

Setting Up Physics

Terrain Grabber

LUT Generation Tool

Collada Import Plugin

OpenFlight Import Plugin

Importing Large Populated Areas with City Import Plugin

Making Environment Look Realistic with Randomizer Plugin

Exporting Nodes with Node Export Plugin

Baking Meshes into One Mesh with Mesh Combiner Plugin

Creating Large Terrains with Landscape Plugin

Interface Plugin

Making Custom Editor Plugins

Plugins for 3D Editors

Plugins for 3ds Max

Plugins for Maya

Performance Profiling Tools

Performance Profiler

USC Interpreter

Built-in Node Types

Nodes

Terrain Material

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

Matrix Transformations

Setting Up Development Environment

Windows Development Environment

Linux Development Environment

OS X Development Environment

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

String Global Functions

Script Debugging

High-Level Systems

UnigineScript Basic Utilities

Unigine::Widgets

User Interfaces for Unigine::Widgets

Unigine::Schemer

Unigine::Skinner

Unigine::Tracker

Parameters Tracks

How-Tos for Tracker

Running Tracker in Game

Unigine::Syncker

Syncker-Specific Options

Running Syncker for a Custom Project

Running Syncker with AppProjection

Unigine::Syncker::Master Functions

Character System

Function Library

Framework System Script

MasterGame Class

Framework World Script

EntityData Class

LevelData Class

Run-Time Classes

EntityPool Class

LogicModules Class

Scheduler Class

FrequencyGroup Class

EventSystem Class

GameEvent Class

GameCallback Class

Cars

Importing Cars to City Traffic

Adding Materials to Cars

Traffic Manager

app_surround_00

app_surround_01

Working with Console

Creating Routes

Basic Object Movements

C++

Creating C++ Application

Creating C++ Plugin

Integration Samples

Unigine Integration into SDL Application

Unigine Integration into Qt Application

Library's Namespace

Variable Export

Constant Export

Function Export

Data Structure Export

UnigineScript Containers

CIGI Protocol Support via CigiClient Plugin

Secure SSL Connection via SSLSocket Plugin

GPU Monitoring with GPUMonitor Plugin

Renderer Customization via Renderer 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

Creating of Custom Shader for Deferred Rendering Pass

Creating of Custom Shader for Forward Rendering Pass

Creating of Custom Shader for Post-Processing

Mesh File Formats

Material File Format

Startup Command-Line Options

Configuration File

Rebuilding the Engine and Tools

Rebuild in Windows via Visual Studio

Rebuild in OS X via Xcode

Semi-automatic Compilation with Build Script

Manual Compilation with SCons

Preprocessor Macros for Rebuilding the Engine

Rebuild Qt Libraries

Protecting Your Data with a Password

GUI

Double Precision Coordinates

Performance Analyzer

How to Generate Shaders Cache

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

Interpreter Class

EditorLogic Class

SystemLogic Class

WorldLogic Class

Reflection Class

System Functions

Unigine Namespace Items

Controls-Related Classes

ControlsApp Class

ControlsDummy Class

ControlsJoystick Class

ControlsSixAxis

ControlsXPad360 Class

Engine-Related Classes

EngineEditor Class

EnginePtr Class

EngineWorld Class

engine.system Functions

EnginePlugins Class

GameIntersection Class

Properties Class

Visualizer Class

Filesystem Functionality

Filesystem 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

Bounds-Related Classes

BoundFrustum Class

BoundSphere Class

WorldBoundBox Class

WorldBoundFrustum Class

WorldBoundSphere Class

Math Common 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

Geodetics-Related Classes

Ellipsoid Class

GeodeticPivot Class

Lights-Related Classes

LightEnvironmentProbe Class

LightOmni Class

LightProj Class

LightWorld Class

Objects-Related Classes

ObjectBillboards 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

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

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

AutodeskImport Class

ColladaImport Class

OpenFlightImport Class

engine.border Functions

engine.grabber Functions

engine.kinect Functions

engine.oculus Functions

engine.projection Functions

engine.surround Functions

engine.vive Functions

engine.wall Functions

Interface Plugin

InterfaceWindow Class

Engine Interface Class

VrpnAnalogDevice Class

VrpnButtonDevice Class

VrpnTrackerDevice Class

Rendering-Related Classes

Materials Class

RenderState Class

TextureRender Class

Content Creation

Content Pipeline

3D Models Requirements

Art Assets Conversion

Content Optimization

Hierarchy and Inheritance

Material Library

billboards_base

billboards_cloud_base

billboards_impostor_base

grass_impostor_base

Physically Based Materials

render_composite

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_antialiasing

post_filter_reflection

post_filter_rgb2rgbl

post_filter_rgb2yuv

post_filter_scattering

post_filter_sobel

post_filter_wet

post_hblur_mask

post_vblur_mask

post_hblur_cube and post_vblur_cube

Custom Materials

Adding Morph Targets

Setting Up Object LODs

Adding Sun, Sky and Clouds

Adding Impostors to Clutters

Port Angeles Workflow

Port Angeles Setups

Migrating to UNIGINE 2.3

Console Migration

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.

API
Engine-Related Classes
EngineEditor Class

EngineEditor

List of functions:

void set(string function, Variable value)
Variable get(string function)
Variable call(Variable function)
Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2)
Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2, Variable arg3, Variable arg4, Variable arg5)
Variable call(Variable function, int id = [])
Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2, Variable arg3, Variable arg4)
Variable call(Variable function, Variable arg0, Variable arg1)
Variable call(Variable function, Variable arg0)
Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2, Variable arg3)

EngineEditor Class

Members

void set(string function, Variable value)

Arguments

string function
Variable value

Variable get(string function)

Arguments

string function

Variable call(Variable function)

Arguments

Variable function

Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2)

Arguments

Variable function
Variable arg0
Variable arg1
Variable arg2

Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2, Variable arg3, Variable arg4, Variable arg5)

Arguments

Variable function
Variable arg0
Variable arg1
Variable arg2
Variable arg3
Variable arg4
Variable arg5

Variable call(Variable function, int id = [])

Arguments

Variable function
int id

Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2, Variable arg3, Variable arg4)

Arguments

Variable function
Variable arg0
Variable arg1
Variable arg2
Variable arg3
Variable arg4

Variable call(Variable function, Variable arg0, Variable arg1)

Arguments

Variable function
Variable arg0
Variable arg1

Variable call(Variable function, Variable arg0)

Arguments

Variable function
Variable arg0

Variable call(Variable function, Variable arg0, Variable arg1, Variable arg2, Variable arg3)

Arguments

Variable function
Variable arg0
Variable arg1
Variable arg2
Variable arg3

Last update: 2017-07-03

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