mapsglmaps/com.xweather.mapsgl.map/MapController

MapController

abstract class MapController(val mapView: MapView, val account: XweatherAccount) : ViewModel, MapProvider, DefaultLifecycleObserver, TileLayer.TileLayerEventListener, ComponentCallbacks2, OnMapClickListener

A MapController class acts as the interface between the map view of a mapping library and MapsGL-specific functionality.

Inheritors

MapboxMapController

Constructors

MapController

constructor(mapView: MapView, account: XweatherAccount)

Properties

account

val account: XweatherAccount

centerLatLng

lateinit var centerLatLng: Coordinate

dataInspector

val dataInspector: DataInspectorControl

debounceMoveEndJob

var debounceMoveEndJob: Job?

layers

var layers: MutableMap<String, MapLayer<*, *>>

legendControl

var legendControl: LegendControl?

mapView

val mapView: MapView

metadataObserver

val metadataObserver: Observer<String>

onLoadComplete

val onLoadComplete: LiveData<Unit>

Fired when all data sources have finished loading.

onLoadStart

val onLoadStart: LiveData<Unit>

Fired when loading begins for any data source.

onSourceAdded

val onSourceAdded: Signal<String>

service

val service: WeatherService

thisMap

val thisMap: MapController

timeline

val timeline: Timeline

instance used for managing animation and time-based data.

waitingOnDL

var waitingOnDL: Boolean

wasWaitingOnDL

var wasWaitingOnDL: Boolean

Functions

add

fun add(legendControl: LegendControl?)

Installs the provided legend control, wiring it to map events and populating initial legends.

open fun add(layerID: String, layerHost: CustomLayerHost)

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

addDataInspectorControl

fun addDataInspectorControl(mapView: MapView): DataInspectorControl

Activates and initializes the Data Inspector control for the map.

addLayer

fun <P : LayerPaint> addLayer(descriptor: LayerDescriptor<P>, beforeID: String?): TileLayer?

Adds a new layer to the map.

addLegend

fun addLegend(forConfig: WeatherLayerConfiguration<*, *>)

addSource

fun addSource(descriptor: SourceDescriptor): DataSource

addWeatherLayer

fun addWeatherLayer(layerCode: LayerCode, id: String? = null, beforeId: String? = null): TileLayer?

Adds a new weather layer to the map.

fun addWeatherLayer(config: WeatherConfiguration, id: String? = null, beforeId: String? = null, isCompoundLayer: Boolean = false): TileLayer?

getBearing

open override fun getBearing(): Double

Returns the map's current rotational bearing in degrees, if supported. A bearing of 0 orients the map so that north is up.

getBounds

open override fun getBounds(): LatLonBounds

getCenter

open override fun getCenter(): Coordinate

Returns the map's geographical center coordinate.

getCloseable

fun <T : AutoCloseable> getCloseable(key: String): T?

getConfigForCode

fun getConfigForCode(layerCode: LayerCode): WeatherConfiguration

getFov

open override fun getFov(): Double

Returns the map camera's current field-of-view in degrees.

getLayer

fun getLayer(id: String): MapLayer<*, *>?

Returns the layer associated with the specified identifier if it exists.

getPitch

open override fun getPitch(): Double

Returns the map's current pitch/tilt in degrees, if supported.

getSize

open override fun getSize(): Size

Returns the map's container size.

getSource

fun getSource(id: String): DataSource?

getWeatherLayer

fun getWeatherLayer(code: LayerCode): MapLayer<*, *>?

Returns A layer given its LayerCode.

getZoom

open override fun getZoom(): Double

Returns the map's current zoom level.

hasLayer

fun hasLayer(id: String): Boolean

hasSource

fun hasSource(id: String): Boolean

Returns whether the map currently contains a data source with the specified identifier.

hasWeatherLayer

fun hasWeatherLayer(code: LayerCode): Boolean

Returns whether the map currently contains a weather layer with the specified identifier.

moveLayer

open fun moveLayer(id: String, beforeId: String?)

off

open override fun off(name: String, callback: (Any) -> Unit)

open override fun on(name: String, callback: (Any) -> Unit)

onConfigurationChanged

abstract fun onConfigurationChanged(p0: Configuration)

onCreate

open override fun onCreate(owner: LifecycleOwner)

onDestroy

open override fun onDestroy(owner: LifecycleOwner)

onLowMemory

abstract fun ~~onLowMemory~~()

onMapClick

open override fun onMapClick(point: Point): Boolean

onPause

open fun onPause(owner: LifecycleOwner)

onResume

open fun onResume(owner: LifecycleOwner)

onStart

open fun onStart(owner: LifecycleOwner)

onStop

open fun onStop(owner: LifecycleOwner)

onTileLayerEvent

abstract fun onTileLayerEvent(layerId: String, eventType: TileLayer.TileLayerEventType, data: Any? = null)

onTrimMemory

abstract fun onTrimMemory(p0: Int)

query

suspend fun query(point: Point, layerList: List<String>, onTouch: Boolean = false): <Error class: unknown class><String, FeatureQueryResult>

removeDataInspectorControl

fun removeDataInspectorControl()

Deactivates the Data Inspector control and cleans up its associated resources.

removeLayer

fun removeLayer(id: String, isCompounLayer: Boolean = false)

removeLegendControl

fun removeLegendControl()

Removes the currently installed legend control and clears any associated observers.

removeSource

fun removeSource(id: String)

removeWeatherLayer

fun removeWeatherLayer(code: LayerCode)

Removes a layer from the map.

setCenter

open fun setCenter(center: Coordinate)

Sets the map's geographical center coordinate.

setLayerHostToUpdate

open fun setLayerHostToUpdate(layerId: String)

Sets textures to bind

setLayerVisible

open fun setLayerVisible(id: String, visible: Boolean = true)

Shows or hides the layer with matching id

setPaintProperty

fun setPaintProperty(layerId: String, property: String, value: Any)

setWeatherLayerVisibility

fun setWeatherLayerVisibility(code: LayerCode, visible: Boolean)

setZoom

open fun setZoom(zoom: Double)

Sets the map's zoom level.

trigger

fun trigger(type: String, data: Any? = null)