This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
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
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::ObjectVolumeBox Class

Header: #include <UnigineObjects.h>
Inherits from: 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.

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 ( ) const#

Returns dimensions of the volume box.

Return value

Dimensions of the volume box in units.

static int type ( ) #

Returns the type of the node.

Return value

Object type identifier.
Last update: 2020-06-26
Build: ()