ObjectVolumeSphere 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 sphere. Depending on the assigned material, it can be used to render fog or a visible volume of light around a light source. A volume sphere can also be of an ellipsoid shape.
See Also#
A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/objects/ folder:
- volumes_01
- volumes_02
ObjectVolumeSphere Class
Members
static ObjectVolumeSphere ( vec3 radius ) #
Constructor. Creates a new volume sphere object with given radius values.Notice
If a volume light material is assigned to an object, it is rendered based only on the X-axis radius value. If its radius values along Y or Z axes are smaller, then the object is cut along them.
Arguments
- vec3 radius - Radius values of the new volume sphere object in units. If a negative value is provided, 0 will be used instead.
void setRadius ( vec3 radius ) #
Updates volume sphere radius values.Notice
If a volume light material is assigned to an object, it is rendered based only on the X-axis radius value. If its radius values along Y or Z axes are smaller, then the object is cut along them.
Arguments
- vec3 radius - New radius values of the volume sphere in units. If a negative value is provided, 0 will be used instead.
vec3 getRadius ( ) #
Returns volume sphere radius values.Return value
Radius values of the volume sphere 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)