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#
- The FieldHeight class to manage FieldHeight objects via API
- The render_field_height_resolution and render_field_precision console commands
Adding Field Height#
To add a height field in the world via UnigineEditor, do the following:
- On the Menu bar, choose Create -> Water -> Field Height.
- Place the height field in the world so that it intersects Global Water object.
NoticeMake sure that the FieldHeight interaction option is enabled for water_global_base material.
- Go to the Field Height tab of the Parameters window and set up necessary parameters.
Notice
After adding a Field Height object to the scene, you can't see any changes of the global water object because Field Height object doesn't have any default heightmap texture.
Setting Up Field Height#
In the Field Height section (Parameters window -> Node tab), 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.
|
| Power | Power parameter is a multiplier for FieldHeight heightmap texture values.
|
| 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:
|
| 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:
2024-04-19
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)