mapbox-maps-android/com.mapbox.maps.extension.style.light.generated/FlatLight

FlatLight

class FlatLight : Light, FlatLightDslReceiver, StyleContract.StyleLightExtension

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

Check the online documentation.

Functions

open override fun anchor(anchor: Expression): FlatLight

open override fun anchor(anchor: Anchor): FlatLight

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

open override fun bindTo(delegate: MapboxStyleManager)

Bind the light to the Style.

open override fun color(color: Expression): FlatLight

open override fun color(@ColorInt color: Int): FlatLight

open override fun color(color: String): FlatLight

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

colorTransition

open override fun colorTransition(options: StyleTransition): FlatLight

Set the Color property transition options.

open override fun colorTransition(block: StyleTransition.Builder.() -> Unit): FlatLight

DSL for colorTransition.

open override fun intensity(intensity: Expression): FlatLight

open override fun intensity(intensity: Double): FlatLight

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

open override fun intensityTransition(options: StyleTransition): FlatLight

Set the Intensity property transition options.

open override fun intensityTransition(block: StyleTransition.Builder.() -> Unit): FlatLight

DSL for intensityTransition.

open override fun position(position: Expression): FlatLight

open override fun position(position: LightPosition): FlatLight

open override fun position(radialCoordinate: Double, azimuthalAngle: Double, polarAngle: Double): FlatLight

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

open override fun positionTransition(options: StyleTransition): FlatLight

Set the Position property transition options.

open override fun positionTransition(block: StyleTransition.Builder.() -> Unit): FlatLight

DSL for positionTransition.

Properties

val anchor: Anchor?

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

anchorAsExpression

val anchorAsExpression: Expression?

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

val color: String?

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

colorAsColorInt

val colorAsColorInt: Int?

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

colorAsExpression

val colorAsExpression: Expression?

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

colorTransition

val colorTransition: StyleTransition?

Color property transition options.

val intensity: Double?

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

intensityAsExpression

val intensityAsExpression: Expression?

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

val intensityTransition: StyleTransition?

Intensity property transition options.

open override val lightId: String

The ID of the Light.

val position: LightPosition?

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.

positionAsExpression

val positionAsExpression: Expression?

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

val positionTransition: StyleTransition?

Position property transition options.