Forum
Docs (2.14.1)

Select Your Language

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

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
Македонски
Български

Sign in

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

Georeferenced Terrain Generation

Arbitrary Terrain Generation

Content Optimization

Performance Inspection with Microprofile

Procedural Texturing

Audio Sources and Sound Effects

C# Component System

Landscape Terrain

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

Create a Final Build for a C# Project

Configure Levels of Detail (LODs)

Delete Unused Assets from the Final Build

Transfer Assets to Another Project

Print User Messages to Console with C#

Access Assets from C# Components

Access Nodes from C# Components

Create C# (.NET Core) 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

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

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 AppSeparate Plugin

Quad Buffered Stereo Support

Oculus Rift Output with AppOculus Plugin

HTC Vive Output with AppVive Plugin

Varjo Output with AppVarjo 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

Asynchronous Data Streaming

Managing Company Accounts and Licenses

Add-Ons

Eastern European Countryside

Industrial Assets

Road Tool Constructor

Arbitrary Terrain Generation

Georeferenced Terrain Generation

Demos

C# Component Samples

CharacterController

World Intersection

C# Third Person Platformer

Procedural City Generation

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

Texture Profiler

Connections Between Assets

Version Control

Settings and Preferences

Editor Settings and Hotkeys

Render Settings

Visibility Distances

Global Illumination

Subsurface Scattering

Dynamic Reflections

Occlusion Culling

Color Correction

Screen-Space Materials

Global Physics Settings

Global Sound Settings

Controls Settings

Working With Projects

Building a Project

Managing Worlds

Scene Navigation

Selecting and Positioning Nodes

Organizing Nodes

Exporting Nodes

Instancing Nodes

Adjusting Node Parameters

Transformation and Common Parameters

Visual Representation

Physics and Sound

Setting Up Materials

Organizing Materials

Forced Shader Compilation

Setting Up Properties

Organizing Properties

Global Illumination

Bake Lighting Window

Environment Probes

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

Starting with Sandworm

Adding Source Data

Pipelines, Fences, Powerlines

Output Settings

Generating the Landscape and Objects

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

Extending Editor Functionality

Creating Your First Editor Plugin

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

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

Creating a Car with Wheel 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

Splitting Logic Between Several WorldLogic Classes

Using Manipulators to Transform Objects

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

app_surround_01

C++

Creating C++ Application

Creating C++ Plugin

Integration Samples

Unigine Integration into Qt Application

C++ Usage Examples

CustomApp Class

Extending UnigineScript

Library's Namespace

Variable Export

Constant Export

Function Export

Data Structure Export

UnigineScript Containers

ARTTRACK Plugin

FbxImporter Plugin

CadImporter Plugin

Setting Up Projections with AppEasyBlend Plugin

GeodeticsPlugin

GPU Monitoring with GPUMonitor Plugin

LeapMotion Plugin

Secure SSL Connection via SSLSocket Plugin

Syncker-Specific Options

Configuring Screens and Projections

Implementing Syncker Logic for a Custom Project

Teslasuit Plugin

C#

Creating C# Application

Debugging C# Components

Garbage Collector

C# API Reference

C# Integration Samples

Application with Direct3D11 via SharpDX Library

Application with OpenGL via OpenTK Library

C# Usage Examples

C# Component System

Extending UnigineScript

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

Unigine Language Object Notation

Mesh File Formats

Materials Files

Base Material File Format

User Material File Format

Property File Format

Spline File Format

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

Loading and Splash Screens

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

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

ConsoleVariableFloat Class

ConsoleVariableInt Class

ConsoleVariableString Class

Expression Class

ExternClass Class

FunctionBase Class

File Import Classes

Data Structures

ImportProcessor Class

ImportScene Class

FBX Export Classes

ImageConverter Class

Interpreter Class

EditorLogic Class

SystemLogic Class

WorldLogic Class

Component System Classes

C++

ComponentBase Class

ComponentSystem 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

ControlsJoystick Class

ControlsSixAxis

ControlsXPad360 Class

InputGamePad Class

Engine-Related Classes

BootConfig Class

CustomApp 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

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

WidgetSpinBoxDouble 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

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

LandscapeMapFilesettings Class

LandscapeFetch Class

LandscapeImages Class

LandscapeTextures Class

ObjectMeshStatic Class

ObjectMeshCluster Class

ObjectMeshClutter Class

ObjectMeshDynamic Class

ObjectMeshSkinned Class

ObjectMeshSplineCluster Class

ObjectParticles Class

ParticleModifier Class

ParticleModifierScalar Class

ParticleModifierVector 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

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

AppEasyBlend Class

OpenFlightImport Class

AppOculus Class

AppProjection 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

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

ComponentBaseInterface

IG Manager Class

ArticulatedPart Class

CollisionSegment Class

CollisionVolume Class

Component Class

Converter Class

ViewGroup Class

LightController Class

SymbolsController Class

SymbolsPlane Class

SymbolPolyline Class

SymbolCircle Class

SymbolText Class

IGIntersection Structure

Interface Plugin

InterfaceWindow Class

Interface Class

LeapMotion Plugin

LeapMotion Class

LeapMotionArm Class

LeapMotionBone Class

LeapMotionFinger Class

LeapMotionHand Class

SSLSocket Plugin

SSLSocket Class

SSLSocketPlugin Class

SteamLeaderboard Class

Projections Class

Teslasuit Plugin

TeslaSuitGeneral Class

SuitManager Class

VrpnAnalogDevice Class

VrpnButtonDevice Class

VrpnTrackerDevice Class

Rendering-Related Classes

EngineExpression Class

Materials Class

MeshDynamic Class

MeshStatic Class

Primitives Class

RenderEnvironmentPreset Class

RenderContext Class

RenderState Class

RenderTarget Class

CPUShader Class

StructuredBuffer Class

TextureCurve Class

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

Lights Optimization

Dynamic Reflections Optimization

Water Optimization

Terrain Optimization

Physics Optimization

VR Best Practices

Hierarchy and Inheritance

Material Editor (Experimental)

Material Samples

Alpha Blend Sample

Alpha Test Sample

Chameleon Sample

Cubemap Texture Sample

Custom Code Sample

Custom Subgraphs Sample

Displacement Sample

Energy Shield Sample

Fresnel Effect Sample

Make Float Sample

Multiple Materials Blending Sample

Object-Space Normal Map Sample

Tangent-Space Normal Map Sample

Parallax Occlusion Sample

Simple PBR Material Sample

Snow Effect Sample

Texture 2D Sample

Triplanar Sample

UV Panner Sample

UV Tiling and Offset Sample

Vertex Color Sample

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

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

Scriptable Materials

Animated Character

Global Illumination

World Spline Graph

Adding Morph Targets

Upgrading to UNIGINE 2.14.1

Content Migration

IG Configuration

Environment Settings

Entity-Related Properties

Creating Custom Components

Processing User-Defined Packets

Debugging IG Application

Troubleshooting

SDK Browser Issues

UnigineEditor Issues

Third-Party Notices

Table of Contents

This version of documentation is OUTDATED! Please switch to the latest one.

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

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

API
Common Functionality
File Import Classes

File Import Functionality Classes

Warning

The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Engineering / Sim SDK edition to use it.

This section contains a set of basic classes implementing file import functionality. The whole Import System is controlled via the import manager class - Import Class.

See Also#

The Import System article for more details on the Import System
The Custom Import Plugin usage example demonstrating how to use file import classes
The Importing Models Directly to Memory usage example to learn the basics of writing your own custom import processor.

Articles in This Section

Data Structures

Import Class

Importer Class

ImportProcessor Class

ImportScene Class

Last update: 2021-04-29

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-2021. 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