Class AnalyticalSkyParameters

Represents the analytical sky full information.

Constructors

  • Parameters

    • OptionalisEnabled: boolean
    • Optionalplanets: Iterable<PlanetParameters>
    • OptionalisSunCastingShadows: boolean
    • OptionalsunAltitude: rsx.Degree
    • OptionalsunAzimuth: rsx.Degree
    • OptionalsunSize: number
    • OptionalsunCoronaSize: number
    • OptionalsunIntensity: number
    • OptionalsunTint: Immutable<Vector3>
    • OptionalisMoonEnabled: boolean
    • OptionalmoonAltitude: rsx.Degree
    • OptionalmoonAzimuth: rsx.Degree
    • OptionalmoonSize: number
    • OptionalmoonBrightness: number
    • OptionalmoonTint: Immutable<Vector3>
    • OptionalisMoonCastingShadows: boolean
    • OptionalisMoonRenderToSkyboxEnabled: boolean
    • OptionalisStarsEnabled: boolean
    • OptionalstarsSize: number
    • OptionalstarsBrightness: number
    • OptionalisRenderingStarsAsOnePixel: boolean
    • OptionalisRenderingStarsAllWhite: boolean
    • OptionalisRenderingStarsWithSameBrightness: boolean
    • OptionalisRenderingTexturedStars: boolean
    • OptionalisStarsRenderToSkyboxEnabled: boolean
    • OptionaltimeAndLocation: Immutable<TimeAndLocation>
    • OptionalisAerialViewEnabled: boolean
    • Optionalposition: Immutable<Vector3>
    • OptionalplanetRadius: number
    • OptionalatmosphereHeight: number
    • OptionalrayleighHeightScale: number
    • OptionalmieHeightScale: number
    • OptionalozoneHeightScale: number
    • OptionalatmosphereTint: Immutable<Vector3>

    Returns AnalyticalSkyParameters

Properties

_atmosphereHeight: number
_atmosphereTint: Vector3
_isAerialViewEnabled: boolean
_isEnabled: boolean
_isMoonCastingShadows: boolean
_isMoonEnabled: boolean
_isMoonRenderToSkyboxEnabled: boolean
_isRenderingStarsAllWhite: boolean
_isRenderingStarsAsOnePixel: boolean
_isRenderingStarsWithSameBrightness: boolean
_isRenderingTexturedStars: boolean
_isStarsEnabled: boolean
_isStarsRenderToSkyboxEnabled: boolean
_isSunCastingShadows: boolean
_mieHeightScale: number
_moonAltitude: rsx.Degree
_moonAzimuth: rsx.Degree
_moonBrightness: number
_moonSize: number
_moonTint: Vector3
_ozoneHeightScale: number
_planetRadius: number
_planets: PlanetParameters[]
_position: Vector3
_rayleighHeightScale: number
_starsBrightness: number
_starsSize: number
_sunAltitude: rsx.Degree
_sunAzimuth: rsx.Degree
_sunCoronaSize: number
_sunIntensity: number
_sunSize: number
_sunTint: Vector3
_timeAndLocation: TimeAndLocation

Accessors

  • 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

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

    Returns Vector3

  • set atmosphereTint(value): void
  • Parameters

    Returns void

  • get isAerialViewEnabled(): boolean
  • Whether use the aerial view to travel through the atmosphere.

    Returns boolean

  • set isAerialViewEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isEnabled(): boolean
  • Enables or disables Analytical Sky.

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isMoonCastingShadows(): boolean
  • Moon light will casts shadows if true.

    Returns boolean

  • set isMoonCastingShadows(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isMoonEnabled(): boolean
  • Enables/disables rendering of the moon.

    Returns boolean

  • set isMoonEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isMoonRenderToSkyboxEnabled(): boolean
  • Determines if moon is added to the skybox. Only works when not using a unique skybox texture.

    Returns boolean

  • set isMoonRenderToSkyboxEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isRenderingStarsAllWhite(): boolean
  • Determines if stars are all white colored.

    Returns boolean

  • set isRenderingStarsAllWhite(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isRenderingStarsAsOnePixel(): boolean
  • Determines if stars are drawn as pixels.

    Returns boolean

  • set isRenderingStarsAsOnePixel(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isRenderingStarsWithSameBrightness(): boolean
  • Determines if stars are all same brightness.

    Returns boolean

  • set isRenderingStarsWithSameBrightness(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isRenderingTexturedStars(): boolean
  • Determines if stars are textured or not.

    Returns boolean

  • set isRenderingTexturedStars(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isStarsEnabled(): boolean
  • Enables/disables rendering of the stars.

    Returns boolean

  • set isStarsEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isStarsRenderToSkyboxEnabled(): boolean
  • Determines if stars are added to the skybox. Only works when not using a unique skybox texture.

    Returns boolean

  • set isStarsRenderToSkyboxEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isSunCastingShadows(): boolean
  • Sun light will casts shadows if true.

    Returns boolean

  • set isSunCastingShadows(value): void
  • Parameters

    • value: boolean

    Returns void

  • 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

  • get moonAltitude(): rsx.Degree
  • Moon altitude, [-90;90], 0 locates in the horizon, 90 is Moon at zenith. In degrees.

    Returns rsx.Degree

  • set moonAltitude(value): void
  • Parameters

    Returns void

  • get moonAzimuth(): rsx.Degree
  • Moon azimuth, [0; 360]. In degrees.

    Returns rsx.Degree

  • set moonAzimuth(value): void
  • Parameters

    Returns void

  • get moonBrightness(): number
  • Moon radiance multiplier.

    Returns number

  • set moonBrightness(value): void
  • Parameters

    • value: number

    Returns void

  • get moonSize(): number
  • The size scale of the Moon.

    Returns number

  • set moonSize(value): void
  • Parameters

    • value: number

    Returns void

  • 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

  • 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

  • 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

  • get starsBrightness(): number
  • Stars radiance multiplier.

    Returns number

  • set starsBrightness(value): void
  • Parameters

    • value: number

    Returns void

  • get starsSize(): number
  • The size scale of the stars. Just pure draw value.

    Returns number

  • set starsSize(value): void
  • Parameters

    • value: number

    Returns void

  • get sunAltitude(): rsx.Degree
  • Sun altitude, [-90;90], 0 is dusk/dawn, 90 is sun at zenith. In degrees.

    Returns rsx.Degree

  • set sunAltitude(value): void
  • Parameters

    Returns void

  • get sunAzimuth(): rsx.Degree
  • Sun azimuth, [0; 360] In degrees.

    Returns rsx.Degree

  • set sunAzimuth(value): void
  • Parameters

    Returns void

  • get sunCoronaSize(): number
  • The Sun corona's size. Just pure draw value, it doesn't affect on atmosphere intensities.

    Returns number

  • set sunCoronaSize(value): void
  • Parameters

    • value: number

    Returns void

  • get sunIntensity(): number
  • Sun radiance multiplier. By default sky is as bright as Earth's Sun.

    Returns number

  • set sunIntensity(value): void
  • Parameters

    • value: number

    Returns void

  • get sunSize(): number
  • The size scale of the Sun. Just pure draw value, it affects on atmosphere intensities proportionally.

    Returns number

  • set sunSize(value): void
  • Parameters

    • value: number

    Returns void

  • get sunTint(): Vector3
  • Color of directional light associated with Analytical Sky

    Returns Vector3

  • set sunTint(value): void
  • Parameters

    Returns void

Methods