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

MapLayer

interface MapLayer<DataType : TileData, RenderContext : LayerRenderContext<Any>> : MapEventObserver, EventSource

A tile-backed map layer: grid dimensions, source, paint, renderer, timeline, and visibility.

Concrete implementations include TileLayer subclasses (encoded sample, raster, vector, particles). Register layers with com.xweather.mapsgl.map.MapController.addLayer / weather helpers; the controller wires mapController, renderer, and Mapbox custom layer hosting.

Parameters

DataType

Tile payload type from source.

RenderContext

Renderer context type passed into the GL pipeline.

Inheritors

TileLayer

Types

SourceEventHandler

data class SourceEventHandler(val event: String, val handler: (Any?) -> Unit)

Registered source event name and callback (future hook parity with JS event bus).

TimeSeriesData

data class TimeSeriesData(val loading: Boolean = false, val valid: Boolean = false)

Properties

alpha

abstract var alpha: Float

animator

abstract var animator: TimeSeriesAnimator<Data>?

enabled

abstract var enabled: Boolean

eventDispatcher

abstract val eventDispatcher: EventDispatcher

abstract val id: String

invertMaskLayer

abstract var invertMaskLayer: Boolean

Whether to invert the mask layer's output.

isDirty

abstract var isDirty: Boolean

layerRenderContext

abstract var layerRenderContext: RenderContext

mapController

abstract var mapController: MapController?

The map controller that this layer is associated with.

numH

abstract var numH: Int

numW

abstract var numW: Int

paint

abstract var paint: LayerPaint

renderer

abstract var renderer: LayerRenderer<Any>

source

abstract var source: TileSource<DataType>

sourceEventHandlers

abstract var sourceEventHandlers: MutableList<MapLayer.SourceEventHandler>

timeSeries

abstract var timeSeries: AnyTimeSeries?

The time series associated with the layer, if any.

timing

abstract var timing: LayerTiming

The layer's timing configuration.

type

abstract var type: LayerType

The type of layer.

viewport

abstract val viewport: Viewport?

viewport

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

visible

abstract var visible: Boolean

waitingOnDL

abstract var waitingOnDL: Boolean

wasWaitingOnDL

abstract var wasWaitingOnDL: Boolean

Functions

addSourceEventHandler

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

createTimeSeriesDataProvider

open fun createTimeSeriesDataProvider(): TimeSeriesDataProvider<TileLayer>?

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

getInfoForLocation

abstract fun getInfoForLocation(lat: Double, lng: Double, zoom: Int): String

getVisibleTileCoords

abstract fun getVisibleTileCoords(latLonBounds: LatLonBounds, tileBounds: TileBounds, zoom: Double, wrap: Boolean): List<TileCoord>

hide

open fun hide()

onAdd

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

abstract fun onAdd()

Called when the observer is attached with no tile-layer context (simple registration).

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

Called when the observer is attached with render context and owning tile layer / controller.

onClick

abstract fun onClick()

Map tap / click routed from the gestures plugin.

onHidden

open override fun onHidden()

Observer or host layer became hidden.

onMove

abstract suspend fun onMove()

Invoked while the map camera is moving (per frame or throttled).

onMoveEnd

abstract suspend fun onMoveEnd()

Invoked once when a camera movement settles.

onMoveStart

abstract fun onMoveStart()

First callback when a gesture or programmatic camera change begins.

onReady

open fun onReady()

onRemove

abstract fun onRemove()

Called when the observer is removed from the map; release GL or listeners here.

onResize

abstract fun onResize()

Host view size or map drawable size changed.

onSourceMetadata

open fun onSourceMetadata()

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

onVisible

open override fun onVisible()

Observer or host layer became visible.

prerender

abstract fun prerender(elapsedTime: Double)

publisher

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

queryFeatures

abstract fun queryFeatures(zoomVar: Int, latTile: Int, lonTile: Int, latPix: Int, lonPix: Int, queryLon: Double? = null, queryLat: Double? = null): Any?

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

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

setNeedsUpdate

open fun setNeedsUpdate(force: Boolean = false)

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

abstract suspend fun update()

Periodic or explicit update tick (animation, data refresh hooks).