mapbox-maps-android/com.mapbox.maps.extension.compose.style.precipitations.generated/RainState

RainState

@Stable

@MapboxExperimental

class RainState

The Rain effects applied to the style.

Constructors

RainState

fun RainState()

Types

Companion

object Companion

Public companion object.

Holder

data class Holder : Parcelable

Rain Holder class to be used within Saver.

Functions

equals

open operator override fun equals(other: Any?): Boolean

See Any.equals

hashCode

open override fun hashCode(): Int

See Any.hashCode

toString

open override fun toString(): String

Returns a string representation of the object.

Properties

centerThinning

@MapboxExperimental

var centerThinning: DoubleValue

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

centerThinningTransition

@MapboxExperimental

var centerThinningTransition: Transition

Defines the transition of centerThinning. Default value: 1. Value range: 0, 1

color

@MapboxExperimental

var color: ColorValue

Default value: "#ffffff".

colorTransition

@MapboxExperimental

var colorTransition: Transition

Defines the transition of color. Default value: "#ffffff".

density

@MapboxExperimental

var density: DoubleValue

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

densityTransition

@MapboxExperimental

var densityTransition: Transition

Defines the transition of density. Default value: 1. Value range: 0, 1

direction

@MapboxExperimental

var direction: DoubleListValue

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

directionTransition

@MapboxExperimental

var directionTransition: Transition

Defines the transition of direction. Default value: 0,80. Value range: 0, 360

intensity

@MapboxExperimental

var intensity: DoubleValue

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

intensityTransition

@MapboxExperimental

var intensityTransition: Transition

Defines the transition of intensity. Default value: 1. Value range: 0, 1

opacity

@MapboxExperimental

var opacity: DoubleValue

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

opacityTransition

@MapboxExperimental

var opacityTransition: Transition

Defines the transition of opacity. Default value: 1. Value range: 0, 1

vignette

@MapboxExperimental

var vignette: DoubleValue

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

vignetteTransition

@MapboxExperimental

var vignetteTransition: Transition

Defines the transition of vignette. Default value: 0. Value range: 0, 1