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

AmbientLight

@UiThread
class AmbientLight : Light, AmbientLightDslReceiver

An indirect light affecting all objects in the map adding a constant amount of light on them. It has no explicit direction and cannot cast shadows.

Check the online documentation.

Functions

Link copied to clipboard
open override fun color(color: Expression): AmbientLight
open override fun color(@ColorInt color: Int): AmbientLight
open override fun color(color: String): AmbientLight

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

Link copied to clipboard
open override fun colorTransition(options: StyleTransition): AmbientLight

Set the Color property transition options.

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

DSL for colorTransition.

Link copied to clipboard
open override fun intensity(intensity: Expression): AmbientLight
open override fun intensity(intensity: Double): AmbientLight

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

Link copied to clipboard
open override fun intensityTransition(options: StyleTransition): AmbientLight

Set the Intensity property transition options.

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

DSL for intensityTransition.

Properties

Link copied to clipboard
val color: String?

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

Link copied to clipboard
@get:ColorInt
val colorAsColorInt: Int?

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

Link copied to clipboard
val colorAsExpression: Expression?

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

Link copied to clipboard
val colorTransition: StyleTransition?

Color property transition options.

Link copied to clipboard
val intensity: Double?

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

Link copied to clipboard
val intensityAsExpression: Expression?

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

Link copied to clipboard
val intensityTransition: StyleTransition?

Intensity property transition options.

Link copied to clipboard
open override val lightId: String

The ID of the Light.