Unigine.ObjectVolumeProj Class
| Inherits: | Object |
This class is used to create a volume projected object that simulates a light beam from a directional light source. It can be animated to create a flow of particles moving to the end of the beam and rotating, if necessary.
Projected volume object is rendered as a number of billboards, where each following billboard is bigger than the previous one.
See Also#
A UnigineScript API sample <UnigineSDK>/data/samples/objects/volumes_04
ObjectVolumeProj Class
Properties
float VolumeRotation#
The angle of billboards rotation. this angle is set for the billboard at the end of the beam. if a positive value is set, the billboards will be rotated clockwise; if a negative value is set, the billboards will be rotated counterclockwise.
set
Sets an angle of billboards rotation. This angle is set for the billboard at the end of the light beam.
set value -
A rotation angle. If a positive value is set, the billboards will be rotated clockwise; if a negative value is set, the billboards will be rotated counterclockwise.
float Velocity#
The velocity with which billboards move to the end of the light beam.
set
Sets a velocity with which billboards move to the end of the light beam.
set value -
Velocity of billboards.
float Step#
The distance between neighboring billboards. the step controls how many billboards are used to render the volume projected object. the bigger the step, the less billboards are used to render the object.
set
Sets a step between neighboring billboards. The step controls how many billboards are used to render the volume projected object. The bigger the step, the less billboards are used to render the object.
set value -
Step between billboards. The provided value will be saturated in the range [0.1; 1]. By the value of 1, the beam is rendered discrete.
float Fov#
The width of the light beam, which is specified as the angle of the beam cone.
set
Sets the width of the light beam, which is specified as an angle of the beam cone.
set value -
Angle in degrees. The provided value will be saturated in the range [10;90].
float Radius#
The length of the light beam along the z axis in units.
set
Sets a length of the light beam.
set value -
Length in units. If a negative value is provided, 0 will be used instead.
float Size#
The size of the smallest billboard at the beginning of the light beam.
set
Sets a size of the smallest billboard at the beginning of the light beam.
set value -
Size of the smallest billboard in units. If a too small value is provided, 0.001 will be used instead.
Members
static ObjectVolumeProj ( float width, float height, float fov ) #
Constructor. Creates a new volume projected object with the given properties.Arguments
- float width - Size of the smallest billboard in units.
- float height - Length of the light beam along the Z axis in units.
- float fov - Angle of the beam cone in degrees. It controls the width of the light beam.
static int type ( ) #
Returns the type of the node.Return value
Object type identifier.Last update:
2020-04-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)