Class PlanetParameters

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Index

Constructors

Accessors

atmosphereHeight atmosphereTint mieHeightScale ozoneHeightScale planetRadius position rayleighHeightScale

Methods

markAsDirty modify

Constructors

constructor

new PlanetParameters(isInternalConstructor?: boolean): PlanetParameters
Parameters
- OptionalisInternalConstructor: boolean
Returns PlanetParameters

Overrides FrameworkObject.constructor

Accessors

atmosphereHeight

get atmosphereHeight(): number

Height of planet atmosphere to be used in analytical sky model. In kilometers. Raising this values provokes molecules density to lower as they sparse through the volume. Default is earth atmosphere height.

Returns number
set atmosphereHeight(value: number): void
Parameters
- value: number
Returns void

atmosphereTint

get atmosphereTint(): Immutable<Vector3>

Color of directional light associated with the Sky atmosphere.

Returns Immutable<Vector3>
set atmosphereTint(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

mieHeightScale

get mieHeightScale(): number

The higher this value - the higher the density of the molecules reaches causing rayleigh scattering. Default value (1.0f) means Earth's atmosphere value. Ref: https://en.wikipedia.org/wiki/Mie_scattering.

Returns number
set mieHeightScale(value: number): void
Parameters
- value: number
Returns void

ozoneHeightScale

get ozoneHeightScale(): number

The higher this value - the higher the density of the molecules reaches causing rayleigh scattering. Default value (1.0f) means Earth's atmosphere value. Ref: https://en.wikipedia.org/wiki/Ozone_layer.

Returns number
set ozoneHeightScale(value: number): void
Parameters
- value: number
Returns void

planetRadius

get planetRadius(): number

Radius of planet to be used in analytical sky model. In kilometers. Default is earth radius.

Returns number
set planetRadius(value: number): void
Parameters
- value: number
Returns void

position

get position(): Immutable<Vector3>

The current position of the planet.

Returns Immutable<Vector3>
set position(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

rayleighHeightScale

get rayleighHeightScale(): number

The higher this value - the higher the density of the molecules reaches causing mie scattering. Default value (1.0f) means Earth's atmosphere value. Ref: https://en.wikipedia.org/wiki/Rayleigh_scattering.

Returns number
set rayleighHeightScale(value: number): void
Parameters
- value: number
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: () => void
  The scope where the object is modified.
Returns void