mapsglmaps/com.xweather.mapsgl.layers.style/ParticleStyle

ParticleStyle

class ParticleStyle(var expression: SampleExpression = SampleExpression.NUMBER, var channels: List<ColorBand> = listOf(ColorBand.red), var quality: DataQuality = DataQuality.normal, var interpolation: InterpolationMode = InterpolationMode.BICUBIC, var smoothing: Float = 0.0f, var offset: Float = 0.0f, var drawRange: ClosedRange<Double>? = null, var colorScale: ColorScaleOptions = ColorScaleOptions(), var opacity: Float = 1.0f, var density: ParticleDensity = ParticleDensity.NORMAL, var count: Int = 0, var size: Float = 2.0f, var speedFactor: Float = 1.0f, var trails: Boolean = true, var trailsFadeFactor: Float = 0.97f, var dropRate: Float = 1.0f, var dropRateBump: Float = 1.0f, val vectorOffset: Float = 0.5f) : RasterStyle, ColorSampling

Particle style.

Constructors

ParticleStyle

constructor(expression: SampleExpression = SampleExpression.NUMBER, channels: List<ColorBand> = listOf(ColorBand.red), quality: DataQuality = DataQuality.normal, interpolation: InterpolationMode = InterpolationMode.BICUBIC, smoothing: Float = 0.0f, offset: Float = 0.0f, drawRange: ClosedRange<Double>? = null, colorScale: ColorScaleOptions = ColorScaleOptions(), opacity: Float = 1.0f, density: ParticleDensity = ParticleDensity.NORMAL, count: Int = 0, size: Float = 2.0f, speedFactor: Float = 1.0f, trails: Boolean = true, trailsFadeFactor: Float = 0.97f, dropRate: Float = 1.0f, dropRateBump: Float = 1.0f, vectorOffset: Float = 0.5f)

Create ParticleStyle

Properties

channel

open override var channel: SampleChannel

channels

open override var channels: List<ColorBand>

Which of 3 rgb channels from the source image to use. Default is ColorBand.red

colorScale

open override var colorScale: ColorScaleOptions

A ColorScale maps numeric values to a color palette. The scale can then be used to generate a set of colors for a given range of values and options.

count

var count: Int

darkBackground

var darkBackground: Boolean

density

var density: ParticleDensity

The density of the particles. default is ParticleDensity.NORMAL.

drawRange

open override var drawRange: ClosedRange<Double>?

Limits the data range that should be rendered from the sampled data. If not provided, then the full data range provided by the associated data source will be rendered by default.

dropRate

var dropRate: Float

dropRateBump

var dropRateBump: Float

expression

open override var expression: SampleExpression

Determines how data should be sampled from the encoded data texture.

interpolation

open override var interpolation: InterpolationMode

The type of blending done on the source texture. The default is InterpolationMode.BICUBIC.

needsRotationHandled

var needsRotationHandled: Boolean

offset

open override var offset: Float

Normalized amount to shift the interpolated sample values from 0 to 1. This is typically used for expression operations like diff where interpolated values can be negative and you need to start values half way (0.5) between the colorscale.range.

opacity

open override var opacity: Float

The opacity of the particles, from 0f to 1f. Default is 1f.

quality

open override var quality: DataQuality

The resolution of the underlying texture. Default is DataQuality.normal

size

var size: Float

The size of the individual particles. Default is 2f

smoothing

open override var smoothing: Float

The amount of smoothing used on the the source texture.