Unigine.ObjectVolumeOmni Class
| Inherits: | Object |
This class is used to create a volume omni object. It simulates a visible volume of light emitted from a flat light source.
The volume omni object is rendered as a flat rectangle and billboards around its edges. The rectangle simulates a light emitting surface and billboards create a light volume around it.
See Also#
A UnigineScript API sample <UnigineSDK>/data/samples/objects/volumes_03
ObjectVolumeOmni Class
Properties
float Attenuation#
Attenuation that modulates smooth fading of the volume omni object when the camera looks at it from a side.
set
Sets attenuation that controls how fast the volume omni object fades out when a camera looks at it from a side.
set value -
An attenuation factor. If a too small value is provided, 1E-6 will be used instead.
float Radius#
The size of billboards.
set
Sets the width of billboards at the edges.
set value -
A new width in units. If a negative value is provided, 0 will be used instead.
float Height#
The height of the central flat rectangle in units.
float Width#
The width of the central flat rectangle.
Members
static ObjectVolumeOmni ( float width, float height, float radius ) #
Constructor. Creates a new volume omni object with given properties.Arguments
- float width - Width of the central rectangle in units.
- float height - Height of the central rectangle in units.
- float radius - Size of billboards in units.
void SetSize ( float width, float height ) #
Sets new dimensions of the volume omni object.Arguments
- float width - New width of the central rectangle in units. If a negative value is provided, 0 will be used instead.
- float height - New height of the central rectangle in units. If a negative value is provided, 0 will be used instead.
static int type ( ) #
Returns the type of the node.Return value
Object type identifier.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)