mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated/RasterParticleLayerState

RasterParticleLayerState

@Stable

@MapboxExperimental

class RasterParticleLayerState

The state holder for RasterParticleLayer's layer properties.

Constructors

RasterParticleLayerState

fun RasterParticleLayerState()

Construct an default RasterParticleLayerState.

Properties

filter

var filter: Filter

An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...] expression is not supported in filter expressions. The ["pitch"] and ["distance-from-center"] expressions are supported only for filter expressions on the symbol layer.

maxZoom

var maxZoom: LongValue

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. Value range: 0, 24

minZoom

var minZoom: LongValue

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Value range: 0, 24

rasterParticleArrayBand

@MapboxExperimental

var rasterParticleArrayBand: StringValue

Displayed band of raster array source layer

rasterParticleColor

@MapboxExperimental

var rasterParticleColor: ColorValue

Defines a color map by which to colorize a raster particle layer, parameterized by the ["raster-particle-speed"] expression and evaluated at 256 uniformly spaced steps over the range specified by raster-particle-max-speed.

rasterParticleCount

@MapboxExperimental

var rasterParticleCount: LongValue

Defines the amount of particles per tile. Default value: 512. Minimum value: 1.

rasterParticleFadeOpacityFactor

@MapboxExperimental

var rasterParticleFadeOpacityFactor: DoubleValue

Defines defines the opacity coefficient applied to the faded particles in each frame. In practice, this property controls the length of the particle tail. Default value: 0.98. Value range: 0, 1

rasterParticleFadeOpacityFactorTransition

@MapboxExperimental

var rasterParticleFadeOpacityFactorTransition: Transition

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

rasterParticleMaxSpeed

@MapboxExperimental

var rasterParticleMaxSpeed: DoubleValue

Defines the maximum speed for particles. Velocities with magnitudes equal to or exceeding this value are clamped to the max value. Default value: 1. Minimum value: 1.

rasterParticleResetRateFactor

@MapboxExperimental

var rasterParticleResetRateFactor: DoubleValue

Defines a coefficient for a time period at which particles will restart at a random position, to avoid degeneration (empty areas without particles). Default value: 0.8. Value range: 0, 1

rasterParticleSpeedFactor

@MapboxExperimental

var rasterParticleSpeedFactor: DoubleValue

Defines a coefficient for the speed of particles’ motion. Default value: 0.2. Value range: 0, 1

rasterParticleSpeedFactorTransition

@MapboxExperimental

var rasterParticleSpeedFactorTransition: Transition

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

sourceLayer

var sourceLayer: StringValue

Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

visibility