This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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.
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 IsEllipse#

A value indicating if the field animation is of an ellipse shape.
set
Transforms a cubical Field Animation into an ellipse-shaped one.
set value - 1 for the ellipse-shaped field animation, 0 for the cubical 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 FieldAnimation Cast ( Node node ) #

Casts a FieldAnimation out of the Node instance.

Arguments

  • Node node - Node instance.

Return value

FieldAnimation instance.

static FieldAnimation Cast ( Field base ) #

Casts a FieldAnimation out of the Field instance.

Arguments

  • Field base - Field instance.

Return value

FieldAnimation instance.

static int type ( ) #

Returns the type of the object.

Return value

FieldAnimation type identifier.
Last update: 2019-08-16
Build: ()