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

Link copied to clipboard
fun Rain()

Functions

Link copied to clipboard
open override fun bindTo(delegate: MapboxStyleManager)

Bind rain to the map controller.

Link copied to clipboard
@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: 0.57. Value range: 0, 1

Link copied to clipboard
@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.

Link copied to clipboard
@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

Individual rain particle dorplets color. Default value: "["interpolate","linear","measure-light","brightness",0,"#03113d",0.3,"#a8adbc"]".

Link copied to clipboard
@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.

Link copied to clipboard
@MapboxExperimental
open override fun colorUseTheme(colorUseTheme: Expression): Rain
@MapboxExperimental
open override fun colorUseTheme(colorUseTheme: String): Rain

This property defines whether the color uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard
@MapboxExperimental
open override fun density(density: Expression): Rain
@MapboxExperimental
open override fun density(density: Double): Rain

Rain particles density. Controls the overall screen density of the rain. Default value: "["interpolate","linear","zoom",11,0,13,0.5]". Value range: 0, 1

Link copied to clipboard
@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.

Link copied to clipboard
@MapboxExperimental
open override fun direction(direction: Expression): Rain
@MapboxExperimental
open override fun direction(direction: List<Double>): Rain

Main rain particles direction. Azimuth and polar angles. Default value: 0,80. Value range: 0, 360

Link copied to clipboard
@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.

Link copied to clipboard
@MapboxExperimental
open override fun distortionStrength(distortionStrength: Expression): Rain
@MapboxExperimental
open override fun distortionStrength(distortionStrength: Double): Rain

Rain particles screen-space distortion strength. Default value: 0.7. Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
open override fun distortionStrengthTransition(options: StyleTransition): Rain

Set the DistortionStrength property transition options.

@MapboxExperimental
open override fun distortionStrengthTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for distortionStrengthTransition.

Link copied to clipboard
@MapboxExperimental
open override fun dropletSize(dropletSize: Expression): Rain
@MapboxExperimental
open override fun dropletSize(dropletSize: List<Double>): Rain

Rain droplet size. x - normal to direction, y - along direction Default value: 2.6,18.2. Value range: 0, 50

Link copied to clipboard
@MapboxExperimental
open override fun dropletSizeTransition(options: StyleTransition): Rain

Set the DropletSize property transition options.

@MapboxExperimental
open override fun dropletSizeTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for dropletSizeTransition.

Link copied to clipboard
@MapboxExperimental
open override fun intensity(intensity: Expression): Rain
@MapboxExperimental
open override fun intensity(intensity: Double): Rain

Rain particles movement factor. Controls the overall rain particles speed Default value: 1. Value range: 0, 1

Link copied to clipboard
@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.

Link copied to clipboard
@MapboxExperimental
open override fun opacity(opacity: Expression): Rain
@MapboxExperimental
open override fun opacity(opacity: Double): Rain

Rain particles opacity. Default value: "["interpolate","linear","measure-light","brightness",0,0.88,1,0.7]". Value range: 0, 1

Link copied to clipboard
@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.

Link copied to clipboard
@MapboxExperimental
open override fun vignette(vignette: Expression): Rain
@MapboxExperimental
open override fun vignette(vignette: Double): Rain

Screen-space vignette rain tinting effect intensity. Default value: "["interpolate","linear","zoom",11,0,13,1]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
open override fun vignetteColor(vignetteColor: Expression): Rain
@MapboxExperimental
open override fun vignetteColor(@ColorInt vignetteColor: Int): Rain
@MapboxExperimental
open override fun vignetteColor(vignetteColor: String): Rain

Rain vignette screen-space corners tint color. Default value: "["interpolate","linear","measure-light","brightness",0,"#001736",0.3,"#464646"]".

Link copied to clipboard
@MapboxExperimental
open override fun vignetteColorTransition(options: StyleTransition): Rain

Set the VignetteColor property transition options.

@MapboxExperimental
open override fun vignetteColorTransition(block: StyleTransition.Builder.() -> Unit): Rain

DSL for vignetteColorTransition.

Link copied to clipboard
@MapboxExperimental
open override fun vignetteColorUseTheme(vignetteColorUseTheme: Expression): Rain
@MapboxExperimental
open override fun vignetteColorUseTheme(vignetteColorUseTheme: String): Rain

This property defines whether the vignetteColor uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard
@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

Link copied to clipboard
@MapboxExperimental
val centerThinning: Double?

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

Link copied to clipboard
@MapboxExperimental
val centerThinningAsExpression: Expression?

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

Link copied to clipboard
@MapboxExperimental
val centerThinningTransition: StyleTransition?

CenterThinning property transition options.

Link copied to clipboard
@MapboxExperimental
val color: String?

Individual rain particle dorplets color. Default value: "["interpolate","linear","measure-light","brightness",0,"#03113d",0.3,"#a8adbc"]".

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

Individual rain particle dorplets color. Default value: "["interpolate","linear","measure-light","brightness",0,"#03113d",0.3,"#a8adbc"]".

Link copied to clipboard
@MapboxExperimental
val colorAsExpression: Expression?

Individual rain particle dorplets color. Default value: "["interpolate","linear","measure-light","brightness",0,"#03113d",0.3,"#a8adbc"]".

Link copied to clipboard
@MapboxExperimental
val colorTransition: StyleTransition?

Color property transition options.

Link copied to clipboard
@MapboxExperimental
val colorUseTheme: String?

This property defines whether the color uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard
@MapboxExperimental
val colorUseThemeAsExpression: Expression?

This property defines whether the color uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard
@MapboxExperimental
val density: Double?

Rain particles density. Controls the overall screen density of the rain. Default value: "["interpolate","linear","zoom",11,0,13,0.5]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val densityAsExpression: Expression?

Rain particles density. Controls the overall screen density of the rain. Default value: "["interpolate","linear","zoom",11,0,13,0.5]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val densityTransition: StyleTransition?

Density property transition options.

Link copied to clipboard
@MapboxExperimental
val direction: List<Double>?

Main rain particles direction. Azimuth and polar angles. Default value: 0,80. Value range: 0, 360

Link copied to clipboard
@MapboxExperimental
val directionAsExpression: Expression?

Main rain particles direction. Azimuth and polar angles. Default value: 0,80. Value range: 0, 360

Link copied to clipboard
@MapboxExperimental
val directionTransition: StyleTransition?

Direction property transition options.

Link copied to clipboard
@MapboxExperimental
val distortionStrength: Double?

Rain particles screen-space distortion strength. Default value: 0.7. Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val distortionStrengthAsExpression: Expression?

Rain particles screen-space distortion strength. Default value: 0.7. Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val distortionStrengthTransition: StyleTransition?

DistortionStrength property transition options.

Link copied to clipboard
@MapboxExperimental
val dropletSize: List<Double>?

Rain droplet size. x - normal to direction, y - along direction Default value: 2.6,18.2. Value range: 0, 50

Link copied to clipboard
@MapboxExperimental
val dropletSizeAsExpression: Expression?

Rain droplet size. x - normal to direction, y - along direction Default value: 2.6,18.2. Value range: 0, 50

Link copied to clipboard
@MapboxExperimental
val dropletSizeTransition: StyleTransition?

DropletSize property transition options.

Link copied to clipboard
@MapboxExperimental
val intensity: Double?

Rain particles movement factor. Controls the overall rain particles speed Default value: 1. Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val intensityAsExpression: Expression?

Rain particles movement factor. Controls the overall rain particles speed Default value: 1. Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val intensityTransition: StyleTransition?

Intensity property transition options.

Link copied to clipboard
@MapboxExperimental
val opacity: Double?

Rain particles opacity. Default value: "["interpolate","linear","measure-light","brightness",0,0.88,1,0.7]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val opacityAsExpression: Expression?

Rain particles opacity. Default value: "["interpolate","linear","measure-light","brightness",0,0.88,1,0.7]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val opacityTransition: StyleTransition?

Opacity property transition options.

Link copied to clipboard
@MapboxExperimental
val vignette: Double?

Screen-space vignette rain tinting effect intensity. Default value: "["interpolate","linear","zoom",11,0,13,1]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val vignetteAsExpression: Expression?

Screen-space vignette rain tinting effect intensity. Default value: "["interpolate","linear","zoom",11,0,13,1]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val vignetteColor: String?

Rain vignette screen-space corners tint color. Default value: "["interpolate","linear","measure-light","brightness",0,"#001736",0.3,"#464646"]".

Link copied to clipboard
@MapboxExperimental
@get:ColorInt
val vignetteColorAsColorInt: Int?

Rain vignette screen-space corners tint color. Default value: "["interpolate","linear","measure-light","brightness",0,"#001736",0.3,"#464646"]".

Link copied to clipboard
@MapboxExperimental
val vignetteColorAsExpression: Expression?

Rain vignette screen-space corners tint color. Default value: "["interpolate","linear","measure-light","brightness",0,"#001736",0.3,"#464646"]".

Link copied to clipboard
@MapboxExperimental
val vignetteColorTransition: StyleTransition?

VignetteColor property transition options.

Link copied to clipboard
@MapboxExperimental
val vignetteColorUseTheme: String?

This property defines whether the vignetteColor uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard
@MapboxExperimental
val vignetteColorUseThemeAsExpression: Expression?

This property defines whether the vignetteColor uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard
@MapboxExperimental
val vignetteTransition: StyleTransition?

Vignette property transition options.