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
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::ICigiCelestialControl Class

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

This class represents the CIGI Celestial Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiCelestialControl Class

Members


int getHour( )

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

Return value

Hour parameter value in the [0; 23] range.

int getMinute( )

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

Return value

Minute parameter value in the [0; 59] range.

unsigned int getDate( )

Returns the value of the Date parameter specified in the packet. Specifies the current date within the simulation.

Return value

Date parameter value. The date shall be represented as a seven- or eight-digit decimal integer formatted as follows: MMDDYYYY = (month × 1000000) + (day × 10000) + year

int getTimeValid( )

Returns the value of the Date/Time Valid parameter specified in the packet.

Return value

Date/Time Valid parameter value: 1 if the Hour, Minute, and Date parameters are valid; otherwise, 0.

int getContinuous( )

Returns the value of the Ephemeris Model Enable parameter specified in the packet.

Return value

Ephemeris Model Enable parameter value. The following values are supported:
  • 0 - Static time of day
  • 1 - Continuous time of day

int getSunEnabled( )

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

Return value

Sun Enable parameter value: 1 if the sun is enabled; otherwise, 0.
Notice
The value of this parameter, along with the appropriate time-of-day and location on the globe specifies whether the sun is seen in the sky.

int getMoonEnabled( )

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

Return value

Moon Enable parameter value: 1 if the moon is enabled; otherwise, 0.
Notice
The value of this parameter, along with the appropriate time-of-day and location on the globe specifies whether the moon is seen in the sky.

int getStarsEnabled( )

Returns the value of the Star Field Enable parameter specified in the packet.

Return value

Star Field Enable parameter value: 1 if the stars are enabled; otherwise, 0.
Notice
The value of this parameter, along with the appropriate time-of-day and location on the globe specifies whether stars are seen in the sky.

int getStarsIntensity( )

Returns the value of the Star Field Intensity parameter specified in the packet.

Return value

Star Field Intensity parameter value in the [0; 100] range.
Last update: 2018-12-27