UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
编程
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
应用程序接口
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
Rendering-Related Classes

Unigine::Cigi::ICigiWeatherControl Class

Header: #include <CigiClientInterface.h>
Inherits: ICigiHostPacket
Warning
The CIGIClient plugin is deprecated and no longer supported. For more information on working with CIGI please refer to the IG Application section.

This class represents the CIGI Weather Control packet interface.

Notice
CIGI plugin must be loaded.

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

Returns the layer ID specified in the packet.

Return value

Layer ID. The following values are supported:
  • 0 - Ground Fog
  • 1 - Cloud Layer 1
  • 2 - Cloud Layer 2
  • 3 - Cloud Layer 3
  • 4 - Rain
  • 5 - Snow
  • 6 - Sleet
  • 7 - Hail
  • 8 - Sand
  • 9 - Dust
  • 10 – 255 - Defined by IG

int getWeatherEnabled ( ) #

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

Return value

Weather Enable parameter value: 1 if a weather layer/entity and its atmospheric effects are enabled; otherwise, 0.

int getScudEnabled ( ) #

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

Return value

Scud Enable parameter value: 1 if the weather layer produces scud effects within its transition bands; otherwise, 0.

int getWindEnabled ( ) #

Returns the value of the Random Winds Enable parameter specified in the packet.

Return value

Random Winds Enable parameter value: 1 if a random frequency and duration will be applied to the local wind effects; otherwise, 0.

int getLightingEnabled ( ) #

Returns the value of the Random Lightning Enable parameter specified in the packet.

Return value

Random Lightning Enable parameter value: 1 if the weather layer or entity exhibits random lightning effects; otherwise, 0.
Notice
The frequency and severity of the lightning shall vary according to the Severity parameter

int getCloudType ( ) #

Returns the value of the Cloud Type parameter specified in the packet.

Return value

Cloud Type parameter value. The following values are supported:
  • 0 - None
  • 1 - Altocumulus
  • 2 - Altostratus
  • 3 - Cirrocumulus
  • 4 - Cirrostratus
  • 5 - Cirrus
  • 6 - Cumulonimbus
  • 7 - Cumulus
  • 8 - Nimbostratus
  • 9 - Stratocumulus
  • 10 - Stratus
  • 11 – 15 - Other

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

int getSeverity ( ) #

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

Return value

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

int getHumidity ( ) #

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

Return value

Humidity parameter value in the [0; 100] range.

float getTemperature ( ) #

Returns the value of the Air Temperature parameter specified in the packet.

Return value

Air Temperature parameter value, in degrees Celsius.

float getVisibility ( ) #

Returns the value of the Visibility Range parameter specified in the packet.

Return value

Visibility Range parameter value.

float getScudFrequency ( ) #

Returns the value of the Scud Frequency parameter specified in the packet.

Return value

Scud Frequency parameter value in the [0; 100] range.

float getCoverage ( ) #

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

Return value

Coverage parameter value in the [0; 100] range.

float getElevation ( ) #

Returns the value of the Base Elevation parameter specified in the packet. Determines the altitude of the base (bottom) of the weather layer.

Return value

Base Elevation parameter value.

float getThickness ( ) #

Returns the value of the Thickness parameter specified in the packet. Determines the vertical thickness of the weather layer. The altitude of the top of the layer is equal to this value plus that specified by Base Elevation.

Return value

Thickness parameter value.

float getTransition ( ) #

Returns the value of the Transition Band parameter specified in the packet. Determines the height of a vertical transition band both above and below the weather layer. This band produces a visibility gradient from the layer’s visibility to that immediately outside the transition band.

Return value

Transition Band parameter value.

float getHorizontal ( ) #

Returns the value of the Horizontal Wind Speeed parameter specified in the packet.

Return value

Horizontal Wind Speeed parameter value.

float getVertical ( ) #

Returns the value of the Vertical Wind Speeed parameter specified in the packet.

Return value

Vertical Wind Speeed parameter value.

float getDirection ( ) #

Returns the value of the Wind Direction parameter specified in the packet.

Return value

Wind Direction parameter value in the [0; 360] range.

float getPressure ( ) #

Returns the value of the Barometric Pressure parameter specified in the packet.

Return value

Barometric Pressure parameter value.

float getAerosol ( ) #

Returns the value of the Aerosol Concentration parameter specified in the packet. Determines the concentration of water, smoke, dust, or other particles suspended in the air.
Notice
This parameter is provided primarily for sensor applications; any visual effect is secondary and is IG- and layer-dependent.

Return value

Aerosol Concentration parameter value.
Last update: 2019-11-28