ObjectVolumeBox Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| 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 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.
void setSize ( vec3 size ) #
Updates volume box dimensions.Arguments
- vec3 size - New dimensions of the volume box in units. If a negative value is provided, 0 will be used instead.
vec3 getSize ( ) #
Returns volume box dimensions.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:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)