Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes

Unigine::Cigi::ICigiEnvironmentControl Class

Header:#include <CigiClientInterface.h>
Inherits:ICigiHostPacket

This class represents the CIGI Environmental Region Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiEnvironmentControl 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.

Return value

Merge Weather Properties parameter. Determines whether atmospheric conditions within this region will be merged with those of other regions within areas of overlap. 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.

Return value

Merge Aerosol Concentrations parameter. Determines whether atmospheric conditions within this region will be merged with those of other regions within areas of overlap. 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.

Return value

Merge Maritime Surface Conditions parameter. Determines whether the maritime surface conditions found within this region will be merged with those of other regions within areas of overlap. 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.

Return value

Merge Terrestrial Surface Conditions parameter. Determines whether the terrestrial surface conditions found within this region will be merged with those of other regions within areas of overlap. 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.

Return value

Size X parameter value. 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.

float getSizeY()

Returns the value of the Size Y parameter specified in the packet.

Return value

Size Y parameter value. 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.

float getRadius()

Returns the value of the Corner Radius parameter specified in the packet.

Return value

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

float getRotation()

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

Return value

Rotation parameter value. Determines the yaw angle of the rounded rectangle.

float getTransition()

Returns the value of the Transition Perimeter parameter specified in the packet.

Return value

Transition Perimeter parameter value. 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.
Last update: 2017-10-20