This page has been translated automatically.
Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Программирование на C#
Рендеринг
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров узла
Setting Up Materials
Setting Up Properties
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
UnigineScript
C++
C#
Унифицированный язык шейдеров UUSL
File Formats
Rebuilding the Engine Tools
GUI
Двойная точность координат
API
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
Работа с контентом
Оптимизация контента
Материалы
Art Samples
Tutorials
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии 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 <UnigineCIGIConnector.h>

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

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

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

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

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

Return value

Sea Surface Height parameter value.

float getTemperature ( ) #

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

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