This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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::Plugins::IG::LightController Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <plugins/UnigineIG.h>

LightController Class

Members


void setEnabled ( const Ptr<Node> & parent_node, const char * path, bool enable ) #

Enables or disables all lights of a given parent node within a specified category.

Arguments

  • const Ptr<Node> & parent_node - Parent node of lights to be enabled.
  • const char * path - Category of lights in the lights hierarchy.
  • bool enable - true to enable lights, false to disable.

void setEnabled ( const char * path, bool enable ) #

Enables or disables all lights within a specified category.

Arguments

  • const char * path - Category of lights in the lights hierarchy.
  • bool enable - true to enable lights, false to disable.

void setEnabled ( Unigine::Vector<unsigned int> & hash_path, bool enable ) #

Enables or disables all lights within a specified category using its hash.
Notice
Toggling lights using the path hash is faster than using categories, therefore, is recommended for use, where appropriate.

Arguments

  • Unigine::Vector<unsigned int> & hash_path - Hash of the category of lights in the lights hierarchy.
  • bool enable - true to enable lights, false to disable.

void setStrobed ( const char * path, bool enable ) #

Enables or disables lights strobing within a specified category.

Arguments

  • const char * path - Category of lights in the lights hierarchy.
  • bool enable - true to enable strobing, false to disable.

void setStrobed ( Unigine::Vector<unsigned int> & hash_path, bool enable ) #

Enables or disables lights strobing within a specified category using its hash.

Arguments

  • Unigine::Vector<unsigned int> & hash_path - Hash of the category of lights in the lights hierarchy.
  • bool enable - true to enable strobing, false to disable.

void setBright ( const char * path, float bright ) #

Sets the intensity of lights within a specified category.

Arguments

  • const char * path - Category of lights in the lights hierarchy.
  • float bright - Light intensity value within the [0.0f; 1.0f] range.

void setBright ( Unigine::Vector<unsigned int> & hash_path, float bright ) #

Sets the intensity of lights within a specified category using its hash.

Arguments

  • Unigine::Vector<unsigned int> & hash_path - Hash of the category of lights in the lights hierarchy.
  • float bright - Light intensity value within the [0.0f; 1.0f] range.

void getIndexPath ( const char * path, Unigine::Vector<unsigned int> & ret_hash_path ) #

Fills in the vector data array with the path hash values.

Arguments

  • const char * path - Category of lights in the lights hierarchy.
  • Unigine::Vector<unsigned int> & ret_hash_path - Pointer to the array storing hash of the path.
Last update: 2022-03-10
Build: ()