mapsglmaps/com.xweather.mapsgl.style/IconPaint

IconPaint

class IconPaint(allowOverlap: StyleValue<Boolean> = StyleValue.Constant(true), image: StyleValue<String>? = null, size: StyleValue<Double>? = null, iconSize: IconSize? = null, atlas: IconAtlas? = null, anchor: StyleValue<Anchor> = StyleValue.Constant(Anchor.CENTER), offset: StyleValue<AnchorOffset> = StyleValue.Constant(AnchorOffset()), padding: StyleValue<Double> = StyleValue.Constant(0.0), rotation: Double = 0.0, rotationUsesDataDirection: Boolean = false, scale: StyleValue<Double>? = null, type: String? = null, spin: Boolean = false, spinDegreesPerSecond: Float = 180.0f, shader: String? = null, factor: StyleValue<Double>? = null, placement: SymbolPlacementPaint? = null, source: IconSourcePaint? = null) : Paint

Icon style options (Apple IconPaint). Prefer placement / source for new code; named constructor parameters (image, atlas, allowOverlap, …) remain supported for existing call sites.

Constructors

IconPaint

constructor(allowOverlap: StyleValue<Boolean> = StyleValue.Constant(true), image: StyleValue<String>? = null, size: StyleValue<Double>? = null, iconSize: IconSize? = null, atlas: IconAtlas? = null, anchor: StyleValue<Anchor> = StyleValue.Constant(Anchor.CENTER), offset: StyleValue<AnchorOffset> = StyleValue.Constant(AnchorOffset()), padding: StyleValue<Double> = StyleValue.Constant(0.0), rotation: Double = 0.0, rotationUsesDataDirection: Boolean = false, scale: StyleValue<Double>? = null, type: String? = null, spin: Boolean = false, spinDegreesPerSecond: Float = 180.0f, shader: String? = null, factor: StyleValue<Double>? = null, placement: SymbolPlacementPaint? = null, source: IconSourcePaint? = null)

Properties

allowOverlap

var allowOverlap: StyleValue<Boolean>

Whether icons can overlap other icons.

anchor

var anchor: StyleValue<Anchor>

Positioning anchor of the icon.

atlas

var atlas: IconAtlas?

Declarative atlas (JS / Apple icon.atlas).

factor

var factor: StyleValue<Double>?

Per-feature data value for custom shader as v_factor (JS paint.icon.factor).

iconHeight

var iconHeight: StyleValue<Double>?

Per-feature icon height in JS icon pixels. See iconWidth; both must be set for the per-axis path to apply.

iconSize

var iconSize: IconSize?

Optional width/height in JS icon pixels. Takes precedence over size/scale for instanced wind / GLES layout when non-null.

iconWidth

var iconWidth: StyleValue<Double>?

Per-feature icon width in JS icon pixels (JS parity paint.icon.size.width as an expression). Takes precedence over iconSize and size when set.

image

var image: StyleValue<String>?

The name of the image to display.

offset

var offset: StyleValue<AnchorOffset>

Offset of the icon from its anchor position.

padding

var padding: StyleValue<Double>

Padding around the icon.

pitchWithMap

var pitchWithMap: Boolean

Whether the icon pitches with the map (Apple placement.pitchWithMap).

placement

var placement: SymbolPlacementPaint

Placement shared with other symbol types (Apple IconPaint.placement). Default allowOverlap = true preserves prior Android icon defaults.

rotateWithMap

var rotateWithMap: Boolean

Whether the icon rotates with map bearing (Apple placement.rotateWithMap).

rotation

var rotation: Double

Constant rotation offset in degrees (e.g. -90 for wind barb/arrow base tilt). When rotationUsesDataDirection is true, Mapbox icon rotation is dir + rotation from encoded features.

rotationUsesDataDirection

var rotationUsesDataDirection: Boolean

When true, rotationExpression uses dir + rotation via Expression.get("dir"); when false, rotation is constant.

scale

var scale: StyleValue<Double>?

Multiplier applied to the source sprite's native size (Apple/Mapbox icon-size / scale). Ignored when iconSize is set. Takes precedence over size for Style JSON when both are set.

shader

var shader: String?

Custom GLSL fragment shader source (JS paint.icon.shader). Layer-level constant.

size

var size: StyleValue<Double>?

Absolute icon size in screen points as a Mapbox-style scalar multiplier when iconSize is unset (legacy). Prefer iconSize for pixel dimensions or scale for Mapbox icon-size.

source

var source: IconSourcePaint

Source used to resolve the icon image (Apple IconPaint.source).

spin

var spin: Boolean

When true, the icon rotates continuously (adds elapsedSeconds * spinDegreesPerSecond to rotation every frame) instead of holding a static rotation.

spinDegreesPerSecond

var spinDegreesPerSecond: Float

Rotation speed in degrees/second when spin is true. Positive spins counter-clockwise on screen, which is the cyclonic direction in the northern hemisphere; factor flips it per feature for southern-hemisphere storms.

type

var type: String?

Optional grid-only built-in symbol type (Apple icon.type).

Functions

copy

fun copy(allowOverlap: StyleValue<Boolean> = this.allowOverlap, image: StyleValue<String>? = this.image, size: StyleValue<Double>? = this.size, scale: StyleValue<Double>? = this.scale, iconSize: IconSize? = this.iconSize, atlas: IconAtlas? = this.atlas, type: String? = this.type, anchor: StyleValue<Anchor> = this.anchor, offset: StyleValue<AnchorOffset> = this.offset, padding: StyleValue<Double> = this.padding, rotation: Double = this.rotation, rotationUsesDataDirection: Boolean = this.rotationUsesDataDirection, spin: Boolean = this.spin, spinDegreesPerSecond: Float = this.spinDegreesPerSecond, shader: String? = this.shader, factor: StyleValue<Double>? = this.factor, rotateWithMap: Boolean = this.placement.rotateWithMap, pitchWithMap: Boolean = this.placement.pitchWithMap, source: IconSourcePaint = this.source): IconPaint

Shallow copy for tests / paint mutation helpers (IconPaint is no longer a data class).

equals

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

Value equality, kept by hand because IconPaint stopped being a data class when its constructor parameters became body properties backed by placement and source.

hashCode

open override fun hashCode(): Int

resolvedIconSizeStyle

fun resolvedIconSizeStyle(): StyleValue<Double>?

Mapbox icon-size value for Style JSON: scale, else derived from iconSize, else size.

toString

open override fun toString(): String