Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)
Controls Sky, Sun, Moon and lighting according to the
assigned DateTime value.
Namespace: Visual3D.SceneObjects.SkiesAssembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# | Visual Basic |
[SerializableAttribute] public class TimeOfDayController
<SerializableAttribute> _ Public Class TimeOfDayController
Members
| All Members | Constructors | Fields | Properties | Methods |
| Member | Description | |
|---|---|---|
| TimeOfDayController(Sky) | Initializes a new instance of the TimeOfDayController class | |
| AutoUpdateTimeScalar | ||
| DateAndTime | Gets/sets current date and time. | |
| DayHDRIntensity | ||
| DayOfYear | ||
| DayTimeFactor | Returns day time factor (0 for day, 1 for night). Updated automatically, per-frame. | |
| DayTimePeriod | Returns current period of day time (day, night, dusk or dawn). Updated automatically, per-frame. | |
| DefaultDateTime | ||
| DefaultLatitude | ||
| DefaultLongtitude | ||
| EnsureSunExists()()()() | ||
| GetSettingsEnumerator()()()() | ||
| HourOfDay | ||
| Invalidate(Boolean) | Invalidate sky and lighting parameters. | |
| IsGroundFogAutoUpdated | If set to true, ground fog will be updated automatically
according to day time settings. Default is true. | |
| IsMoonPhaseAutoUpdated | If set to true, moon phase will be updated automatically
according to relative moon and sun positions. Default is true. | |
| IsMoonPosAutoUpdated | If set to true, the position of Moon on sky will change automatically
with each change of DateAndTime value. Default is true. | |
| IsSunPosAutoUpdated | If set to true, the position of Sun on sky will change automatically
with each change of DateAndTime value. Default is true. | |
| IsTimeAutoUpdated | If set to true, time of day will change automatically, according to
Scene time and AutoUpdateTimeScalar. Default is false. | |
| Latitude | Gets/sets geographic latitude of viewpoint, measured in degrees. | |
| LightScalar | ||
| Longtitude | Gets/sets geographic longtitude of viewpoint, measured in degrees. | |
| NightHDRIntensity | ||
| NotifySunChanged(Light) | ||
| SettingsForDawn | Gets/sets light, atmosphere etc. settings for dawn time. | |
| SettingsForDay | Gets/sets light, atmosphere etc. settings for day time. | |
| SettingsForDusk | Gets/sets light, atmosphere etc. settings for dusk time. | |
| SettingsForNight | Gets/sets light, atmosphere etc. settings for night time. | |
| TimeOfDay | ||
| ToString()()()() | (Overrides Object..::..ToString()()()().) | |
| TotalHoursInDay | ||
| TotalMinutesInDay | ||
| Update()()()() | Performs update of scene lighting, sun and moon positions
and atmosphere/fog settings based on current time, location and
active TimeOfDaySettings. |
Inheritance Hierarchy
System..::..Object
Visual3D.SceneObjects.Skies..::..TimeOfDayController
Visual3D.SceneObjects.Skies..::..TimeOfDayController