mapbox-maps-android/com.mapbox.maps.extension.compose.style.atmosphere.generated/AtmosphereState

AtmosphereState

class AtmosphereState(initialProperties: Map<String, Value> = mapOf())

A global effect that fades layers and markers based on their distance to the camera. The fog can be used to approximate the effect of atmosphere on distant objects and enhance the depth perception of the map when used with terrain or 3D features. Note: fog is renamed to atmosphere in the Android and iOS SDKs and planned to be changed in GL-JS v.3.0.0.

Constructors

AtmosphereState

fun AtmosphereState(initialProperties: Map<String, Value> = mapOf())

Types

Companion

object Companion

Public companion object.

Holder

@MapboxExperimental

data class Holder(val cachedProperties: Map<String, Value>) : Parcelable

Atmosphere Holder class to be used within Saver.

Properties

color

var color: Color

The color of the atmosphere region immediately below the horizon and within the range and above the horizon and within horizon-blend. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn.

highColor

var highColor: HighColor

The color of the atmosphere region above the horizon, high-color extends further above the horizon than the color property and its spread can be controlled with horizon-blend. The opacity can be set to 0 to remove the high atmosphere color contribution.

horizonBlend

var horizonBlend: HorizonBlend

Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky.

range

var range: Range

The start and end distance range in which fog fades from fully transparent to fully opaque. The distance to the point at the center of the map is defined as zero, so that negative range values are closer to the camera, and positive values are farther away.

spaceColor

var spaceColor: SpaceColor

The color of the region above the horizon and after the end of the horizon-blend contribution. The opacity can be set to 0 to have a transparent background.

starIntensity

var starIntensity: StarIntensity

A value controlling the star intensity where 0 will show no stars and 1 will show stars at their maximum intensity.

verticalRange

var verticalRange: VerticalRange

An array of two number values, specifying the vertical range, measured in meters, over which the fog should gradually fade out. When both parameters are set to zero, the fog will be rendered without any vertical constraints.

AtmosphereState

See also

Constructors

Types

Properties