Class Atmosphere

Readonlyview

affectSky

• get affectSky(): boolean

  Whether to haze sky/background pixels. Default false.

  Returns boolean
• set affectSky(value: boolean): void

  Parameters

  • value: boolean

  Returns void

applied

• get applied(): boolean

  Gets if atmospheric attenuation is currently applied.

  This is true when View.renderMode is in Atmosphere.renderModes.

  Returns boolean

color

• get color(): [number, number, number]

  RGB haze color mixed into distant scene geometry.

  Returns [number, number, number]
• set color(value: FloatArrayParam): void

  Parameters

  • value: FloatArrayParam

  Returns void

endDistance

• get endDistance(): number

  View-space distance, in world units, at which attenuation reaches full strength.

  Returns number
• set endDistance(value: number): void

  Parameters

  • value: number

  Returns void

intensity

• get intensity(): number

  Overall atmospheric attenuation strength. Default 0.35.

  Returns number
• set intensity(value: number): void

  Parameters

  • value: number

  Returns void

maxOpacity

• get maxOpacity(): number

  Maximum haze opacity after distance and intensity are applied. Default 0.55.

  Returns number
• set maxOpacity(value: number): void

  Parameters

  • value: number

  Returns void

renderModes

• get renderModes(): number[]

  Gets which rendering modes in which to apply atmospheric attenuation.

  Returns number[]
• set renderModes(value: number[]): void

  Sets which rendering modes in which to apply atmospheric attenuation.

  Default value is [RealisticRender] when this effect is explicitly configured.

  Parameters

  • value: number[]

  Returns void

startDistance

• get startDistance(): number

  View-space distance, in world units, at which attenuation begins.

  Returns number
• set startDistance(value: number): void

  Parameters

  • value: number

  Returns void

fromParams

• fromParams(params: AtmosphereParams): SDKResult<any>

  Configures this Atmosphere.

  Parameters

  • params: AtmosphereParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<AtmosphereParams>

  Gets this Atmosphere as JSON.

  Returns SDKResult<AtmosphereParams>