mapsglmaps/com.xweather.mapsgl.layers.tile/VectorTileLayer

VectorTileLayer

open class VectorTileLayer(var id: String, var source: TileSource<TileData>, var paint: VectorLayerPaint, var tileLayerRenderer: TileLayerRenderer<TileData, LayerRenderContext<Any>>, var zoomOffset: Int, val externalScope: CoroutineScope) : TileLayer

VectorTileLayer.kt

Author

Jason Suto 5/26/25

Constructors

VectorTileLayer

constructor(id: String, source: TileSource<TileData>, paint: VectorLayerPaint, tileLayerRenderer: TileLayerRenderer<TileData, LayerRenderContext<Any>>, zoomOffset: Int, externalScope: CoroutineScope)

Properties

alpha

open override var alpha: Float

alreadyRequested

var alreadyRequested: MutableList<TileCoord>

animator

open override var animator: TimeSeriesAnimator<Data>?

bounds

var bounds: LatLonBounds?

code

var code: String

coords

var coords: List<TileCoord>?

currentTileBounds

var currentTileBounds: TileBounds?

drawContext

lateinit var drawContext: Context

enabled

open override var enabled: Boolean

eventDispatcher

override var eventDispatcher: EventDispatcher

externalScope

val externalScope: CoroutineScope

filter

var filter: Expression?

override var id: String

invertMaskLayer

open override var invertMaskLayer: Boolean

Whether to invert the mask layer's output.

isDirty

open override var isDirty: Boolean

lastTileBounds

var lastTileBounds: TileBounds?

layerRenderContext

open override var layerRenderContext: LayerRenderContext<Any>

mapController

open override var mapController: MapController?

The map controller that this layer is associated with.

numH

open override var numH: Int

numW

open override var numW: Int

oldCoords

val oldCoords: List<TileCoord>? = null

paint

open override var paint: LayerPaint

persistentTileBounds

var persistentTileBounds: TileBounds?

pyramid

val pyramid: TilePyramid<DataType>

renderer

open override var renderer: LayerRenderer<Any>

source

open override var source: TileSource<TileData>

sourceEventHandlers

open override var sourceEventHandlers: MutableList<MapLayer.SourceEventHandler>

sourceLayer

var sourceLayer: String?

tileBoundsChanged

var tileBoundsChanged: Boolean

tileLayerRenderer

var tileLayerRenderer: TileLayerRenderer<TileData, LayerRenderContext<Any>>

tileRequestOptions

val tileRequestOptions: TileRequestOptions

timeSeries

open override var timeSeries: AnyTimeSeries?

The time series associated with the layer, if any.

timing

open lateinit override var timing: LayerTiming

The layer's timing configuration.

type

open lateinit override var type: LayerType

The type of layer.

viewport

open override val viewport: Viewport?

viewport

val MapLayer<*, *>.viewport: Viewport?

visible

open override var visible: Boolean

var z: Double

zoomOffset

var zoomOffset: Int

Functions

addSourceEventHandler

open fun addSourceEventHandler(event: String, handler: (e: Any?) -> Unit, once: Boolean = false)

boundsHaveChanged

fun boundsHaveChanged(b1: TileBounds, b2: TileBounds): Boolean

createTimeSeriesDataProvider

open override fun createTimeSeriesDataProvider(): TimeSeriesDataProvider<TileLayer>?

Returns the time series data provider to use for animating the layer, if any.

getVisibleTileCoords

fun getVisibleTileCoords(): List<TileCoord>

Used in TileTimeSeriesDataProvider. Needs testing

open override fun getVisibleTileCoords(latLonBounds: LatLonBounds, tileBounds: TileBounds, zoom: Double, fromGetRenderables: Boolean): List<TileCoord>

Recieves LatLonBounds and zoom level

hide

open fun hide()

latToTile

fun latToTile(lat: Double, zoom: Int): Int

onAdd

open override fun onAdd()

open override fun onAdd(context: Context, controller: MapController)

open override fun onAdd(context: RenderContext<Any>, tileLayer: TileLayer, controller: MapboxMapController)

onClick

open override fun onClick()

onHidden

open override fun onHidden()

onMove

open suspend override fun onMove()

Gets bounds and requests visible tiles

onMoveEnd

open suspend override fun onMoveEnd()

onMoveStart

open override fun onMoveStart()

onReady

open fun onReady()

onRemove

open override fun onRemove()

onResize

open override fun onResize()

onSourceMetadata

open fun onSourceMetadata()

Called when the data source's metadata has been loaded.

onVisible

open override fun onVisible()

prerender

open override fun prerender(elapsedTime: Double)

publisher

inline fun <EventType : Event> EventSource.publisher(eventType: Class<EventType>): Flow<EventType>

refresh

open fun refresh(clear: Boolean = false)

Refreshes the layer by re-rendering it. If a complete refresh is needed including triggering the associated data source to reload, then pass an argument of true when calling the method. Otherwise, existing cached data will be used when the layer is re-rendered.

render

open override fun render(texUnit: <Error class: unknown class><String, Int>, camera: Camera)

Called from LayerHost.render(), calls TileLayerRenderer.draw()

requestVisibleTiles

suspend fun requestVisibleTiles(bounds: LatLonBounds, reload: Boolean = false, fromAnimation: Boolean = false)

setNeedsUpdate

open override fun setNeedsUpdate(force: Boolean)

Flags the layer as dirty so that it is updated during the next render frame.

show

open fun show()

inline suspend fun <EventType : Event> EventSource.subscribe(eventType: Class<EventType>, crossinline handler: (EventType) -> Unit)

trigger

fun <EventType : Event> EventSource.trigger(event: EventType)

update

open suspend override fun update()

Calls requestVisibleTiles(), gets bounds if needed.