Class PlanetParameters

Represents the planet information.

Index

Constructors

Properties

_atmosphereHeight _atmosphereTint _mieHeightScale _ozoneHeightScale _planetRadius _position _rayleighHeightScale

Accessors

atmosphereHeight atmosphereTint mieHeightScale ozoneHeightScale planetRadius position rayleighHeightScale

Methods

assign clone isEqual isEqual

Constructors

constructor

new PlanetParameters(position?, planetRadius?, atmosphereHeight?, rayleighHeightScale?, mieHeightScale?, ozoneHeightScale?, atmosphereTint?): PlanetParameters
Parameters
- Optionalposition: Immutable<Vector3>
- OptionalplanetRadius: number
- OptionalatmosphereHeight: number
- OptionalrayleighHeightScale: number
- OptionalmieHeightScale: number
- OptionalozoneHeightScale: number
- OptionalatmosphereTint: Immutable<Vector3>
Returns PlanetParameters

Properties

`Protected`_atmosphereHeight

_atmosphereHeight: number

`Protected`_atmosphereTint

_atmosphereTint: Vector3

`Protected`_mieHeightScale

_mieHeightScale: number

`Protected`_ozoneHeightScale

_ozoneHeightScale: number

`Protected`_planetRadius

_planetRadius: number

`Protected`_position

_position: Vector3

`Protected`_rayleighHeightScale

_rayleighHeightScale: number

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): void
Parameters
- value: number
Returns void

atmosphereTint

get atmosphereTint(): Vector3
Color of directional light associated with the Sky atmosphere.

Returns Vector3
set atmosphereTint(value): 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): 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): 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): void
Parameters
- value: number
Returns void

position

get position(): Vector3
The current position of the planet.

Returns Vector3
set position(value): 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): void
Parameters
- value: number
Returns void

Methods

assign

assign(other): PlanetParameters
Copies all properties defined by the prototype of PlanetParameters from other to this instance.
Parameters
- other: Immutable<PlanetParameters>
Returns PlanetParameters

clone

clone(): PlanetParameters
Clones this instance and returns a new PlanetParameters with identical values.

Returns PlanetParameters

isEqual

isEqual(this, other): boolean
Determines if this PlanetParameters instance is equal to the other instance.
Parameters
- this: Immutable<PlanetParameters>
- other: Immutable<PlanetParameters>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both PlanetParameters instances are equal.
Parameters
- lhs: Immutable<PlanetParameters>
- rhs: Immutable<PlanetParameters>
Returns boolean