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

MapLayer

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

Inheritors

Types

SourceEventHandler

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

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

Properties

abstract var alpha: Float

abstract var animator: TimeSeriesAnimator<Data>?

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.

abstract var isDirty: Boolean

layerRenderContext

abstract var layerRenderContext: RenderContext

abstract var mapController: MapController?

The map controller that this layer is associated with.

abstract var numH: Int

abstract var numW: Int

abstract var paint: LayerPaint

abstract var renderer: LayerRenderer<Any>

abstract var source: TileSource<DataType>

sourceEventHandlers

abstract var sourceEventHandlers: MutableList<MapLayer.SourceEventHandler>

abstract var timeSeries: AnyTimeSeries?

The time series associated with the layer, if any.

abstract var timing: LayerTiming

The layer's timing configuration.

abstract var type: LayerType

The type of layer.

abstract val viewport: Viewport?

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

abstract var visible: 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.

getVisibleTileCoords

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

open fun hide()

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

abstract fun onAdd()

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

abstract fun onClick()

open override fun onHidden()

abstract suspend fun onMove()

abstract suspend fun onMoveEnd()

abstract fun onMoveStart()

open fun onReady()

abstract fun onRemove()

abstract fun onResize()

onSourceMetadata

open fun onSourceMetadata()

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

open override fun onVisible()

abstract fun prerender(elapsedTime: Double)

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

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.

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

open fun setNeedsUpdate(force: Boolean = false)

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

open fun show()

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

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

abstract suspend fun update()