This page has been translated automatically.
Видеоуроки
Интерфейс
Основы
Продвинутый уровень
Подсказки и советы
Основы
Программирование на C#
Рендеринг
Профессиональный уровень (SIM)
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Контроль версий
Настройки и предпочтения
Работа с проектами
Настройка параметров ноды
Setting Up Materials
Настройка свойств
Освещение
Sandworm
Использование инструментов редактора для конкретных задач
Расширение функционала редактора
Встроенные объекты
Ноды (Nodes)
Объекты (Objects)
Эффекты
Декали
Источники света
Geodetics
World-ноды
Звуковые объекты
Объекты поиска пути
Player-ноды
Программирование
Основы
Настройка среды разработки
Примеры использования
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Плагины
Форматы файлов
Материалы и шейдеры
Rebuilding the Engine Tools
Интерфейс пользователя (GUI)
Двойная точность координат
API
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
Rendering-Related Classes
VR-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Визуальный редактор материалов
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Учебные материалы

CigiTerrestrialControl 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

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

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

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

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

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

Return value

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

int getCoverage ( ) const#

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: 15.03.2023
Build: ()