mapbox-maps-android/com.mapbox.maps/MapControllable

MapControllable

interface MapControllable : MapboxLifecycleObserver

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

Functions

addRendererSetupErrorListener

abstract fun addRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Add an instance of RendererSetupErrorListener.

addWidget

@MapboxExperimental

abstract fun addWidget(widget: Widget)

Add Widget to the map.

onDestroy

abstract fun onDestroy()

onGenericMotionEvent

abstract fun onGenericMotionEvent(event: MotionEvent): Boolean

Called when a motion event has occurred.

onLowMemory

abstract fun onLowMemory()

onSizeChanged

abstract fun onSizeChanged(w: Int, h: Int)

Called when the size has changed.

onStart

abstract fun onStart()

onStop

abstract fun onStop()

onTouchEvent

abstract fun onTouchEvent(event: MotionEvent): Boolean

Called when a touch event has occurred.

queueEvent

abstract fun queueEvent(event: Runnable, needRender: Boolean = true)

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

removeRendererSetupErrorListener

abstract fun removeRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener)

Remove an instance of RendererSetupErrorListener.

removeWidget

@MapboxExperimental

abstract fun removeWidget(widget: Widget): Boolean

Remove Widget from the map.

setMaximumFps

abstract fun setMaximumFps(fps: Int)

Called to limit the maximum fps

setOnFpsChangedListener

abstract fun setOnFpsChangedListener(listener: OnFpsChangedListener)

Set OnFpsChangedListener to get map rendering FPS.

setRenderThreadStatsRecorder

@MapboxExperimental

abstract fun setRenderThreadStatsRecorder(renderThreadStatsRecorder: RenderThreadStatsRecorder)

Set RenderThreadStatsRecorder to record frame stats.

snapshot

abstract fun snapshot(): Bitmap?

Called to capture a snapshot synchronously.

abstract fun snapshot(listener: MapView.OnSnapshotReady)

Called to capture a snapshot asynchronously.

Properties

mapboxMap

abstract val mapboxMap: MapboxMap

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

Inheritors

MapSurface

MapView