This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
Quick Start
What's Inside?
Downloading and Installing UNIGINE SDK
Project Workflow
Programming Quick Start
Introduction
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
Programming
Physics
Migrating to UNIGINE From Unity
Content Creation
Programming
Physics
Video Tutorials
Interface
SDK Browser Interface
Editor Interface
Scene Viewport
Essentials
Importing 3D Models
Instancing Nodes
Materials
Lighting
Tracker Tool
Global Illumination
Content Optimization
Decals
Performance Inspection with Microprofile
Textures
Procedural Texturing
Bit Masking
Audio Sources and Sound Effects
Cached Shadows
Water
Physics
C# Component System
Landscape Terrain
Volumetric Clouds
Node References: Must-Knows
Georeferenced Terrain Generation Using Sandworm
Advanced
Microprofile for Artists
How To
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
Asset Browser
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
Change Particle Trajectories Using Deflectors
Rendering
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
Animation
Virtual World Structure
World Management
Properties
Hierarchy and Inheritance
Component System
C++ Component System
C# Component System
Rendering
Rendering Sequence
Parallel-Split Shadow Mapping
Interleaved Lights Rendering
Alpha Blending
Upscaling with DLSS and FSR
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
Bit Masking
Import System
Export System
File System
Asynchronous Data Streaming
Memory Allocator
SDK Browser 2
Projects
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
Airport Assets
Eastern European Countryside
Docs Sample Content
IG Aviation
Industrial Assets
Road Tool Constructor
Scans
Vegetation
VFX
VideoTexture
Weather
Georeferenced Terrain Generation
Procedural Generation Assets
Demos
CIGI
C# Third Person Platformer
C++ SIM Samples
Drone Simulator
Earthworks
Fox Hole
Mars
Oil Platform
Oil Refinery
Orbits
ROS Vehicle
Superposition
Syncker
Viewer
VR Sample
API Samples
Changelog
UnigineEditor
Interface Overview
Layout Customization
Context Menus
Assets Workflow
Asset Types
Assets and Runtime Files
Organizing Assets
Copying Assets From Other Projects
Upgrading Assets
Project Files
Version Control
Managing Packages
Settings and Preferences
Editor Settings and Hotkeys
World Settings
Global Physics Settings
Global Sound Settings
Controls Settings
Working With Projects
Packing a Final Build for Publishing
Managing Worlds
Scene Navigation
Creating Nodes
Selecting and Positioning Nodes
Organizing Nodes
Node Dependencies
Exporting Nodes
Instancing Nodes
Adjusting Node Parameters
Transformation and Common Parameters
Visual Representation
Properties
Physics and Sound
Geo Coordinates
Setting Up Materials
Organizing Materials
Pre-Compiling Shaders
Setting Up Properties
Organizing Properties
Lighting
Environment
Light Meter
Reflections
Setting Up Cameras
Using Visual Debugging
Using Visual Helpers
Editing Curves
Sandworm
Interface Overwiew
Questions and Answers
Using Editor Tools for Specific Tasks
Capturing Screenshots and Frame Sequences
Adding Variations for a More Realistic Environment
Generating Impostors with Impostors Creator
Editing Global Terrain
Editing Landscape Terrain
Batch Rename
Mask Editor for Grass and Clutters
Cluster Editor
Extending Editor Functionality
Setting Up Environment
Creating Your First Editor Plugin
Managing Assets in Editor Plugins
VR Editor Plugin
UnigineEditor API
ImGuiSamples Plugin
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Performance Profiling Tools
Performance Profiler
Microprofile
USC Interpreter
Archiver
Resource
Upgrade Script
Runtimes Generator
Built-in Node Types
Nodes
Node
Node Reference
Dummy Node
Layer
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Text Object
Sky
Cloud Layer
Effects
Decals
Projected Decal
Orthographic Decal
Mesh Decal
Light Sources
Light Sources Parameters
Omni Light
Projected Light
World Light
Environment Probe
Voxel Probe
Planar Reflection Probe
Geodetics
Geodetic Pivot
World Nodes
World Trigger
World Clutter
Switcher
World Expression
World Spline Graph
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Actor
Player Dummy
Player Persecutor
Player Spectator
Programming
Fundamentals
Programming Overview
Engine Architecture
Working with Smart Pointers
Accessing Nodes and Files via Properties
Thread Safety
Matrix Transformations
Camera Matrices
Event Handling
Event Handling Callbacks
Setting Up Development Environment
Windows Development Environment
Linux Development Environment
Usage Examples
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
Creating Pylons and Wires Using Ropes
Dynamic Meshes
Enabling Selective Surface-Based Collision
Playing Sounds on Collisions
Intersections
Mesh Class
Working with Console
Sharing Data
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#
Creating C# Application
Debugging C# Components
Garbage Collector
C# API Reference
UnigineScript
Creating UnigineScript Application
Adding Scripts to the Project
Script Debugging
Handling Ownership When Using Scripts
Cache Files
UUSL (Unified UNIGINE Shader Language)
UUSL Keywords
UUSL Common Intrinsic Functions
UUSL GBuffer Structure
UUSL Parameters
UUSL Textures and Buffers
UUSL Semantics
UUSL Tessellation
UUSL Color Spaces
UUSL Matrices
UUSL Noise
UUSL Pack Utils
UUSL Parallax
UUSL Compute Shaders
Creating a Custom Shader for Post-Processing
Plugins
ARTTRACK Plugin
FbxImporter Plugin
CadImporter Plugin
GeodeticsPlugin
GPU Monitoring with GPUMonitor Plugin
Kinect2 Plugin
LeapMotion Plugin
Ultraleap Plugin
Teslasuit Plugin
VRPN Plugin
FMOD Plugin
UsdExchanger Plugin
WebStream Plugin
File Formats
Unigine Language Object Notation
Mesh File Formats
Property File Format
Spline File Format
Materials and Shaders
Startup Command-Line Options
Console
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
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Usage
Performance Analyzer
Engine Version
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
Containers
Container Functions
ArrayVector Class
BiMap Class
HashMap Class
BucketHashMap Class
HashSet Class
BucketHashSet Class
Hasher Class
Map Class
Pair Class
Set Class
Common Functionality
Async Class
ScopedLock Class
ScopedReaderLock Class
ScopedReentrantLock Class
ScopedWriterLock Class
Atomic Class
BackoffSpinner Class
Mutex Class
ReentrantMutex Class
RWMutex Class
Blob Class
Signal Class
Compress Class
ConsoleVariableFloat Class
ConsoleVariableInt Class
ConsoleVariableString Class
ConsoleVariableVec2 Class
ConsoleVariableVec3 Class
ConsoleVariableVec4 Class
Curve2d Class
Expression Class
ExternClass Class
FunctionBase Class
Image Class
ImageConverter Class
Interpreter Class
Json Class
Log Class
OS Functions
Palette Class
Path Class
Plugin Class
Property Class
PropertyParameter Class
Ptr Class
Reflection Class
RegExp Class
Resource Class
Stream Class
String Class
StringArray Class
StringPtr Class
StringStack Class
Thread Class
Time Class
Timer Struct
TypeInfo Class
UlonArg Class
UlonValue Class
UlonNode Class
Unigine Namespace Items
Utils Class
Xml Class
Variable Class
Controls-Related Classes
Controls Class
ControlsApp Class
ControlsDummy Class
Input 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
Config Class
Console Class
Editor Class
Engine Class
EnginePtr Class
engine.system Functions
EnginePlugins Class
Game Class
GameIntersection Class
LoadingScreen Class
Memory Class
Profiler Class
Properties Class
Sound Class
Sounds Class
SystemDialog Class
SystemInfo Class
UserConfig Class
Visualizer Class
World Class
Filesystem Functionality
Dir Class
File Class
FileSystem Class
FileSystemAssets Class
FileSystemMount Class
AsyncQueue Class
File System Functions
Package Class
PackageUng Class
UGUID Class
GUI-Related Classes
Gui Class
UserInterface Class
Displays Class
EngineWindow Class
EngineWindowGroup Class
EngineWindowViewport Class
WindowManager Class
WindowEvent Class
WindowEventDpi Class
WindowEventDrop Class
WindowEventGeneric 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
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
Node-Related Classes
Node Class
NodeAnimationPlayback Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodeReference Class
NodeTrigger Class
Objects-Related Classes
Object Class
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
BonesRetargeting Class
ObjectMeshSplineCluster Class
ObjectSky Class
ObjectTerrainGlobal Class
TerrainGlobalDetail Class
TerrainGlobalLod Class
TerrainGlobalLodHeight Class
TerrainGlobalLods Class
TileSet Class
TileSetFile Class
ObjectText Class
ObjectVolumeBox Class
ObjectVolumeOmni Class
ObjectVolumeProj Class
ObjectVolumeSphere Class
ObjectWaterMesh Class
ObjectWaterGlobal Class
Networking Functionality
Socket Class
SSLSocket Class
Pathfinding-Related Classes
Navigation Class
NavigationMesh Class
NavigationSector Class
Obstacle Class
ObstacleBox Class
ObstacleCapsule Class
ObstacleSphere Class
PathRoute Class
PathRouteIntersection Class
Physics-Related Classes
Contact Class
ShapeContact Class
Physics Class
PhysicsIntersection Class
PhysicsIntersectionNormal Class
Plugins-Related Classes
Kinect Class
Oculus Class
engine.surround Functions
Varjo Class
OpenVR Class
ARTTracker Class
IG Plugin
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
IGConfig Class
Component Class
ComponentBaseInterface
IGIntersection Structure
ArticulatedPart Class
CollisionSegment Class
CollisionVolume Class
Converter Class
Entity Class
LightController Class
Meteo Class
MeteoCameraEffects Class
MeteoPositionParam Structure
Region Class
SkyMap Class
SymbolsController Class
SymbolsPlane Class
Symbol Class
SymbolPolyline Class
SymbolCircle Class
SymbolText Class
ViewBase Class
ViewGroup Class
View Class
Water Class
WeatherLayer Class
WeatherLayerCloud Class
WeatherLayerPrecipitation Class
Rendering-Related Classes
Camera Class
EngineExpression Class
Ffp Class
Material Class
Materials Class
Mesh Class
MeshRender Class
MeshAnimation Class
MeshDynamic Class
Primitives Class
Render Class
RenderEnvironmentPreset Class
Renderer Class
RenderState Class
RenderTarget Class
ResourceFence Class
ResourceExternalMemory Class
Shader Class
CPUShader Class
StructuredBuffer Class
Texture Class
TextureRamp Class
Viewport Class
VR-Related Classes
VR Class
VREyeTracking Class
VRHandTracking Class
VRBone Class
VRHand 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
Textures Optimization
Materials Optimization
Lights Optimization
Dynamic Reflections Optimization
Water Optimization
Terrain Optimization
Physics Optimization
VR Best Practices
Materials
Hierarchy and Inheritance
Material Nodes Library
Miscellaneous
Material Node
Final Node
To Int Node
Portal In Node
Portal Out Node
Expression Node
Function Node
Sub Graph Node
Loop Begin Node
Loop End Node
Rotate Space Node
Transform Space Node
Reflect Node
Refract Node
Time Node
Rotate UV 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
Contrast Node
Flowmap Panner Node
Flowmap Panner Simple Node
Levels Node
Posterize 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
Overlay Node
Srgb 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
Blackbody Node
Fresnel 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
Flipbook Node
Anisotropic Specular Brdf Node
Hair Shading Node
Curvature Node
Ggx Brdf Importance Sampling Node
Replace Color Node
Float Correction By Ramp Node
Color Correction By Ramp Node
Mirror UV Node
Material Quality Switch 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
Screen Coord Before Upscale Node
Upscale Factor Node
Screen UV 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
Vertex ID Node
Instance ID Node
Material Mask Node
Up Node
Down Node
Forward Node
Back Node
Right Node
Left Node
Vertex Front Face Node
Object Position Node
Object Scale Node
Sun Direction Node
Moon Direction Node
Float Node
Float2 Node
Float3 Node
Float4 Node
Color (Float3) Node
Color (Float4) Node
Int Node
Int2 Node
Int3 Node
Int4 Node
Bool Node
Frame Node
IFps Node
Game Scale Node
Settings Nodes
Math
Add Node
Subtract Node
Multiply Node
Frac Node
DDX Node
DDX Coarse Node
DDX Fine Node
DDY Node
DDY Coarse Node
DDY Fine Node
DDXY Node
Clamp Node
Saturate Node
Power Node
Ceiling Node
Floor Node
Absolute Node
Sign Node
Base-E Logarithm Node
Base-2 Logarithm Node
Base-10 Logarithm Node
Base-2 Exponential Node
Base-E Exponential Node
Increment Node
Decrement Node
Mod Node
FMod Node
Divide Node
Divide Int Node
Reciprocal Node
Maximum Node
Maximum Possible Float Node
Maximum Possible Half Node
Maximum Possible Int Node
Minimum Node
Minimum Possible Float Node
Minimum Possible Int Node
Rerange Node
Square Root Node
Reciprocal Square Root Node
Round Node
Multiply And Add Node
ModF Node
Step Node
Smooth Step Node
Length Node
Length Squared Node
Normalize Node
Cross Node
Dot Product Node
Lerp Node
Lerp3 Node
Lerp Contrast Preserving Node
Inverse Lerp Node
Golden Ratio Node
Pi Node
Pi2 Node
Pi05 Node
Reverse Bits Node
Is Finite Node
Is Infinity Node
Is Nan Node
All Node
Any Node
First Bit High Node
First Bit Low Node
Distance Node
Matrix
Matrix2 Node
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
Is Ortho Node
Basis X Node
Basis Y Node
Basis Z Node
Determinant Node
Orthonormalize Node
Scale Node
Translate Node
Transpose Node
Inverse Node
Inverse Transform Node
Decompose Euler Node
Rotate Euler Node
Rotate Axis Node
Rotate X Node
Rotate Y Node
Rotate Z Node
Decompose Transform Node
Compose Transform Node
Matrix Multiply 3x3 Node
Matrix Multiply 4x4 Node
Ortho Node
Frustum 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
Textures
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
Custom Materials
Scriptable Materials
Art Samples
Tutorials
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.19.1
API Migration
Console Migration
Content Migration
IG Template
IG Configuration
Environment Settings
Light Settings
Entity-Related Properties
Creating Custom Components
Processing User-Defined Packets
Debugging IG Application
IG Editor Plugin
IG Host
VR-Based IG Template
Getting Time via API
Troubleshooting
SDK Browser Issues
UnigineEditor Issues
.NET Issues
Application Crashes
Antivirus Recommendations
Third-Party Notices
Table of Contents

CigiSymbolTextDef Class

In This Article:

Inherits from: CigiHostPacket

Properties:

NameDescription
int SymbolID
The Symbol ID specified in the packet.
int FontID
The value of the Font ID parameter specified in the packet.
int Alignment
The value of the Alignment parameter specified in the packet.
int Orientation
The value of the Orientation parameter specified in the packet.
float FontSize
The value of the Font Size parameter specified in the packet.
string Text
The value of the Octet parameter specified in the packet.

Methods:

NameDescription

CigiSymbolTextDef Class

Enums

CIGI_TEXT_ALIGN#

NameDescription
TOP_LEFT = 0Text alignment in the top left corner.
TOP_CENTER = 1Text alignment in the top center position.
TOP_RIGHT = 2Text alignment in the top right corner.
CENTER_LEFT = 3Text alignment in the middle left position.
CENTER = 4Text alignment in the center of field.
CENTER_RIGHT = 5Text alignment in the middle right position.
BOTTOM_LEFT = 6Text alignment in the bottom left corner.
BOTTOM_CENTER = 7Text alignment in the bottom center position.
BOTTOM_RIGHT = 8Text alignment in the bottom right corner.

CIGI_TEXT_ORIENT#

NameDescription
LEFT_TO_RIGHT = 0Left to Right orientation of text.
TOP_TO_BOTTOM = 1Top to Bottom orientation of text.
RIGHT_TO_LEFT = 2Right to Left orientation of text.
BOTTOM_TO_TOP = 3Bottom to Top orientation of text.

Properties

int SymbolID#

The Symbol ID specified in the packet.

int FontID#

The value of the Font ID parameter specified in the packet. Determines the font that is used for this text symbol.

int Alignment#

The value of the Alignment parameter specified in the packet. Specifies the position at which the IG shall place the symbol’s reference point in relation to the text.

int Orientation#

The value of the Orientation parameter specified in the packet. Determines the orientation of text.

float FontSize#

The value of the Font Size parameter specified in the packet. Specifies the font size in terms of the vertical units defined by the symbols surface's 2D coordinate system.

string Text#

The value of the Octet parameter specified in the packet.

Members

Last update: 2024-12-13
Build: ()