TimeOfDay Class Reference
[Miscellaneous]
Environmental object that triggers a day/night cycle in level.
More...
List of all members.
Public Member Functions |
| void | addTimeOfDayEvent (float elevation, string identifier) |
| void | animate (float elevation, float degreesPerSecond) |
| void | setDayLength (float seconds) |
| void | setPlay (bool enabled) |
| void | setTimeOfDay (float time) |
Public Attributes |
|
|
| float | axisTilt |
| | The angle in degrees between global equator and tropic.
|
| float | azimuthOverride |
| float | dayLength |
| | The length of a virtual day in real world seconds.
|
| float | dayScale |
| | Scalar applied to time that elapses while the sun is up.
|
| float | nightScale |
| | Scalar applied to time that elapses while the sun is down.
|
| bool | play |
| | True when the TimeOfDay object is operating.
|
| float | startTime |
| float | time |
| | Current time of day.
|
Static Public Attributes |
| static bool | isRenderable |
| | Disables rendering of all instances of this type.
|
| static bool | isSelectable |
| | Disables selection of all instances of this type.
|
Detailed Description
Environmental object that triggers a day/night cycle in level.
- Note:
- TimeOfDay only works in Advanced Lighting with a Sub object or ScatterSky
- Example:
-
Member Function Documentation
| void TimeOfDay::addTimeOfDayEvent |
( |
float |
elevation, |
|
|
string |
identifier | |
|
) |
| | |
| void TimeOfDay::animate |
( |
float |
elevation, |
|
|
float |
degreesPerSecond | |
|
) |
| | |
| void TimeOfDay::setDayLength |
( |
float |
seconds |
) |
|
| void TimeOfDay::setPlay |
( |
bool |
enabled |
) |
|
| void TimeOfDay::setTimeOfDay |
( |
float |
time |
) |
|
Member Data Documentation
The angle in degrees between global equator and tropic.
The length of a virtual day in real world seconds.
Scalar applied to time that elapses while the sun is up.
Scalar applied to time that elapses while the sun is down.