mapbox-maps-android/com.mapbox.maps.extension.compose.style.lights.generated/FlatLightState

FlatLightState

class FlatLightState

A global directional light source which is only applied on 3D and hillshade layers. Using this type disables other light sources.

See also

The online documentation

Constructors

fun FlatLightState(id: String = generateRandomLightId("flat"))

Types

object Companion

Public companion object.

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

FlatLightState Holder class to be used within Saver.

Functions

open operator override fun equals(other: Any?): Boolean

Overwrite the equals for FlatLightState.

open override fun hashCode(): Int

Overwrite the hashcode for FlatLightState.

open override fun toString(): String

Overwrite the toString for FlatLightState.

Properties

var anchor: AnchorValue

Whether extruded geometries are lit relative to the map or viewport. Default value: "viewport".

var color: ColorValue

Color tint for lighting extruded geometries. Default value: "#ffffff".

colorTransition

var colorTransition: Transition

Defines the transition of color. Default value: "#ffffff".

The id of the FlatLightState.

var intensity: DoubleValue

Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast. Default value: 0.5. Value range: 0, 1

intensityTransition

var intensityTransition: Transition

Defines the transition of intensity. Default value: 0.5. Value range: 0, 1

var position: DoubleListValue

Position of the light source relative to lit (extruded) geometries, in r radial coordinate, a azimuthal angle, p polar angle where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0 degree (0 degree when light.anchor is set to viewport corresponds to the top of the viewport, or 0 degree when light.anchor is set to map corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 1.15,210,30.

positionTransition

var positionTransition: Transition

Defines the transition of position. Default value: 1.15,210,30.