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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Field Height

A field height is an object, specifying global water areas where height should be changed (for wakefields, water disturbance, etc.).

Global water object has heightmap for waves and FieldHeight has its own heightmap. Inside the field, the heightmap of the global water is gradually changing from the center of the field height object.

Notice
A field height object will affect water only if the FieldHeight interaction option is enabled on the States tab of the water_global_base material.

FieldHeight objects work fine with particle systems and decal objects.

Water disturbance near the buoy is made by using FieldHeight object.
Notice
The maximum number of FieldHeights rendered per frame/bit mask is limited to:
  • 113 (DirectX)
  • 14 (OpenGL)

See also#

Adding Field Height#

To add a height field in the world via UnigineEditor, do the following:

  1. On the Menu bar, choose Create -> Water -> Field Height.

  2. Place the height field in the world so that it intersects Global Water object.
    Notice
    Make sure that the FieldHeight interaction option is enabled for water_global_base material.
  3. Go to the Field Height tab of the Parameters window and set up necessary parameters.
Notice
After adding a FieldHeight object to the scene, you can't see any changes of the global water object because FieldHeight object doesn't have any default heightmap texture.

Setting Up Field Height#

In the Field Height tab of the Parameters window, the following parameters of the height field can be adjusted:

Setting Bit Masks#

Field Mask A field mask. A bit mask that specifies an area of the height field to be applied to water. The height field will be applied to water only if they have matching masks.
Viewport Mask A viewport mask. A bit mask for rendering the height field into the current viewport. For the height field to be rendered into the viewport, its mask should match the camera viewport mask.

Setting Height Parameters#

Size Size of the height field along the axes in units.
Attenuation An attenuation factor indicating how much global water object's heights gradually changing from the center of the height field.
  • The higher the value, the less FieldHeight's heights will have influence on the Global Water's object heights.
Power Power parameter is a multiplier for FieldHeight's heightmap texture values.
  • The higher the value, the more FieldHeight's heights will have influence on the Global Water's object heights.
Order Rendering order of the Field Height. This parameter is used to properly apply fields with mixed blend modes.
Blend Mode Bending mode of the Field Height. Available values are Additive, Multiplicative.
Notice
The Attenuation parameter is interpreted depending on the selected blending mode:
  • It is used as a multiplier for the Additive mode.
  • lerp(1.0f, value, attenuation) is used for the Multiplicative mode.
Texture Heightmap R16 or R32F (1-channeled) texture (controlled by the render_field_precision console command). Heightmap texture is used to create an additional height displacement for water surface.
Last update: 2018-12-27