Programming
Fundamentals
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
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
Rendering-Related Classes

Unigine::ObjectVolumeBox Class

Header:#include <UnigineObjects.h>
Inherits:Object

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 ObjectVolumeBoxPtr create(const Math::vec3 & size)

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

Arguments

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

Arguments

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

Arguments

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

Arguments

  • 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()

Last update: 2017-07-03