mapbox-maps-android/com.mapbox.maps.extension.style.precipitations.generated/Rain

Rain

@UiThread

@MapboxExperimental

class Rain : RainDslReceiver, StyleContract.StyleRainExtension

The experimental Rain API to render rain effect on the map.

Constructors

Rain

fun Rain()

Functions

bindTo

open override fun bindTo(delegate: MapboxStyleManager)

Bind rain to the map controller.

centerThinning

@MapboxExperimental

open override fun centerThinning(centerThinning: Expression): Rain

@MapboxExperimental

open override fun centerThinning(centerThinning: Double): Rain

Thinning factor of rain particles from center. 0 - no thinning. 1 - maximal central area thinning. Default value: 1. Value range: 0, 1

centerThinningTransition

@MapboxExperimental

open override fun centerThinningTransition(options: StyleTransition): Rain

Set the CenterThinning property transition options.

@MapboxExperimental

open override fun centerThinningTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for centerThinningTransition.

color

@MapboxExperimental

open override fun color(color: Expression): Rain

@MapboxExperimental

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

@MapboxExperimental

open override fun color(color: String): Rain

Default value: "#ffffff".

colorTransition

@MapboxExperimental

open override fun colorTransition(options: StyleTransition): Rain

Set the Color property transition options.

@MapboxExperimental

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

DSL for colorTransition.

density

@MapboxExperimental

open override fun density(density: Expression): Rain

@MapboxExperimental

open override fun density(density: Double): Rain

Rain particles density. Default value: 1. Value range: 0, 1

densityTransition

@MapboxExperimental

open override fun densityTransition(options: StyleTransition): Rain

Set the Density property transition options.

@MapboxExperimental

open override fun densityTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for densityTransition.

direction

@MapboxExperimental

open override fun direction(direction: Expression): Rain

@MapboxExperimental

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

Main rain particles direction. Heading & pitch Default value: 0,80. Value range: 0, 360

directionTransition

@MapboxExperimental

open override fun directionTransition(options: StyleTransition): Rain

Set the Direction property transition options.

@MapboxExperimental

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

DSL for directionTransition.

intensity

@MapboxExperimental

open override fun intensity(intensity: Expression): Rain

@MapboxExperimental

open override fun intensity(intensity: Double): Rain

Rain particles movement factor. Default value: 1. Value range: 0, 1

intensityTransition

@MapboxExperimental

open override fun intensityTransition(options: StyleTransition): Rain

Set the Intensity property transition options.

@MapboxExperimental

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

DSL for intensityTransition.

opacity

@MapboxExperimental

open override fun opacity(opacity: Expression): Rain

@MapboxExperimental

open override fun opacity(opacity: Double): Rain

Rain particles opacity. Default value: 1. Value range: 0, 1

opacityTransition

@MapboxExperimental

open override fun opacityTransition(options: StyleTransition): Rain

Set the Opacity property transition options.

@MapboxExperimental

open override fun opacityTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for opacityTransition.

vignette

@MapboxExperimental

open override fun vignette(vignette: Expression): Rain

@MapboxExperimental

open override fun vignette(vignette: Double): Rain

Rain vignette screen-space effect. Default value: 0. Value range: 0, 1

vignetteTransition

@MapboxExperimental

open override fun vignetteTransition(options: StyleTransition): Rain

Set the Vignette property transition options.

@MapboxExperimental

open override fun vignetteTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for vignetteTransition.

Properties

centerThinning

@MapboxExperimental

val centerThinning: Double?

Thinning factor of rain particles from center. 0 - no thinning. 1 - maximal central area thinning. Default value: 1. Value range: 0, 1

centerThinningAsExpression

@MapboxExperimental

val centerThinningAsExpression: Expression?

Thinning factor of rain particles from center. 0 - no thinning. 1 - maximal central area thinning. Default value: 1. Value range: 0, 1

centerThinningTransition

@MapboxExperimental

val centerThinningTransition: StyleTransition?

CenterThinning property transition options.

color

@MapboxExperimental

val color: String?

Default value: "#ffffff".

colorAsColorInt

@MapboxExperimental

@get:ColorInt

val colorAsColorInt: Int?

Default value: "#ffffff".

colorAsExpression

@MapboxExperimental

val colorAsExpression: Expression?

Default value: "#ffffff".

colorTransition

@MapboxExperimental

val colorTransition: StyleTransition?

Color property transition options.

density

@MapboxExperimental

val density: Double?

Rain particles density. Default value: 1. Value range: 0, 1

densityAsExpression

@MapboxExperimental

val densityAsExpression: Expression?

Rain particles density. Default value: 1. Value range: 0, 1

densityTransition

@MapboxExperimental

val densityTransition: StyleTransition?

Density property transition options.

direction

@MapboxExperimental

val direction: List<Double>?

Main rain particles direction. Heading & pitch Default value: 0,80. Value range: 0, 360

directionAsExpression

@MapboxExperimental

val directionAsExpression: Expression?

Main rain particles direction. Heading & pitch Default value: 0,80. Value range: 0, 360

directionTransition

@MapboxExperimental

val directionTransition: StyleTransition?

Direction property transition options.

intensity

@MapboxExperimental

val intensity: Double?

Rain particles movement factor. Default value: 1. Value range: 0, 1

intensityAsExpression

@MapboxExperimental

val intensityAsExpression: Expression?

Rain particles movement factor. Default value: 1. Value range: 0, 1

intensityTransition

@MapboxExperimental

val intensityTransition: StyleTransition?

Intensity property transition options.

opacity

@MapboxExperimental

val opacity: Double?

Rain particles opacity. Default value: 1. Value range: 0, 1

opacityAsExpression

@MapboxExperimental

val opacityAsExpression: Expression?

Rain particles opacity. Default value: 1. Value range: 0, 1

opacityTransition

@MapboxExperimental

val opacityTransition: StyleTransition?

Opacity property transition options.

vignette

@MapboxExperimental

val vignette: Double?

Rain vignette screen-space effect. Default value: 0. Value range: 0, 1

vignetteAsExpression

@MapboxExperimental

val vignetteAsExpression: Expression?

Rain vignette screen-space effect. Default value: 0. Value range: 0, 1

vignetteTransition

@MapboxExperimental

val vignetteTransition: StyleTransition?

Vignette property transition options.