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
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Unigine::ObjectVolumeSphere Class

Interface for object volumesphere handling. See also the UnigineScript analog.

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

Unigine::ObjectVolumeSphere Class

Members


static int type ()

ObjectVolumeSphere type.

Return value

ObjectVolumeSphere type identifier.

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

ObjectVolumeSphere constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< ObjectVolumeSphere > create (const ObjectPtr & object)

ObjectVolumeSphere constructor.

Arguments

  • const ObjectPtr & object - Object smart pointer.

static Ptr< ObjectVolumeSphere > create (const vec3 & radius)

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

Arguments

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

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

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

Arguments

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

virtual vec3 getRadius () const =0

Returns the volume sphere radius values.

Return value

The radius values of the volume sphere in units.
Last update: 2017-07-03