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
双精度坐标
应用程序接口
Animations-Related Classes
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
VR-Related Classes
创建内容
内容优化
材质
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Cigi::ICigiTerrestrialControl Class

Header: #include <CigiClientInterface.h>
Inherits from: ICigiHostPacket
Warning
The CIGIClient plugin is deprecated and no longer supported. For more information on working with CIGI please refer to the IG Application section.

This class represents the CIGI Terrestrial Surface Conditions Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiTerrestrialControl Class

Members


int getRegionID ( ) #

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 getSurfaceID ( ) #

Returns the value of the Surface Condition ID specified in the packet. Determines surface condition or contaminant.
Notice
Multiple conditions can be specified by sending multiple Terrestrial Surface Conditions Control packets.

Return value

Surface Condition ID parameter value. The following values are supported:
  • 0 - Dry (reset).
  • > 0 - Defined by IG.
Notice
When this parameter is set to Dry (0), all existing surface conditions will be removed within the specified scope.

int getSurfaceEnabled ( ) #

Returns the value of the Surface Condition Enable parameter specified in the packet.

Return value

Surface Condition Enable parameter: 1 - surface condition attribute identified by the Surface Condition ID parameter shall be enabled; otherwise, 0.

int getScope ( ) #

Returns the value of the Scope parameter specified in the packet. Determines whether the surface conditions are applied globally, regionally, or to an environmental entity.

Return value

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

int getSeverity ( ) #

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

Return value

Severity parameter value: 0 – 31 (least to most severe).

int getCoverage ( ) #

Returns the value of the Coverage parameter specified in the packet. Determines the degree of coverage of the specified surface contaminant.

Return value

Coverage parameter value in the [0; 100] range.
Last update: 2019-07-18
Build: ()