Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

ObjectVolumeSphere Class

This class is used to create a volume sphere. Depending on the assigned material, it can be used to render fog or a visible volume of light around a light source. A volume sphere can also be of an ellipsoid shape.

ObjectVolumeSphere Class

This class inherits from Object

Members


ObjectVolumeSphere (vec3 radius)

Constructor. Creates a new volume sphere object with given radius values.
Notice
If a volume light material is assigned to an object, it is rendered based only on the X-axis radius value. If its radius values along Y or Z axes are smaller, then the object is cut along them.

Arguments

  • vec3 radius - Radius values of the new volume sphere object in units. If a negative value is provided, 0 will be used instead.

vec3 getRadius ()

Returns volume sphere radius values.

Return value

Radius values of the volume sphere in units.

void setRadius (vec3 radius)

Updates volume sphere radius values.
Notice
If a volume light material is assigned to an object, it is rendered based only on the X-axis radius value. If its radius values along Y or Z axes are smaller, then the object is cut along them.

Arguments

  • vec3 radius - New radius values of the volume sphere in units. If a negative value is provided, 0 will be used instead.
Last update: 2017-07-03