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
Программирование
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
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

Field Shoreline

A field shoreline is an object, specifying global water areas where swash zone should be located. Field Shoreline helps to create swashes near the shores and applies the wetness effect on objects near the shoreline.

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

Swash zone created by using FieldShoreline object.
Notice
The maximum number of FieldShorelines rendered per frame/bit mask is limited to:
  • 113 (DirectX)
  • 14 (OpenGL)

See also

  • A FieldShoreline class to create a FieldShoreline object by using C++, C# or UnigineScript API.
  • A render_field_shoreline_resolution console command to change the resolution of the texture into which all textures set for the object are rendered.

Adding Field Shoreline

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

  1. On the Menu bar, choose Create -> Effect -> Field Shoreline.

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

Setting Up Field Shoreline

On the Field Shoreline tab of the Parameters window, the following parameters of the shoreline field can be adjusted:

Setting Bit Masks

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

Setting Shoreline Parameters

Size Size of the shoreline field along the axes in units. Big sized FiledShoreline object provides less detailed swash zones.
Texture Shoreline texture. Grab the texture to fill that field.

Grabber Parameters

Distance Padding distance (from shore to the beginning of swash).
Blur Blur coefficient (make shoreline smoother).
Resolution Grabbing texture resolution.
Grab texture Grabbing texture button.
Last update: 10.08.2018
Build: ()