This page has been translated automatically.
Click here to view the original English version instead.
Getting Started
Hardware Requirements
Startup Command-Line Options
Main Menu
Console
Principles of Operation
Virtual World Structure
World Management
Rendering
Rendering Sequence
Alpha Blending
Shading
HDR Rendering
Bit Masking
Postprocessing
Tessellation
Panoramic Rendering with AppPanorama Plugin
Projections with AppProjection Plugin
DirectX 11 Software Rendering with AppLevel Plugin
Physics
Shapes
Collision Detection
Joints
Simulation of Physics
File System
Built-in Objects
Nodes
Node
Node Reference
Dummy Node
Layer
Pivot
Trigger
Objects
Dummy Object
Static Mesh
Skinned Mesh
Dynamic Mesh
Mesh Cluster
Mesh Clutter
Sky
Grass
Effects
Particle System
Decals
Light Sources
Probe Light
Omni Light
Spot Light
Projected Light
World Light
World Objects
World Layer
Sector
Portal
World Trigger
World Cluster
World Clutter
Switcher
World Expression
Sound Objects
Sound Source
Sound Reverb
Pathfinding Objects
Players
Player Dummy
Player Persecutor
Programming
Development for Different Platforms
Windows Application Development
Linux Application Development
Mac OS X Application Development
Semi-automatic Compilation with Build Script
Manual Compilation with SCons
New Project Generator
Protecting Your Data with a Password
Engine Architecture
Execution Sequence
Where to Put Your Code: Update(), Flush() or Render()
Typical Architecture of a Unigine-Based Application
Memory Management
Mesh File Formats
Material File Format
GUI
RC Files
Skin Layout
Usage Example
Double Precision Coordinates
Using ActionScript
Working with Console
Performance Analyzer
How to Generate Shaders Cache
UnigineScript
The Language
Structure of a Program
Data Types
Operators
Functions
Scope. Namespaces
Object Oriented Programming
Interface Class
Preprocessor Directives
Language Features
Core Library
Engine Library
Variables
Node-Related Classes
Node Class
NodeDummy Class
NodeExtern Class
NodeExternBase Class
NodeLayer Class
NodePivot Class
NodeReference Class
NodeTrigger Class
AmbientSource Class
Material Class
Property Class
GUI-Related Classes
Gui Class
UserInterface 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
WidgetFlash 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
WidgetSpriteMaterial Class
WidgetSpriteNode Class
WidgetSpriteShader Class
WidgetSpriteVideo Class
WidgetSpriteViewport Class
WidgetTabBox Class
WidgetTreeBox Class
WidgetVBox Class
WidgetVPaned Class
WidgetWindow Class
Plugins Library
AutodeskImport Class
ColladaImport Class
OpenFlightImport Class
engine.oculus Functions
engine.projection Functions
engine.surround Functions
engine.wall Functions
High-Level Systems
Basic Utilities
Unigine::Schemer
Unigine::Skinner
Input System
Character System
KeyLine System
Dialogs Script
Samples
Cache Files
Script Debugging
C++ API
Creating C++ Application
Creating C++ Plugin
API Reference
Unigine Namespace Functions
Unigine::App Class
Unigine::ArrayMap Class
Unigine::ArrayMap::Iterator Class
Unigine::ArrayVector Class
Unigine::AtomicLock Class
Unigine::BoundBox Class
Unigine::BoundFrustum Class
Unigine::BoundSphere Class
Unigine::Buffer Class
Unigine::CallbackBase Class
Unigine::Compress Class
Unigine::Checksum Class
Unigine::Config Class
Unigine::Console Class
Unigine::ConsoleVariableFloat Class
Unigine::ConsoleVariableInt Class
Unigine::ConsoleVariableString Class
Unigine::Controls Class
Unigine::Editor Class
Unigine::Engine Class
Unigine::ExternClass< Class > Class Template
Unigine::Ffp Class
Unigine::File Class
Unigine::FileSystem Class
Unigine::FunctionBase Class
Unigine::Game Class
Unigine::Gui Class
Unigine::Image Class
Unigine::Interpreter Class
Unigine::Light Class
Unigine::LightOmni Class
Unigine::LightProb Class
Unigine::LightProj Class
Unigine::LightSpot Class
Unigine::LightWorld Class
Unigine::Log Class
Unigine::Map Class
Unigine::Material Class
Unigine::Materials Class
Unigine::Memory Class
Unigine::Mesh Class
Unigine::MeshSkinned Class
Unigine::Node Class
Unigine::NodeReference Class
Unigine::NodeDummy Class
Unigine::NodeExtern Class
Unigine::NodeExternBase Class
Unigine::NodeLayer Class
Unigine::NodePivot Class
Unigine::NodeTrigger Class
Unigine::Object Class
Unigine::ObjectExtern Class
Unigine::ObjectExternBase Class
Unigine::ObjectBillboard Class
Unigine::ObjectBillboards Class
Unigine::ObjectDummy Class
Unigine::ObjectMesh Class
Unigine::ObjectMeshCluster Class
Unigine::ObjectMeshDynamic Class
Unigine::ObjectMeshSkinned Class
Unigine::ObjectTerrain Class
Unigine::Package Class
Unigine::Physics Class
Unigine::Player Class
Unigine::PlayerDummy Class
Unigine::Plugin Class
Unigine::Property Class
Unigine::Properties Class
Unigine::Ptr< Type > Class Template
Unigine::Set Class
Unigine::Render Class
Unigine::Renderer Class
Unigine::Resource Class
Unigine::Shader Class
Unigine::Socket Class
Unigine::Sound Class
Unigine::State Class
Unigine::Stream Class
Unigine::StreamBase Class
Unigine::String Class
Unigine::Texture Class
Unigine::TextureRender Class
Unigine::Thread Class
Unigine::Timer Class
Unigine::Tree::ConstIterator Class
Unigine::Tree::Iterator Class
Unigine::Tree::Node Class
Unigine::Tree< Key, Data > Class Template
Unigine::TypeInfo Class
Unigine::UserInterface Class
Unigine::Variable Class
Unigine::Vector::ConstIterator Class
Unigine::Vector::Iterator Class
Unigine::Vector< > Class Template
Unigine::Visualizer Class
Unigine::Widget Class
Unigine::WidgetButton Class
Unigine::WidgetCanvas Class
Unigine::WidgetCheckBox Class
Unigine::WidgetComboBox Class
Unigine::WidgetDialog Class
Unigine::WidgetDialogColor Class
Unigine::WidgetDialogFile Class
Unigine::WidgetDialogImage Class
Unigine::WidgetDialogMessage Class
Unigine::WidgetEditLine Class
Unigine::WidgetEditText Class
Unigine::WidgetExtern Class
Unigine::WidgetExternBase Class
Unigine::WidgetGridBox Class
Unigine::WidgetGroupBox Class
Unigine::WidgetHBox Class
Unigine::WidgetHPaned Class
Unigine::WidgetIcon Class
Unigine::WidgetLabel Class
Unigine::WidgetListBox Class
Unigine::WidgetMenuBar Class
Unigine::WidgetMenuBox Class
Unigine::WidgetScroll Class
Unigine::WidgetScrollBox Class
Unigine::WidgetSlider Class
Unigine::WidgetSpacer Class
Unigine::WidgetSpinBox Class
Unigine::WidgetSprite Class
Unigine::WidgetTabBox Class
Unigine::WidgetTreeBox Class
Unigine::WidgetVBox Class
Unigine::WidgetVPaned Class
Unigine::WidgetWindow Class
Unigine::World Class
Unigine::WorldExtern Class
Unigine::WorldExternBase Class
Unigine::WorldLayer Class
Unigine::WorldPortal Class
Unigine::WorldSector Class
Unigine::WorldSwitcher Class
Unigine::WorldTrigger Class
Unigine::Xml Class
Unigine::dmat4 Struct
Unigine::dvec2 Struct
Unigine::dvec3 Struct
Unigine::dvec4 Struct
Unigine::ivec2 Struct
Unigine::ivec3 Struct
Unigine::ivec4 Struct
Unigine::mat4 Struct
Unigine::quat Struct
Unigine::vec2 Struct
Unigine::vec3 Struct
Unigine::vec4 Struct
Unigine::Ffp::Vertex Struct
Unigine::Image::Pixel Struct
Unigine::Mesh::Vertex Struct
Unigine::MeshSkinned::Frame Struct
Unigine::MeshSkinned::Vertex Struct
Unigine::MeshSkinned::Weight Struct
Unigine::ObjectDynamic::Attribute Struct
Unigine::Image::Pixelf Union
Unigine::Image::Pixeli Union
Integration Samples
Unigine Integration into MFC Application
Unigine Integration into SDL Application
Unigine Integration into Qt Application
Usage Examples
Library's Namespace
Variable Export
Constant Export
Function Export
Class Export
Data Structure Export
Callbacks
Serialization
App Class
UnigineScript Containers
C++ Plugins
Remote Access to Resources via FileClient Plugin
CIGI Protocol Support via CigiClient Plugin
Secure SSL Connection via SSLSocket Plugin
GPU Monitoring with GPUMonitor Plugin
Razer Hydra Support via Sixense Plugin
Renderer Customization via Renderer Plugin
Content Creation
Content Pipeline
Level Design
Static Geometry
Texturing
Animation
Materials
Hierarchy and Inheritance
Unigine Material Library
billboard_base
billboards_base
billboards_cloud_base
decal_base
decal_deferred_base
decal_terrain_base
grass_base
grass_impostor_base
gui_base
mesh_chain_base
mesh_layer_base
mesh_leaf_base
mesh_noise_base
mesh_overlap_base
mesh_stem_base
mesh_terrain_base
mesh_triplanar_base
mesh_wire_base
particles_base
render_composite
sky_base
terrain_base
volume_cloud_base
volume_fog_base
volume_light_base
volume_omni_base
volume_proj_base
volume_shaft_base
water_base
Custom Materials
Tutorials
Adding Object into a New World
Adding Animated Object into the Loaded World
Adding Scripts to the Project
Setting Up Object LODs
Adding Lighting, Sky and Clouds
Adding Water
Adding Terrain
Creating a Reflective and Refractive Glass
Adding Grass
Adding Impostors to Clutters
Adding Vegetation: Creating a Tree
Adding Vegetation: Random Scattering of Objects
Using Tessellation
Adding Physics for Object
Tools
Plugins for 3D Editors
Plugins for 3ds Max
Plugins for Maya
Plugins for Softimage
Unigine Editor
Interface
Hot Keys and Navigation
Nodes Panel
Material Editor
Properties Editor
Render Settings
Physics Settings
Performance Profiler
ResourceEditor
MeshViewer
NormalMapper
NormalCombiner
AmbientMapper
AlphaMapper
Launcher
Structure
FileServer
FlashView
ImageDDS
ImageTTF
USC Interpreter
Archiver
Terrain
TerrainMesh
TerrainRelax
XmlTree
MeshImport
Upgrade Script
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.

Unigine::LightProb Class

List of Functions:

Interface for light omni handling.

To use this class, include the UnigineLightProb.h file.

Unigine::LightProb Class

Members

static Ptr< LightProb > create (const NodePtr & node)

LightProb constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< LightProb > create (const LightPtr & light)

LightProb constructor.

Arguments

  • const LightPtr & light - Light smart pointer.

static Ptr< LightProb > create (const vec4 & color, const vec3 & radius)

LightProb constructor.

Arguments

  • const vec4 & color - Light color.
  • const vec3 & radius - Light radius.

virtual void setRadius (const vec3 & radius) const =0

Sets a light radius.

Arguments

  • const vec3 & radius - Light radius.

virtual vec3 getRadius () const =0

Returns a light radius.

Return value

Light radius.

virtual void setCoefficients (const vec3 * coefficients) const =0

Sets light nine spherical harmonic coefficients.

Arguments

  • const vec3 * coefficients - Light nine spherical harmonic coefficients pointer.

virtual const vec3 * getCoefficients () const =0

Gets light nine spherical harmonic coefficients.

Return value

Light nine spherical harmonic coefficients pointer.

virtual void setImageTextureImage (const ImagePtr & image) const =0

Sets the light environment image texture.

Arguments

  • const ImagePtr & image - Light environment image texture.

virtual void getImageTextureImage (const ImagePtr & image) const =0

Gets the light environment image texture.

Arguments

  • const ImagePtr & image - Light environment image texture.

virtual vec3 getImageTextureColor (const vec3 & direction) const =0

Returns a light color by direction.

Arguments

  • const vec3 & direction - Direction vector.

Return value

Light color at specified direction.

virtual void renderImageTexture (float znear, float zfar, int size) const =0

Renders a light image texture.

Arguments

  • float znear - Rendering near clipping plane.
  • float zfar - Rendering far clipping plane.
  • int size - Rendering image size.
Last update: 2017-07-03
Build: ()