Unigine.FieldAnimation Class
| Inherits: | Field |
This class allows you to create and modify field animation objects.
See also#
- A set of UnigineScript samples located in the <UnigineSDK>/data/samples/fields/ folder:
- animation_00
- animation_01
FieldAnimation Class
Properties
vec3 Wind#
The wind coefficients values.
set
Sets wind coefficients values that define wind direction inside the animation field.
set value -
Wind coefficients values along the X, Y and Z directions.
float AnimationScale#
The animation scale value indicating the scale for speed of vegetation swaying.
set
Sets the animation scale value indicating the scale for speed of vegetation swaying.
set value -
The scale for speed of vegetation swaying value.
float Leaf#
The current leaf animation coefficient value.
set
Sets a leaf animation coefficient value.
set value -
Scale for the rotation angle of vegetation leaves. If a negative value is provided, 0 will be used instead.
float Stem#
The current stem animation coefficient value.
set
Sets a stem animation coefficient value.
set value -
Scale for movement amplitude of grass and vegetation stems. If a negative value is provided, 0 will be used instead.
float Attenuation#
The current attenuation coefficient for the field animation.
set
Sets an attenuation coefficient value for the Field Animation.
set value -
An attenuation coefficient value. If a too small value is provided, 1E-6 will be used instead.
vec3 Size#
The animation field size.
set
Sets an animation field size.
set value -
A new animation field size along the X, Y and Z axes in units. If a negative value is provided, 0 will be used instead.
bool Ellipse#
A value indicating if the field animation is of an ellipse shape.
set
Transforms a cube-shaped field animation into an ellipse-shaped one or vice versa.
set value -
true for the ellipse-shaped Field Animation, false for the cube-shaped one.
Members
static FieldAnimation ( vec3 size ) #
Creates a new field animation node of the specified size:- If the field animation is of an ellipse shape, its radius values along the axes must be specified.
- Otherwise, dimensions of the cube must be specified.
Arguments
- vec3 size - A size of the field animation along X, Y and Z axes in units.
static int type ( ) #
Returns the type of the object.Return value
FieldAnimation type identifier.Last update:
2021-02-17
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)