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

Snow

@UiThread
@MapboxExperimental
class Snow : SnowDslReceiver, StyleContract.StyleSnowExtension

The experimental Snow API to render snow effect on the map.

Constructors

Link copied to clipboard
fun Snow()

Functions

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

Bind snow to the map controller.

Link copied to clipboard
@MapboxExperimental
open override fun centerThinning(centerThinning: Expression): Snow
@MapboxExperimental
open override fun centerThinning(centerThinning: Double): Snow

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

Link copied to clipboard
@MapboxExperimental
open override fun centerThinningTransition(options: StyleTransition): Snow

Set the CenterThinning property transition options.

@MapboxExperimental
open override fun centerThinningTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for centerThinningTransition.

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

Snow particles color. Default value: "#ffffff".

Link copied to clipboard
@MapboxExperimental
open override fun colorTransition(options: StyleTransition): Snow

Set the Color property transition options.

@MapboxExperimental
open override fun colorTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for colorTransition.

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

Snow particles density. Controls the overall particles number. Default value: "["interpolate","linear","zoom",11,0,13,0.85]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
open override fun densityTransition(options: StyleTransition): Snow

Set the Density property transition options.

@MapboxExperimental
open override fun densityTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for densityTransition.

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

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

Link copied to clipboard
@MapboxExperimental
open override fun directionTransition(options: StyleTransition): Snow

Set the Direction property transition options.

@MapboxExperimental
open override fun directionTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for directionTransition.

Link copied to clipboard
@MapboxExperimental
open override fun flakeSize(flakeSize: Expression): Snow
@MapboxExperimental
open override fun flakeSize(flakeSize: Double): Snow

Snow flake particle size. Correlates with individual particle screen size Default value: 0.71. Value range: 0, 5

Link copied to clipboard
@MapboxExperimental
open override fun flakeSizeTransition(options: StyleTransition): Snow

Set the FlakeSize property transition options.

@MapboxExperimental
open override fun flakeSizeTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for flakeSizeTransition.

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

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

Link copied to clipboard
@MapboxExperimental
open override fun intensityTransition(options: StyleTransition): Snow

Set the Intensity property transition options.

@MapboxExperimental
open override fun intensityTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for intensityTransition.

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

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

Link copied to clipboard
@MapboxExperimental
open override fun opacityTransition(options: StyleTransition): Snow

Set the Opacity property transition options.

@MapboxExperimental
open override fun opacityTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for opacityTransition.

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

Snow vignette screen-space effect. Adds snow tint to screen corners Default value: "["interpolate","linear","zoom",11,0,13,0.3]". Value range: 0, 1

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

Snow vignette screen-space corners tint color. Default value: "#ffffff".

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

Set the VignetteColor property transition options.

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

DSL for vignetteColorTransition.

Link copied to clipboard
@MapboxExperimental
open override fun vignetteTransition(options: StyleTransition): Snow

Set the Vignette property transition options.

@MapboxExperimental
open override fun vignetteTransition(block: StyleTransition.Builder.() -> Unit): Snow

DSL for vignetteTransition.

Properties

Link copied to clipboard
@MapboxExperimental
val centerThinning: Double?

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

Link copied to clipboard
@MapboxExperimental
val centerThinningAsExpression: Expression?

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

Link copied to clipboard
@MapboxExperimental
val centerThinningTransition: StyleTransition?

CenterThinning property transition options.

Link copied to clipboard
@MapboxExperimental
val color: String?

Snow particles color. Default value: "#ffffff".

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

Snow particles color. Default value: "#ffffff".

Link copied to clipboard
@MapboxExperimental
val colorAsExpression: Expression?

Snow particles color. Default value: "#ffffff".

Link copied to clipboard
@MapboxExperimental
val colorTransition: StyleTransition?

Color property transition options.

Link copied to clipboard
@MapboxExperimental
val density: Double?

Snow particles density. Controls the overall particles number. Default value: "["interpolate","linear","zoom",11,0,13,0.85]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val densityAsExpression: Expression?

Snow particles density. Controls the overall particles number. Default value: "["interpolate","linear","zoom",11,0,13,0.85]". 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 snow particles direction. Azimuth and polar angles Default value: 0,50. Value range: 0, 360

Link copied to clipboard
@MapboxExperimental
val directionAsExpression: Expression?

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

Link copied to clipboard
@MapboxExperimental
val directionTransition: StyleTransition?

Direction property transition options.

Link copied to clipboard
@MapboxExperimental
val flakeSize: Double?

Snow flake particle size. Correlates with individual particle screen size Default value: 0.71. Value range: 0, 5

Link copied to clipboard
@MapboxExperimental
val flakeSizeAsExpression: Expression?

Snow flake particle size. Correlates with individual particle screen size Default value: 0.71. Value range: 0, 5

Link copied to clipboard
@MapboxExperimental
val flakeSizeTransition: StyleTransition?

FlakeSize property transition options.

Link copied to clipboard
@MapboxExperimental
val intensity: Double?

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

Link copied to clipboard
@MapboxExperimental
val intensityAsExpression: Expression?

Snow particles movement factor. Controls the overall particles movement 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?

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

Link copied to clipboard
@MapboxExperimental
val opacityAsExpression: Expression?

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

Link copied to clipboard
@MapboxExperimental
val opacityTransition: StyleTransition?

Opacity property transition options.

Link copied to clipboard
@MapboxExperimental
val vignette: Double?

Snow vignette screen-space effect. Adds snow tint to screen corners Default value: "["interpolate","linear","zoom",11,0,13,0.3]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val vignetteAsExpression: Expression?

Snow vignette screen-space effect. Adds snow tint to screen corners Default value: "["interpolate","linear","zoom",11,0,13,0.3]". Value range: 0, 1

Link copied to clipboard
@MapboxExperimental
val vignetteColor: String?

Snow vignette screen-space corners tint color. Default value: "#ffffff".

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

Snow vignette screen-space corners tint color. Default value: "#ffffff".

Link copied to clipboard
@MapboxExperimental
val vignetteColorAsExpression: Expression?

Snow vignette screen-space corners tint color. Default value: "#ffffff".

Link copied to clipboard
@MapboxExperimental
val vignetteColorTransition: StyleTransition?

VignetteColor property transition options.

Link copied to clipboard
@MapboxExperimental
val vignetteTransition: StyleTransition?

Vignette property transition options.