Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes

Field Animation

An animation field is an object, specifying geometry areas of grass and vegetation that should be animated. It affects animation parameters of grass, leaf and stem materials applied to grass and vegetation.

Notice
These parameters will be affected by the animation field only when the Field mode is set for the Animation option of the corresponding material on the States tab.

An animation field can be used, for example, to create local rotor downwash effects on grass and trees.

Notice
The maximum amount of the rendered field animations per frame/bit mask — 8.

See also

  • A FieldAnimation class to edit animation fields by using UnigineScript.
  • A set of samples located in the data/samples/fields/ folder:
    • animation_00
    • animation_01

Animating Geometry with Animation Field

To animate some specific part of grass or vegetation with an animation field, do the following:

  1. Add an animation field to the world: on the Menu bar, choose Create -> Effect -> Field Animation and place the node in the world.

    Notice
    The animation field will affect only those part of grass or vegetation that is inside it.
  2. Set up the added animation field: check the Ellipse option (if required), set the size of the field. For example:

  3. In the Materials window, select the material applied to grass or vegetation and go to the States tab. Change the value of the Animation option to Field. This will allow the field to affect the grass.

  4. Make sure that the Field mask of the animation field matches the Field mask of the grass object or stem and leaf materials (in case of animating vegetation).
  5. On the Field tab of the Nodes window, specify the required animation parameters. For example, you can increase the Stem option to 3 so that the movement amplitude of the grass inside the animation field differs from the movement amplitude of all the other polygons.

    In the result, animation of the grass area inside the animation field will visually differ from the grass outside the field.

Editing Field Animation

On the Field tab of the Nodes panel, the following parameters of the animation field can be adjusted:

Setting Form of Spacer

Ellipse Indicates whether the animation field is ellipsoid-shaped. If unchecked, the animation field has a form of a cube.

Setting Bit Masks

Field A field mask. A bit mask that specifies an area of the animation field to be applied to grass or vegetation. The animation field will be applied only if both the field and grass (or vegetation) have matching masks.
Viewport A viewport mask. A bit mask for rendering the animation field into the current viewport. For the animation field to be rendered into the viewport, its mask should match the camera viewport mask.

Setting Size and Attenuation

Size Size of the animation field along the axes in units.
  • If the Ellipse option is unchecked, this is the size of the animation field box along the axes.
  • If the Ellipse option is checked, these are the ellipse radius values along the axes.
Atten An attenuation factor indicating how much animation attenuates starting from the center of the animation field to its edges.
  • By the minimum value of 0, no animation will be visible.
  • The higher the value, the more intensive animation will be at the edges of the animation field.

Setting Animation Parameters

Notice
The field animation effect will not be multiplied by render animation settings.
Stem Scale for movement amplitude of grass and vegetation stems inside the animation field. It scales the Stem offset parameter of mesh_stem_base, mesh_leaf_base and grass_base materials.
Leaf Scale for rotation angle of vegetation leaves inside the animation field. It scales the Leaf offset parameter of mesh_leaf_base material.
Scale Scale for speed of vegetation swaying. It scales the Stem scale and Leaf scale parameters of mesh_stem_base, mesh_leaf_base and grass_base materials.
Wind Wind direction inside the animation field.
Last update: 2017-07-03