Class AnalyticalSkyParameters

constructor

• new AnalyticalSkyParameters(isInternalConstructor?): AnalyticalSkyParameters

• Parameters

  • OptionalisInternalConstructor: boolean

  Returns AnalyticalSkyParameters

homePlanet

• get homePlanet(): PlanetParameters

• The parameters of the planet the camera is on.

  Returns PlanetParameters
• set homePlanet(value): void

• Parameters

  • value: PlanetParameters

  Returns void

isEnabled

• get isEnabled(): boolean

• Enables or disables Analytical Sky.

  Returns boolean
• set isEnabled(value): void

• Parameters

  • value: boolean

  Returns void

isMoonCastingShadows

• get isMoonCastingShadows(): boolean

• Moon light will casts shadows if true.

  Returns boolean
• set isMoonCastingShadows(value): void

• Parameters

  • value: boolean

  Returns void

isMoonEnabled

• get isMoonEnabled(): boolean

• Enables/disables rendering of the moon.

  Returns boolean
• set isMoonEnabled(value): void

• Parameters

  • value: boolean

  Returns void

isMoonRenderToSkyboxEnabled

• 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

isRenderingStarsAllWhite

• get isRenderingStarsAllWhite(): boolean

• Determines if stars are all white colored.

  Returns boolean
• set isRenderingStarsAllWhite(value): void

• Parameters

  • value: boolean

  Returns void

isRenderingStarsAsOnePixel

• get isRenderingStarsAsOnePixel(): boolean

• Determines if stars are drawn as pixels.

  Returns boolean
• set isRenderingStarsAsOnePixel(value): void

• Parameters

  • value: boolean

  Returns void

isRenderingStarsWithSameBrightness

• get isRenderingStarsWithSameBrightness(): boolean

• Determines if stars are all same brightness.

  Returns boolean
• set isRenderingStarsWithSameBrightness(value): void

• Parameters

  • value: boolean

  Returns void

isRenderingTexturedStars

• get isRenderingTexturedStars(): boolean

• Determines if stars are textured or not.

  Returns boolean
• set isRenderingTexturedStars(value): void

• Parameters

  • value: boolean

  Returns void

isStarsEnabled

• get isStarsEnabled(): boolean

• Enables/disables rendering of the stars.

  Returns boolean
• set isStarsEnabled(value): void

• Parameters

  • value: boolean

  Returns void

isStarsRenderToSkyboxEnabled

• 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

isSunCastingShadows

• get isSunCastingShadows(): boolean

• Sun light will casts shadows if true.

  Returns boolean
• set isSunCastingShadows(value): void

• Parameters

  • value: boolean

  Returns void

moonAltitude

• 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

  • value: rsx.Degree

  Returns void

moonAzimuth

• get moonAzimuth(): rsx.Degree

• Moon azimuth, [0; 360]. In degrees.

  Returns rsx.Degree
• set moonAzimuth(value): void

• Parameters

  • value: rsx.Degree

  Returns void

moonBrightness

• get moonBrightness(): number

• Moon radiance multiplier.

  Returns number
• set moonBrightness(value): void

• Parameters

  • value: number

  Returns void

moonSize

• get moonSize(): number

• The size scale of the Moon.

  Returns number
• set moonSize(value): void

• Parameters

  • value: number

  Returns void

moonTint

• get moonTint(): Immutable<Vector3>

• Moon color tint.

  Returns Immutable<Vector3>
• set moonTint(value): void

• Parameters

  • value: Immutable<Vector3>

  Returns void

planets

• get planets(): Iterable<PlanetParameters>

• Additional planets that may be incorporated to the current structure.

  Returns Iterable<PlanetParameters>
• set planets(value): void

• Parameters

  • value: Iterable<PlanetParameters> | readonly PlanetParameters[]

  Returns void

renderMode

• get renderMode(): EnumValue<AnalyticalSkyRenderMode, number>

• Determines the renderer to use for rendering a scene.

  Returns EnumValue<AnalyticalSkyRenderMode, number>
• set renderMode(value): void

• Parameters

  • value: EnumValue<AnalyticalSkyRenderMode, number>

  Returns void

starsBrightness

• get starsBrightness(): number

• Stars radiance multiplier.

  Returns number
• set starsBrightness(value): void

• Parameters

  • value: number

  Returns void

starsSize

• get starsSize(): number

• The size scale of the stars. Just pure draw value.

  Returns number
• set starsSize(value): void

• Parameters

  • value: number

  Returns void

sunAltitude

• 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

  • value: rsx.Degree

  Returns void

sunAzimuth

• get sunAzimuth(): rsx.Degree

• Sun azimuth, [0; 360] In degrees.

  Returns rsx.Degree
• set sunAzimuth(value): void

• Parameters

  • value: rsx.Degree

  Returns void

sunCoronaSize

• 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

sunIntensity

• 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

sunSize

• 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

sunTint

• get sunTint(): Immutable<Vector3>

• Color of directional light associated with Analytical Sky

  Returns Immutable<Vector3>
• set sunTint(value): void

• Parameters

  • value: Immutable<Vector3>

  Returns void

timeAndLocation

• get timeAndLocation(): TimeAndLocation

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

  Returns TimeAndLocation
• set timeAndLocation(value): void

• Parameters

  • value: TimeAndLocation

  Returns void

markAsDirty

• markAsDirty(dirtyFlags): void

• Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action): 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.

    • • (): void

      • Returns void

  Returns void

ReadonlyonDirty