This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
UnigineEditor
界面概述
资产工作流程
设置和首选项
项目开发
调整节点参数
Setting Up Materials
Setting Up Properties
照明
Landscape Tool
Sandworm
使用编辑器工具执行特定任务
Extending Editor Functionality
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
双精度坐标
应用程序接口
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
创建内容
Content Optimization
Materials
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 setHeight ( 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: 2021-08-24
Build: ()