arcgis-maps-kotlin/com.arcgismaps.mapping.view/SceneEnvironment

SceneEnvironment

class SceneEnvironment

The settings that affect the environment in which a scene is displayed. This includes rendering of the atmosphere effect, stars, and background color. If all three of these effects are set, they are rendered in the following order: background color, stars, then atmosphere.

Some scene environment effects will change depending on the position of the camera relative to the surface. Atmosphere effect is disabled when too far from the surface. Lighting and shadows are most accurate when closer to the surface and are disabled further from the surface.

Since

300.0.0

See also

ArcGISScene.environment

Constructors

SceneEnvironment

constructor()

Creates a default environment object. The defaults are: opaque black background, VirtualLighting lighting, and atmosphere and stars enabled.

constructor(isAtmosphereEnabled: Boolean, areStarsEnabled: Boolean, lighting: SceneLighting, backgroundColor: Color)

Creates an environment object.

Properties

areStarsEnabled

var areStarsEnabled: Boolean

True if stars should be visualized, false otherwise.

backgroundColor

var backgroundColor: Color

The color of the background that is displayed behind any scene objects.

isAtmosphereEnabled

var isAtmosphereEnabled: Boolean

True if the atmosphere should be visualized, false otherwise. This includes sky and haze effects.

var lighting: SceneLighting

The lighting object that controls how the scene is lit.