mapsglmaps/com.xweather.mapsgl.style/SamplePaint

SamplePaint

class SamplePaint(var expression: SampleExpression = SampleExpression.NUMBER, var channel: List<ColorBand> = listOf(ColorBand.red), var quality: DataQuality = DataQuality.exact, var interpolation: InterpolationMode = InterpolationMode.BICUBIC, var smoothing: Float = 0.0f, var offset: Float = 0.0f, var drawRange: ClosedRange<Double>? = null, colorScale: ColorScaleOptions = ColorScaleOptions(), var multiband: Boolean = false, var meld: Boolean = true, var encodedScalarNormMax: Double? = null, var eventEmitter: LayerEventEmitter? = null) : Paint, ColorSampling

Paint for sampled encoded-grid values: interpolation, color mapping, draw range, and timeline blending (meld). Used by SampleLayerPaint, ContourLayerPaint, and ParticleLayerPaint.

Constructors

SamplePaint

constructor(expression: SampleExpression = SampleExpression.NUMBER, channel: List<ColorBand> = listOf(ColorBand.red), quality: DataQuality = DataQuality.exact, interpolation: InterpolationMode = InterpolationMode.BICUBIC, smoothing: Float = 0.0f, offset: Float = 0.0f, drawRange: ClosedRange<Double>? = null, colorScale: ColorScaleOptions = ColorScaleOptions(), multiband: Boolean = false, meld: Boolean = true, encodedScalarNormMax: Double? = null, eventEmitter: LayerEventEmitter? = null)

Properties

channel

open override var channel: List<ColorBand>

Color band(s) to sample from the encoded data. If performing an expression operation, such as .vector, .sum or .diff, then two bands must be provided.

colorScale

open override var colorScale: ColorScaleOptions

Color scale configuration to use when rendering encoded data.

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.

encodedScalarNormMax

var encodedScalarNormMax: Double?

Shader normalization max for encoded-grid sidecar symbols; when null, colorScale.range end is used.

eventEmitter

var eventEmitter: LayerEventEmitter?

expression

open override var expression: SampleExpression

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

interpolation

open override var interpolation: InterpolationMode

Type of interpolation to perform on the data.

meld

var meld: Boolean

Whether values should be linearly interpolated between the current and next timeline intervals during animation (JS paint.sample.meld). When false, sampling and draw use the current interval only (stepped). Default true.

multiband

var multiband: 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.

quality

open override var quality: DataQuality

Controls the data resolution that gets requested by the layer's data source and rendered to the map. Data will be interpolated when rendering to the map to ensure low resolution/quality data is still smooth.

smoothing

open override var smoothing: Float

Amount of smoothing to apply on the data from 0 (no smoothing) to 1 (full smoothing). Increasing this value is useful for low resolution data sets or when higher detail is not desired or needed.