UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

FieldAnimation Class

This class allows you to create and modify field animation objects.

FieldAnimation Class

This class inherits from Field

Members


FieldAnimation (vec3 size)

Creates a Field Animation node of the specified size.

Arguments

  • vec3 size - A size of the Field Animation in units.

float getAttenuation ()

Returns the current attenuation coefficient for the Field Animation.

Return value

Attenuation coefficient value.

float getLeaf ()

Returns a leaf animation coefficient value.

Return value

Leaf animation coefficient value.

float getScale ()

Returns an animation scale coefficient value.

Return value

Animation scale coefficient value.

vec3 getSize ()

Returns an animation field size.

Return value

Animation field size along X, Y and Z axes in units.

float getStem ()

Returns a stem animation coefficient value.

Return value

Stem animation coefficient value.

vec3 getWind ()

Returns a wind coefficients values.

Return value

Wind coefficients values along X, Y and Z directions.

int isEllipse ()

Returns a value indicating if the Field Animation is of an ellipse shape.

Return value

1 if the Field Animation is of an ellipse shape, otherwise - 0.

void setAttenuation (float attenuation)

Sets an attenuation coefficient value for the Field Animation.

Arguments

  • float attenuation - Attenuation coefficient value.

void setEllipse (int ellipse)

Sets a cubical Field Animation into an ellipse shaped one.

Arguments

  • int ellipse - 1 for ellipse shaped Field Animation, 0 - for cubical one.

void setLeaf (float leaf)

Sets a leaf animation coefficient value.

Arguments

  • float leaf - Leaf coefficient value.

void setScale (float scale)

Sets an animation scale coefficient value.

Arguments

  • float scale - Animation scale coefficient value.

void setSize (vec3 size)

Sets an animation field size.

Arguments

  • vec3 size - Animation field size along X, Y and Z axes in units.

void setStem (float stem)

Sets a stem animation coefficient value.

Arguments

  • float stem - Stem animation coefficient value.

void setWind (vec3 wind)

Sets a wind coefficients values.

Arguments

  • vec3 wind - Wind coefficients values along X, Y and Z directions.
Last update: 2017-07-03