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

RasterParticleLayer

@MapboxExperimental
@Composable
fun RasterParticleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster-particle") }, rasterParticleArrayBand: StringValue = StringValue.INITIAL, rasterParticleColor: ColorValue = ColorValue.INITIAL, rasterParticleCount: LongValue = LongValue.INITIAL, rasterParticleFadeOpacityFactor: DoubleValue = DoubleValue.INITIAL, rasterParticleFadeOpacityFactorTransition: Transition = Transition.INITIAL, rasterParticleMaxSpeed: DoubleValue = DoubleValue.INITIAL, rasterParticleResetRateFactor: DoubleValue = DoubleValue.INITIAL, rasterParticleSpeedFactor: DoubleValue = DoubleValue.INITIAL, rasterParticleSpeedFactorTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

Particle animation driven by textures such as wind maps.

See also

Parameters

sourceState

the source that drives this layer.

layerId

the ID of the layer, by default, a random id will be generated with UUID.

rasterParticleArrayBand

Displayed band of raster array source layer

rasterParticleColor

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

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

rasterParticleFadeOpacityFactor

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

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

rasterParticleMaxSpeed

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

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

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

rasterParticleSpeedFactorTransition

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

visibility

Whether this layer is displayed. Default value: "visible".

minZoom

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

maxZoom

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

sourceLayer

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

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.