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.
See Also#
A UnigineScript API sample <UnigineSDK>/data/samples/objects/volumes_00
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( )
Returns the type of the node.Return value
Object type identifier.Last update:
2020-01-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)