This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
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
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

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

Properties

vec3 Size#

Dimensions of the volume box.
set
Sets new dimensions for the volume box.
set value - New dimensions of the volume box in units. If a negative value is provided, 0 will be used instead.

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.

static ObjectVolumeBox Cast ( Node node ) #

Casts an ObjectVolumeBox out of the Node instance.

Arguments

  • Node node - Node instance.

Return value

ObjectVolumeBox instance.

static ObjectVolumeBox Cast ( Object base ) #

Casts an ObjectVolumeBox out of the Object instance.

Arguments

  • Object base - Object instance.

Return value

ObjectVolumeBox instance.

static int type ( ) #

Returns the type of the node.

Return value

Object type identifier.
Last update: 2019-08-16
Build: ()