Видеоуроки
Interface
Essentials
Advanced
Полезные советы
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров узла
Setting Up Materials
Setting Up Properties
Освещение
Landscape Tool
Sandworm (Experimental)
Использование инструментов редактора для конкретных задач
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

CigiEnvironmentControl 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>

CigiEnvironmentControl Class

Members


int getRegionID ( ) #

Returns the Environmental region ID specified in the packet.

Return value

Environmental region ID.

int getRegionState ( ) #

Returns the Environmental region state specified in the packet.

Return value

Environmental region state. The following values are supported:
  • 0 - Inactive
  • 1 - Active
  • 2 - Destroyed

int getMergeWeather ( ) #

Returns the value of the Merge Weather Properties parameter specified in the packet. Determines whether atmospheric conditions within this region will be merged with those of other regions within areas of overlap.

Return value

Merge Weather Properties parameter value. The following values are supported:
  • 1 - merge
  • 0 - use the data from the last Weather Control packet.

int getMergeAerosol ( ) #

Returns the value of the Merge Aerosol Concentrations parameter specified in the packet. Determines whether atmospheric conditions within this region will be merged with those of other regions within areas of overlap.

Return value

Merge Aerosol Concentrations parameter value. The following values are supported:
  • 1 - merge
  • 0 - use the data from the last Weather Control packet.

int getMergeMaritime ( ) #

Returns the value of the Merge Maritime Surface Conditions parameter specified in the packet. Determines whether the maritime surface conditions found within this region will be merged with those of other regions within areas of overlap.

Return value

Merge Maritime Surface Conditions parameter value. The following values are supported:
  • 1 - merge
  • 0 - use the data from the last Maritime Surface Conditions Control packet.

int getMergeTerrestrial ( ) #

Returns the value of the Merge Terrestrial Surface Conditions parameter specified in the packet. Determines whether the terrestrial surface conditions found within this region will be merged with those of other regions within areas of overlap.

Return value

Merge Terrestrial Surface Conditions parameter value. The following values are supported:
  • 1 - merge
  • 0 - use the data from the last Terrestrial Surface Conditions Control packet.

double getLatitude ( ) #

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

Return value

Latitude parameter value.

double getLongitude ( ) #

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

Return value

Longitude parameter value.

float getSizeX ( ) #

Returns the value of the Size X parameter specified in the packet. Determines the length of the environmental region along its X-axis at the geoid surface.
Notice
This length does not include the width of the transition perimeter.

Return value

Size X parameter value.

float getSizeY ( ) #

Returns the value of the Size Y parameter specified in the packet. Determines the length of the environmental region along its Y-axis at the geoid surface.
Notice
This length does not include the width of the transition perimeter.

Return value

Size Y parameter value.

float getRadius ( ) #

Returns the value of the Corner Radius parameter specified in the packet. Determines the radius of the corner of the rounded rectangle. The smaller the radius, the “tighter” the corner.

Return value

Corner Radius parameter value.

float getRotation ( ) #

Returns the value of the Rotation parameter specified in the packet. Determines the yaw angle of the rounded rectangle.

Return value

Rotation parameter value.

float getTransition ( ) #

Returns the value of the Transition Perimeter parameter specified in the packet. Determines the transition perimeter around the environmental region. This perimeter is a region through which the weather conditions are interpolated between those inside the environmental region and those immediately outside the perimeter.

Return value

Transition Perimeter parameter value.
Last update: 14.01.2020