Unigine.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

Members

---

static ObjectVolumeSphere(vec3 radius)

Constructor. Creates a new volume sphere object with given radius values.

Arguments

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

ObjectVolumeSphere cast(Object base)

Casts an ObjectVolumeSphere out of the Object instance.

Arguments

• Object base - Object instance.

Return value

ObjectVolumeSphere instance.

ObjectVolumeSphere cast(Node node)

Casts an ObjectVolumeSphere out of the Node instance.

Arguments

• Node node - Node instance.

Return value

ObjectVolumeSphere instance.

void setRadius(vec3 radius)

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

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

vec3 getRadius()

Returns the volume sphere radius values.

Return value

The radius values of the volume sphere in units.

int type()

Returns the type of the node.

Return value

Object type identifier.