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

DirectionalLight

class DirectionalLight : Light, DirectionalLightDslReceiver

A light that has a direction and is located at infinite distance, so its rays are parallel. It simulates the sun light and can cast shadows.

Check the online documentation.

Functions

open override fun castShadows(castShadows: Expression): DirectionalLight

open override fun castShadows(castShadows: Boolean): DirectionalLight

Enable/Disable shadow casting for this light Default value: false.

open override fun color(color: Expression): DirectionalLight

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

open override fun color(color: String): DirectionalLight

Color of the directional light. Default value: "#ffffff".

colorTransition

open override fun colorTransition(options: StyleTransition): DirectionalLight

Set the Color property transition options.

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

DSL for colorTransition.

open override fun direction(direction: Expression): DirectionalLight

open override fun direction(direction: List<Double>): DirectionalLight

Direction of the light source specified as a azimuthal angle, p polar angle where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 210,30. Minimum value: 0,0. Maximum value: 360,90.

directionTransition

open override fun directionTransition(options: StyleTransition): DirectionalLight

Set the Direction property transition options.

open override fun directionTransition(block: StyleTransition.Builder.() -> Unit): DirectionalLight

DSL for directionTransition.

open override fun intensity(intensity: Expression): DirectionalLight

open override fun intensity(intensity: Double): DirectionalLight

A multiplier for the color of the directional light. Default value: 0.5. Value range: 0, 1

intensityTransition

open override fun intensityTransition(options: StyleTransition): DirectionalLight

Set the Intensity property transition options.

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

DSL for intensityTransition.

shadowIntensity

open override fun shadowIntensity(shadowIntensity: Expression): DirectionalLight

open override fun shadowIntensity(shadowIntensity: Double): DirectionalLight

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 receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1. Default value: 1. Value range: 0, 1

shadowIntensityTransition

open override fun shadowIntensityTransition(options: StyleTransition): DirectionalLight

Set the ShadowIntensity property transition options.

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

DSL for shadowIntensityTransition.

Properties

val castShadows: Boolean?

Enable/Disable shadow casting for this light Default value: false.

castShadowsAsExpression

val castShadowsAsExpression: Expression?

Enable/Disable shadow casting for this light Default value: false.

val color: String?

Color of the directional light. Default value: "#ffffff".

colorAsColorInt

val colorAsColorInt: Int?

Color of the directional light. Default value: "#ffffff".

colorAsExpression

val colorAsExpression: Expression?

Color of the directional light. Default value: "#ffffff".

colorTransition

val colorTransition: StyleTransition?

Color property transition options.

val direction: List<Double>?

Direction of the light source specified as a azimuthal angle, p polar angle where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 210,30. Minimum value: 0,0. Maximum value: 360,90.

directionAsExpression

val directionAsExpression: Expression?

Direction of the light source specified as a azimuthal angle, p polar angle where a indicates the azimuthal angle of the light relative to north (in degrees and proceeding clockwise), and p indicates polar angle of the light (from 0 degree, directly above, to 180 degree, directly below). Default value: 210,30. Minimum value: 0,0. Maximum value: 360,90.

directionTransition

val directionTransition: StyleTransition?

Direction property transition options.

val intensity: Double?

A multiplier for the color of the directional light. Default value: 0.5. Value range: 0, 1

intensityAsExpression

val intensityAsExpression: Expression?

A multiplier for the color of the directional light. 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.

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 receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1. Default value: 1. Value range: 0, 1

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 receive almost no directional light. Designed to be used mostly for transitioning between values 0 and 1. Default value: 1. Value range: 0, 1

shadowIntensityTransition

val shadowIntensityTransition: StyleTransition?

ShadowIntensity property transition options.