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)
VR Development
Двойная точность координат
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
Учебные материалы
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

CigiMaritimeControl 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

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

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

Return value

Surface Conditions Enable parameter value: 1 - surface conditions are to be defined by this packet; 0 - surface conditions within the region or entity will be the same as the global maritime surface conditions.

int getWhitecapEnabled ( ) const#

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

Return value

Whitecap Enable parameter value: 1 if whitecaps are enabled; otherwise, 0.

int getScope ( ) const#

Returns the value of the Scope parameter specified in the packet. Determines whether the weather is global, regional, or assigned to an entity.

Return value

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

float getHeight ( ) const#

Returns the value of the Sea Surface Height parameter to be specified in the packet.

Return value

Sea Surface Height parameter value.

float getTemperature ( ) const#

Returns the value of the Surface Water Temperature parameter to be specified in the packet.

Return value

Surface Water Temperature parameter value, in degrees Celsius.

float getClarity ( ) const#

Returns the value of the Surface Clarity parameter to be specified in the packet.

Return value

Surface Clarity parameter value in the [0; 100] range.
Last update: 19.12.2023
Build: ()