MapboxMapController

MapController implementation backed by Mapbox Maps SDK: wires style sources/layers, custom GL weather layers (MapboxLayerHost), camera sync (CameraSync), and Mapbox gestures (e.g. map clicks).

Construct with the same MapView you show in your activity and an XweatherAccount for API access.

See also

for weather layers, timeline, data inspector, and legends.

Constructors

Link copied to clipboard
constructor(mapView: MapView, baseContext: Context, account: XweatherAccount, lifecycleOwner: LifecycleOwner)
constructor(mapView: MapView, account: XweatherAccount)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val account: XweatherAccount
Link copied to clipboard
val animationOptions: AnimationOptions

Configuration options that control the behavior of timeline animations and data preloading.

Link copied to clipboard
lateinit var centerLatLng: Coordinate

Geographic center of the map in latitude/longitude degrees, kept in sync with the camera.

Link copied to clipboard

Pick/inspect weather values at a tap location; enable with addDataInspectorControl.

Link copied to clipboard

Internal debounce job for camera move-end handling; managed by MapboxMapController.

Link copied to clipboard

Approximate download progress fraction (0f–1f) while tiles are in flight.

Link copied to clipboard

All MapsGL map layers currently registered on this controller, keyed by layer id.

Link copied to clipboard

Optional UI control for layer legends; install with add.

Link copied to clipboard
var mapboxMap: MapboxMap?

Mapbox map handle; non-null after construction. Safe to use from the main thread once the view is attached.

Link copied to clipboard
val mapView: MapView
Link copied to clipboard

Observes encoded-tile metadata keys; when a layer id is emitted, that TileLayer refreshes visible tiles. Attach only if you extend encoded sources; normally the controller wires this internally.

Link copied to clipboard

Posted when the current load session completes (encoded downloads and bind pipeline idle).

Link copied to clipboard

Emits MapLoadProgress while map data loads. Use onLoadProgress.observe(this) { progress -> ... } like other LiveData on this controller. For coroutine / flow access, see onLoadProgressValue.

Link copied to clipboard

Same progress as onLoadProgress, exposed as a Signal for coroutine collectors.

Link copied to clipboard

Posted when loading begins for any tracked data source (e.g. tile wave started).

Link copied to clipboard

Fires with a source id after addSource registers it and the source is ready for layers.

Link copied to clipboard

The primary interface for communicating with the Xweather backend.

Link copied to clipboard
Link copied to clipboard

instance used for managing animation and time-based data.

Link copied to clipboard

Library-internal: at least one visible layer is waiting on tile data.

Link copied to clipboard

Library-internal: edge detection for post-download refresh.

Link copied to clipboard

Library-internal: previous frame had pending tile downloads.

Functions

Link copied to clipboard
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)

Hook for map SDK–specific registration of a custom layer host after MapsGL created the layer.

Link copied to clipboard
open fun addCloseable(closeable: AutoCloseable)
fun addCloseable(key: String, closeable: AutoCloseable)
Link copied to clipboard

Activates and initializes the Data Inspector control for the map.

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

Adds a new layer to the map.

Link copied to clipboard
fun addLegend(forConfig: WeatherLayerConfiguration<*, *>)

Adds or refreshes the legend defined on forConfig into the current legendControl.

Link copied to clipboard

Registers a data source. When the descriptor leaves ImageSourceDescriptor.authenticator / EncodedSourceDescriptor.authenticator / VectorSourceDescriptor.authenticator / GeoJSONSourceDescriptor.authenticator unset, this controller supplies service.authenticator automatically.

Link copied to clipboard
fun addWeatherLayer(layerCode: LayerCode, id: String? = null, beforeId: String? = null): TileLayer?

Adds a weather layer from a LayerCode preset (source + descriptor + paint from service).

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

Adds a weather layer from an explicit WeatherConfiguration (use when you built the config from WeatherService factories instead of LayerCode).

Link copied to clipboard
Link copied to clipboard
fun formatDate(date: Date): String

Formats a Date as an ISO-8601-like UTC string (first 19 chars + Z) for display or logging.

Link copied to clipboard
open override fun getBearing(): Double
Link copied to clipboard
open override fun getBounds(): LatLonBounds

Visible geographic bounds derived from Mapbox unwrapped camera bounds and VisibleGeoBounds.

Link copied to clipboard
open override fun getCenter(): Coordinate
Link copied to clipboard
Link copied to clipboard

Resolves the WeatherConfiguration that would be used for addWeatherLayer with this layerCode.

Link copied to clipboard
open override fun getFov(): Double

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

Link copied to clipboard
fun getLayer(id: String): MapLayer<*, *>?
Link copied to clipboard
open override fun getPitch(): Double
Link copied to clipboard
open override fun getSize(): Size

Returns the map's container size.

Link copied to clipboard
Link copied to clipboard

Raw unwrapped longitudes from Mapbox — not passed through VisibleGeoBounds, which can collapse the viewport to a single -180,180 strip and hide extra world copies for encoded tile draws.

Link copied to clipboard

Returns A layer given its LayerCode.

Link copied to clipboard
open override fun getZoom(): Double
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
open override fun moveLayer(id: String, beforeId: String?)

Reorders a style layer in the Mapbox style stack.

Link copied to clipboard
open override fun off(name: String, callback: (Any) -> Unit)

Removes a previously registered callback for name.

Link copied to clipboard
open override fun on(name: String, callback: (Any) -> Unit)

Registers callback for controller-issued events named name (see MapControllerEvents).

Link copied to clipboard
open override fun onConfigurationChanged(p0: Configuration)

ComponentCallbacks2: no-op; orientation is handled via camera callbacks.

Link copied to clipboard
open override fun onCreate(owner: LifecycleOwner)
Link copied to clipboard
open override fun onDestroy(owner: LifecycleOwner)
Link copied to clipboard
open override fun onLowMemory()
Link copied to clipboard
open override fun onMapClick(point: Point): Boolean

Mapbox map click: forwards to the data inspector when it is enabled.

Link copied to clipboard
open fun onPause(owner: LifecycleOwner)
Link copied to clipboard
open fun onResume(owner: LifecycleOwner)
Link copied to clipboard
open fun onStart(owner: LifecycleOwner)
Link copied to clipboard
open fun onStop(owner: LifecycleOwner)
Link copied to clipboard
open override fun onTileLayerEvent(layerId: String, eventType: TileLayer.TileLayerEventType, data: Any?)

TileLayer.TileLayerEventListener hook; reserved for future tile-layer events from Mapbox path.

Link copied to clipboard
open override fun onTrimMemory(level: Int)

Clears encoded tile caches outside the visible viewport when the OS reports memory pressure (ComponentCallbacks2); aggressive only for background / UI-hidden levels.

Link copied to clipboard

Triggers a manual pre-fetch of tile animation data.

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

Queries encoded tile layers and Mapbox vector layers at point for the given layer ids.

Link copied to clipboard
suspend fun queryFeatures(point: Point, vectorLayerList: List<VectorTileLayer>, onTouch: Boolean = true): <Error class: unknown class><String, FeatureQueryResult>?

Mapbox queryRenderedFeatures at a screen point for the given vector layers; fills data-inspector vector fields when onTouch matches the active inspector buffer.

Link copied to clipboard
suspend fun queryFeaturesInBox(boxTopLeft: ScreenCoordinate, boxBottomRight: ScreenCoordinate, vectorLayerList: List<VectorTileLayer>, onTouch: Boolean = true): <Error class: unknown class><String, FeatureQueryResult>?

Queries features within a rectangular area.

Link copied to clipboard
suspend fun queryFeaturesOld(point: Point, vectorLayerList: List<VectorTileLayer>, onTouch: Boolean = true): <Error class: unknown class><String, FeatureQueryResult>?

Legacy vector query implementation kept for compatibility; prefer queryFeatures.

Link copied to clipboard
suspend fun refreshVisibleLayers(requestDL: Boolean = true)

Recomputes visible tiles for every visible MapsGL layer and marks custom layer hosts dirty.

Link copied to clipboard

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

Link copied to clipboard
fun removeLayer(id: String, isCompounLayer: Boolean = false)

Removes a layer by id, detaches consumers, and cleans encoded-grid sidecars when present.

Link copied to clipboard

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

Link copied to clipboard

Unregisters a data source from this controller (does not remove layers that still reference it).

Link copied to clipboard

Removes the weather layer(s) for code from the map, sources, legends, and mask sidecars as needed.

Link copied to clipboard
fun setBearing(bearing: Double)

Sets map bearing (rotation in degrees; 0 = north up).

Link copied to clipboard
open override fun setCenter(center: Coordinate)

Moves the camera center while preserving the current getZoom.

Link copied to clipboard
open override fun setLayerHostToUpdate(layerId: String)

Marks the custom layer host for layerId so textures/uniforms are uploaded on the next draw pass.

Link copied to clipboard
open override fun setLayerVisible(id: String, visible: Boolean)

Syncs MapsGL layer visibility, custom layer host visibility, and Mapbox style visibility for id.

Link copied to clipboard
fun setPaintProperty(layerId: String, property: String, value: Any)

Sets a paint-related property on a layer (reserved for future Mapbox style parity; not fully implemented).

Link copied to clipboard
fun setPitch(pitch: Double)

Sets map pitch / tilt in degrees.

Link copied to clipboard

Shows or hides every map layer (and optional legend) belonging to code, including composite children.

Link copied to clipboard
open override fun setZoom(zoom: Double)

Animates or jumps the camera to the given Mapbox zoom.

Link copied to clipboard
fun trigger(type: String, data: Any? = null)

Dispatches a named event to listeners registered with on for type.