Class AtmosphereController
This component controls the sky and atmosphere of the scene.
Inheritance
Implements
Inherited Members
Namespace: Evergine.Components.Environment
Assembly: Evergine.Components.dll
Syntax
public class AtmosphereController : Behavior, IDependencyObjectConstructors
AtmosphereController()
Initializes a new instance of the AtmosphereController class.
Declaration
public AtmosphereController()Properties
AtmosphereRadiusInKm
Gets or sets the atmosphere radius in km.
Declaration
public float AtmosphereRadiusInKm { get; set; }Property Value
| Type | Description |
|---|---|
| float |
MiePreferredScatteringDirection
Gets or sets the Mie preferred scattering direction.
Declaration
public float MiePreferredScatteringDirection { get; set; }Property Value
| Type | Description |
|---|---|
| float |
MieScaleHeight
Gets or sets the Mie scale height in meters.
Declaration
public float MieScaleHeight { get; set; }Property Value
| Type | Description |
|---|---|
| float |
MieScatteringCoefficient
Gets or sets the Mie scattering coefficient.
Declaration
public float MieScatteringCoefficient { get; set; }Property Value
| Type | Description |
|---|---|
| float |
ModifySunColor
Gets or sets a value indicating whether the sun color is modified by atmospheric scattering.
Declaration
public bool ModifySunColor { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
PlanetRadiusInKm
Gets or sets the planet radius in km.
Declaration
public float PlanetRadiusInKm { get; set; }Property Value
| Type | Description |
|---|---|
| float |
RayleighScaleHeight
Gets or sets the Rayleigh scale height in meters.
Declaration
public float RayleighScaleHeight { get; set; }Property Value
| Type | Description |
|---|---|
| float |
RayleighScatteringCoefficient
Gets or sets the Rayleigh scattering coefficient.
Declaration
public Vector3 RayleighScatteringCoefficient { get; set; }Property Value
| Type | Description |
|---|---|
| Vector3 |
SunDiskEnabled
Gets or sets a value indicating whether the Sun's disk is enabled.
Declaration
public bool SunDiskEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
SunDiskSize
Gets or sets a value indicating the size of the Sun's disk.
Declaration
public float SunDiskSize { get; set; }Property Value
| Type | Description |
|---|---|
| float |
SunIntensity
Gets or sets the sun intensity.
Declaration
public float SunIntensity { get; set; }Property Value
| Type | Description |
|---|---|
| float |
Methods
OnActivated()
Invoked when the object is activated once it is attached.
Declaration
protected override void OnActivated()Overrides
OnAttached()
Invoked when the object is attached to the system.
Declaration
protected override bool OnAttached()Returns
| Type | Description |
|---|---|
| bool | True if everything is OK. |
Overrides
OnDeactivated()
Invoked when the object is deactivated.
Declaration
protected override void OnDeactivated()Overrides
OnDetach()
Invoked when the object is detached.
Declaration
protected override void OnDetach()Overrides
Update(TimeSpan)
Allows this instance to execute custom logic during its Update.
Declaration
protected override void Update(TimeSpan gameTime)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | gameTime | The game time. |