BlueSkies for Unity  1.8.1
BlueSkies.Atmosphere Class Reference

Represents the atmosphere that includes sun, moon, and sky light. More...

Inheritance diagram for BlueSkies.Atmosphere:
BlueSkies.IAtmosphere

Public Member Functions

void initialize (IBlueSkiesTime time)
 
void update (IBlueSkiesTime time, float refreshRate)
 
bool isSunBelowHorizon ()
 
bool isMoonBelowHorizon ()
 
bool isSunRising ()
 
bool isMoonRising ()
 
Color getSunOrMoonColor ()
 

Properties

Color SunColor [get]
 
Color MoonColor [get]
 
Color AmbientColor [get]
 
Vector3 SunPosition [get]
 
Vector3 MoonPosition [get]
 
ISun getSun [get]
 
- Properties inherited from BlueSkies.IAtmosphere
Color SunColor [get]
 
Color MoonColor [get]
 
Color AmbientColor [get]
 
Vector3 SunPosition [get]
 
Vector3 MoonPosition [get]
 
ISun getSun [get]
 

Detailed Description

Represents the atmosphere that includes sun, moon, and sky light.

Member Function Documentation

Color BlueSkies.Atmosphere.getSunOrMoonColor ( )

Gets either the sun or moon color, based on sun positioning in relation to the horizon.

Returns
The sun or moon color.

Implements BlueSkies.IAtmosphere.

void BlueSkies.Atmosphere.initialize ( IBlueSkiesTime  time)

Initializes Sky Sun Moon and Stars with there respective prefabs

Parameters
[in]timeBlueSkiesTime for star placement

Implements BlueSkies.IAtmosphere.

bool BlueSkies.Atmosphere.isMoonBelowHorizon ( )

Checks if the Moon is below the horizon

Returns
TRUE if check is successful

Implements BlueSkies.IAtmosphere.

bool BlueSkies.Atmosphere.isMoonRising ( )

Check if the Moon is rising

Returns
TRUE if check is successful

Implements BlueSkies.IAtmosphere.

bool BlueSkies.Atmosphere.isSunBelowHorizon ( )

Checks if the Sun is below the horizon

Returns
TRUE if check is successful

Implements BlueSkies.IAtmosphere.

bool BlueSkies.Atmosphere.isSunRising ( )

Check if the Sun is rising

Returns
TRUE if check is successful

Implements BlueSkies.IAtmosphere.

void BlueSkies.Atmosphere.update ( IBlueSkiesTime  time,
float  refreshRate 
)

Updates all Celestial Objects

Parameters
[in]timeCurrent BlueSkiesTime

Implements BlueSkies.IAtmosphere.


The documentation for this class was generated from the following file: