Unigine::FieldAnimation Class

FieldAnimation Class

Members

---

static FieldAnimationPtr create ( const Math::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

• const Math::vec3 & size - A size of the field animation along X, Y and Z axes in units.

Ptr<FieldAnimation> cast( const Ptr<Node> & node )

Casts a FieldAnimation out of the Node instance.

Arguments

• const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to FieldAnimation.

Ptr<FieldAnimation> cast( const Ptr<Field> & base )

Casts a FieldAnimation out of the Field instance.

Arguments

• const Ptr<Field> & base - Pointer to Field.

Return value

Pointer to FieldAnimation.

void setAnimationScale( float scale )

Sets the animation scale value indicating the scale for speed of vegetation swaying.

Arguments

• float scale - The scale for speed of vegetation swaying value.

float getAnimationScale( )

Returns the animation scale value indicating the scale for speed of vegetation swaying.

Return value

The scale for speed of vegetation swaying value.

void setAttenuation( float attenuation )

Sets an attenuation coefficient value for the Field Animation.

Arguments

• float attenuation - An attenuation coefficient value. If a too small value is provided, 1E-6 will be used instead.

float getAttenuation( )

Returns the current attenuation coefficient for the Field Animation.

Return value

The current attenuation coefficient value.

void setEllipse( int ellipse )

Transforms a cubical Field Animation into an ellipse-shaped one.

Arguments

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

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 setLeaf( float leaf )

Sets a leaf animation coefficient value.

Arguments

• float leaf - A new leaf coefficient value. If a negative value is provided, 0 will be used instead.

float getLeaf( )

Returns the current leaf animation coefficient value.

Return value

The leaf animation coefficient value.

void setSize( const Math::vec3 & size )

Sets an animation field size.

Arguments

• const Math::vec3 & size - 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.

Math::vec3 getSize( )

Returns the animation field size.

Return value

The current animation field size along the X, Y and Z axes in units.

void setStem( float stem )

Sets a stem animation coefficient value.

Arguments

• float stem - A new stem animation coefficient value. If a negative value is provided, 0 will be used instead.

float getStem( )

Returns the current stem animation coefficient value.

Return value

The stem animation coefficient value.

void setWind( const Math::vec3 & wind )

Sets wind coefficients values.

Arguments

• const Math::vec3 & wind - Wind coefficients values along the X, Y and Z directions.

Math::vec3 getWind( )

Returns the wind coefficients values.

Return value

The current wind coefficients values along the X, Y and Z directions.

int type( )

Returns the type of the object.

Return value

FieldAnimation type identifier.