This page has been translated automatically.
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
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::ObjectVolumeBox Class

Header:#include <UnigineObjects.h>

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


static ObjectVolumeBoxPtr create(const Math::vec3 & size)

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


  • const Math::vec3 & size - Dimensions of the new volume box object in units.

Ptr<ObjectVolumeBox> cast(const Ptr<Node> & node)

Casts an ObjectVolumeBox out of the Node instance.


  • const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to ObjectVolumeBox.

Ptr<ObjectVolumeBox> cast(const Ptr<Object> & base)

Casts an ObjectVolumeBox out of the Object instance.


  • const Ptr<Object> & base - Pointer to Object.

Return value

Pointer to ObjectVolumeBox.

void setSize(const Math::vec3 & size)

Sets new dimensions for the volume box.


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

Math::vec3 getSize()

Returns dimensions of the volume box.

Return value

Dimensions of the volume box in units.

int type()

Returns the type of the node.

Return value

Object type identifier.
Last update: 2017-10-20
Build: ()