Light

class Light : LightDslReceiver, StyleContract.StyleLightExtension

The global light source.

Check the online documentation.

Constructors

Light

fun Light()

Types

Companion

object Companion

Static variables and methods.

Functions

anchor

open override fun anchor(anchor: Expression): Light

open override fun anchor(anchor: Anchor): Light

Whether extruded geometries are lit relative to the map or viewport.

bindTo

open override fun bindTo(delegate: StyleInterface)

Bind the light to the map controller.

castShadows

open override fun castShadows(castShadows: Expression): Light

open override fun castShadows(castShadows: Boolean): Light

Enable/Disable shadow casting for this light

color

open override fun color(color: Expression): Light

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

open override fun color(color: String): Light

Color tint for lighting extruded geometries.

colorTransition

open override fun colorTransition(options: StyleTransition): Light

Set the Color property transition options.

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

DSL for colorTransition.

intensity

open override fun intensity(intensity: Expression): Light

open override fun intensity(intensity: Double): Light

Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.

intensityTransition

open override fun intensityTransition(options: StyleTransition): Light

Set the Intensity property transition options.

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

DSL for intensityTransition.

position

open override fun position(position: Expression): Light

open override fun position(position: LightPosition): Light

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

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).

positionTransition

open override fun positionTransition(options: StyleTransition): Light

Set the Position property transition options.

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

DSL for positionTransition.

shadowIntensity

open override fun shadowIntensity(shadowIntensity: Expression): Light

open override fun shadowIntensity(shadowIntensity: Double): Light

Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces almost black.

shadowIntensityTransition

open override fun shadowIntensityTransition(options: StyleTransition): Light

Set the ShadowIntensity property transition options.

open override fun shadowIntensityTransition(block: StyleTransition.Builder.() -> Unit): Light

DSL for shadowIntensityTransition.

Properties

anchor

val anchor: Anchor?

Whether extruded geometries are lit relative to the map or viewport.

anchorAsExpression

val anchorAsExpression: Expression?

Whether extruded geometries are lit relative to the map or viewport.

castShadows

val castShadows: Boolean?

Enable/Disable shadow casting for this light

castShadowsAsExpression

val castShadowsAsExpression: Expression?

Enable/Disable shadow casting for this light

color

val color: String?

Color tint for lighting extruded geometries.

colorAsColorInt

val colorAsColorInt: Int?

Color tint for lighting extruded geometries.

colorAsExpression

val colorAsExpression: Expression?

Color tint for lighting extruded geometries.

colorTransition

val colorTransition: StyleTransition?

Color property transition options.

intensity

val intensity: Double?

Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.

intensityAsExpression

val intensityAsExpression: Expression?

Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.

intensityTransition

val intensityTransition: StyleTransition?

Intensity property transition options.

position

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).

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).

positionTransition

val positionTransition: StyleTransition?

Position property transition options.

shadowIntensity

val shadowIntensity: Double?

Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces almost black.

shadowIntensityAsExpression

val shadowIntensityAsExpression: Expression?

Determines the shadow strength, affecting the shadow receiver surfaces final color. Values near 0.0 reduce the shadow contribution to the final color. Values near to 1.0 make occluded surfaces almost black.

shadowIntensityTransition

val shadowIntensityTransition: StyleTransition?

ShadowIntensity property transition options.