MapControllable

interface MapControllable : MapboxLifecycleObserver

MapControllable interface is the gateway for public API to talk to the internal map controller.

Functions

addRendererSetupErrorListener
Link copied to clipboard
abstract fun addRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Add an instance of RendererSetupErrorListener.

addWidget
Link copied to clipboard
abstract fun addWidget(widget: Widget)

Add Widget to the map.

getMapboxMap
Link copied to clipboard
abstract fun getMapboxMap(): MapboxMap

Returns a MapboxMap object that can be used to interact with the map.

onDestroy
Link copied to clipboard
abstract fun onDestroy()
onGenericMotionEvent
Link copied to clipboard
abstract fun onGenericMotionEvent(event: MotionEvent): Boolean

Called when a motion event has occurred.

onLowMemory
Link copied to clipboard
abstract fun onLowMemory()
onSizeChanged
Link copied to clipboard
abstract fun onSizeChanged(w: Int, h: Int)

Called when the size has changed.

onStart
Link copied to clipboard
abstract fun onStart()
onStop
Link copied to clipboard
abstract fun onStop()
onTouchEvent
Link copied to clipboard
abstract fun onTouchEvent(event: MotionEvent): Boolean

Called when a touch event has occurred.

queueEvent
Link copied to clipboard
abstract fun queueEvent(event: Runnable, needRender: Boolean = true)

Queue a runnable to be executed on the map renderer thread.

removeRendererSetupErrorListener
Link copied to clipboard
abstract fun removeRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Remove an instance of RendererSetupErrorListener.

removeWidget
Link copied to clipboard
abstract fun removeWidget(widget: Widget): Boolean

Remove Widget from the map.

setMaximumFps
Link copied to clipboard
abstract fun setMaximumFps(fps: Int)

Called to limit the maximum fps

setOnFpsChangedListener
Link copied to clipboard
abstract fun setOnFpsChangedListener(listener: OnFpsChangedListener)

Set OnFpsChangedListener to get map rendering FPS.

snapshot
Link copied to clipboard
abstract fun snapshot(): Bitmap?

Called to capture a snapshot synchronously.

abstract fun snapshot(listener: MapView.OnSnapshotReady)

Called to capture a snapshot asynchronously.

Inheritors

MapSurface
Link copied to clipboard
MapView
Link copied to clipboard