Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Программирование на C#
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров узла
Setting Up Materials
Setting Up Properties
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
UnigineScript
C++
C#
Унифицированный язык шейдеров UUSL
File Formats
Rebuilding the Engine Tools
GUI
Двойная точность координат
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Art Samples
Tutorials

Unigine::Plugins::IG::Water Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <plugins/UnigineIG.h>

Water Class

Members


void setWaterNode ( const ObjectWaterGlobalPtr & value ) #

Sets the Water Global object to be used.
Notice
The Water Global object is automatically found at the start of the project. Use this method only for dynamically created Water Global object.

Arguments

const ObjectWaterGlobalPtr & getWater ( ) #

Returns the currently used Water Global object.

Return value

Water Global object.

void setHeigt ( double value ) #

Sets the height of the sea level in world coordinates.

Arguments

  • double value - Sea level height, in units.

void setWaveParams ( int height, float direction ) #

Sets the wave parameters: Beaufort scale and direction.
Notice
Beaufort scale is switched immediately. Therefore, be careful when switching from big to low values.

Arguments

  • int height - Beaufort value from 0 to 12.
  • float direction - Angle relative to North.

void setClarity ( float value ) #

Sets clarity of water.

Arguments

  • float value - Water clarity from 0 (unclear) to 1 (clear).

float getClarity ( ) #

Returns clarity of water.

Return value

Water clarity from 0 to 1.

void setShorelineUpdate ( bool enable ) #

Toggles the shoreline update on and off.
Notice
By default, the shoreline update is disabled. Toggling it on may cause spikes when the sea level changes, therefore, use carefully.

Arguments

  • bool enable - 1 to enable Shoreline update, 0 to disable.

void updateShoreline ( ) #

Forced shoreline update.
Last update: 17.02.2021