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.
No language code for this page. You can select other language.
No language code for this page,
shown in other instead.
shown in other instead.
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.
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.
- A FieldShoreline class to create a FieldShoreline object by using C++, C# or UnigineScript API.
Adding Field Shoreline
To add a shoreline field in the world via UnigineEditor, do the following:
- On the Menu bar, choose Create -> Effect -> Field Shoreline.
- Place the shoreline field in the world so that it intersects Global Water object.
Make sure that the FieldShoreline interaction option is enabled for water_global_base material.
- Go to the FieldShoreline node's Field tab, set up necessary parameters and grab the shoreline texture.
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 tab of the Nodes panel, the following parameters of the shoreline field can be adjusted:
Setting Bit Masks
|Field||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||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.|
|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: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)