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

Set the Anchor property

open override fun anchor(anchor: Anchor): Light

Set the Anchor property.

bindTo

open override fun bindTo(delegate: StyleInterface)

Bind the light to the map controller.

color

open override fun color(color: Expression): Light

Set the Color property

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

Set the Color property.

open override fun color(color: String): Light

Set the Color property.

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

Set the Intensity property

open override fun intensity(intensity: Double): Light

Set the Intensity property.

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

Set the Position property

open override fun position(position: LightPosition): Light

Set the Position property.

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

DSL for setting LightPosition.

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.

Properties

anchor

val anchor: Anchor?

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

anchorAsExpression

val anchorAsExpression: Expression?

This is an Expression representation of "anchor".

color

val color: String?

Color tint for lighting extruded geometries.

colorAsColorInt

val colorAsColorInt: Int?

Color tint for lighting extruded geometries.

colorAsExpression

val colorAsExpression: Expression?

This is an Expression representation of "color".

colorTransition

val colorTransition: StyleTransition?

Color property transition options.

intensity

val intensity: Double?

Intensity of lighting (on a scale from 0 to 1).

intensityAsExpression

val intensityAsExpression: Expression?

This is an Expression representation of "intensity".

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?

This is an Expression representation of "position".

positionTransition

val positionTransition: StyleTransition?

Position property transition options.