This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
专业(SIM)
UnigineEditor
界面概述
资源工作流程
版本控制
设置和首选项
项目开发
调整节点参数
Setting Up Materials
设置属性
照明
Sandworm
使用编辑器工具执行特定任务
如何擴展編輯器功能
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
使用范例
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
Rendering-Related Classes
创建内容
内容优化
材质
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
注意! 这个版本的文档是过时的,因为它描述了一个较老的SDK版本!请切换到最新SDK版本的文档。
注意! 这个版本的文档描述了一个不再受支持的旧SDK版本!请升级到最新的SDK版本。

CigiWaveControl 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/Unigine/CIGIConnector/UnigineCIGIConnector.h>
Inherits from: CigiHostPacket

CigiWaveControl Class

Members


int getRegionID ( ) const#

Returns the Environmental region ID specified in the packet.

Return value

  • Entity ID if Scope is set to Entity (2).
  • Region ID if Scope is set to Regional (1).
Notice
This value will be ignored if Scope is set to Global (0).

int getWaveID ( ) const#

Returns the value of the Wave ID specified in the packet.

Return value

Wave ID parameter value.

int getWaveEnabled ( ) const#

Returns the value of the Wave Enable parameter specified in the packet.

Return value

Wave Enable parameter: 1 - wave is enabled and will contribute to the shape of water's surface; otherwise, 0.

int getScope ( ) const#

Returns the value of the Scope parameter specified in the packet. Determines whether the wave is defined for global, regional, or entity-controlled maritime surface conditions.

Return value

Scope parameter value. The following values are supported:
  • 0 - Global
  • 1 - Regional
  • 2 - Entity

int getBreaker ( ) const#

Returns the value of the Breaker Type parameter specified in the packet.

Return value

Breaker Type parameter value. The following values are supported:
  • 0 - Plunging. Plunging waves peak until the wave forms a vertical wall, at which point the crest moves faster than the base of the breaker. The wave shall then break violently into the wave trough.
  • 1 - Spilling. Spilling breakers break gradually over a great distance. White water shall form over the crest, which spills down the face of the breaker.
  • 2 - Surging. Surging breakers advance toward the beach as vertical walls of water. Unlike with plunging and spilling breakers, the crest shall not fall over the front of the wave.

float getHeight ( ) const#

Returns the value of the Wave Height parameter specified in the packet.

Return value

Wave Height parameter value.

float getLength ( ) const#

Returns the value of the Wavelength parameter specified in the packet.

Return value

Wavelength parameter value.

float getPeriod ( ) const#

Returns the value of the Period parameter specified in the packet. Determines the time required for one complete oscillation of the wave.

Return value

Period parameter value.

float getWindDirection ( ) const#

Returns the value of the Wind Direction parameter specified in the packet. Determines the direction in which the wave propagates.

Return value

Direction parameter value in the [0; 360] range.

float getOffset ( ) const#

Returns the value of the Phase Offset parameter specified in the packet. Determines the phase offset of the wave.

Return value

Phase Offset parameter value in the [-360; 360] range.

float getLeading ( ) const#

Returns the value of the Leading parameter specified in the packet.

Return value

Leading parameter value.
Last update: 2023-06-23
Build: ()