ObjectVolumeBox Class

This class is used to create a volume box. Depending on the assigned material, it can be used to render fog, light shafts from a world light source or clouds.

ObjectVolumeBox Class

Members

---

static ObjectVolumeBox(vec3 size)

Constructor. Creates a new volume box object with given dimensions.

Arguments

• vec3 size - Dimensions of the new volume box object in units.

ObjectVolumeBox cast(Node node)

Casts an ObjectVolumeBox out of the Node instance.

Arguments

• Node node - Node instance.

Return value

ObjectVolumeBox instance.

ObjectVolumeBox cast(Object base)

Casts an ObjectVolumeBox out of the Object instance.

Arguments

• Object base - Object instance.

Return value

ObjectVolumeBox instance.

void setSize(vec3 size)

Updates volume box dimensions.

Arguments

• vec3 size - New dimensions of the volume box in units. If a negative value is provided, 0 will be used instead.

vec3 getSize()

Returns volume box dimensions.

Return value

Dimensions of the volume box in units.

int type()