mapbox-maps-android/com.mapbox.maps.plugin.gestures/GesturesPlugin

GesturesPlugin

interface GesturesPlugin : MapPlugin, ContextBinder, MapSizePlugin, GesturesSettingsInterface

Define the interfaces for the Layer plugin.

Functions

addOnFlingListener

abstract fun addOnFlingListener(onFlingListener: OnFlingListener)

Add a fling gesture listener that is invoked when a map is flinged

addOnMapClickListener

abstract fun addOnMapClickListener(onMapClickListener: OnMapClickListener)

Add a map click listener that is invoked when a map is clicked.

addOnMapLongClickListener

abstract fun addOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

Add a map long click listener that is invoked when a map is clicked.

addOnMoveListener

abstract fun addOnMoveListener(onMoveListener: OnMoveListener)

Add a move gesture listener that is invoked when a map is moved

addOnRotateListener

abstract fun addOnRotateListener(onRotateListener: OnRotateListener)

Add a rotation gesture listener that is invoked when a map is rotated

addOnScaleListener

abstract fun addOnScaleListener(onScaleListener: OnScaleListener)

Add a scale gesture listener that is invoked when a map is scaled

addOnShoveListener

abstract fun addOnShoveListener(onShoveListener: OnShoveListener)

Add a shove gesture listener tha is invoked when a map is shoved

addProtectedAnimationOwner

abstract fun addProtectedAnimationOwner(owner: String)

Add animator owner (see CameraAnimatorOptions.owner or MapAnimationOptions.owner which animation will not be canceled with when gesture animation is about to start.

bind

abstract fun bind(context: Context, attrs: AttributeSet?, pixelRatio: Float)

Bind the ViewPlugin with current map context.

cleanup

open fun cleanup()

Called when the map is destroyed.

equals

open operator fun equals(other: Any?): Boolean

getGesturesManager

abstract fun getGesturesManager(): AndroidGesturesManager

Get the current configured gesture manager

getSettings

abstract fun getSettings(): GesturesSettings

Get current gestures configuration.

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onGenericMotionEvent

abstract fun onGenericMotionEvent(event: MotionEvent): Boolean

Called for events that don't fit the other handlers.

onSizeChanged

open fun onSizeChanged(width: Int, height: Int)

Invoked when MapView's width and height have changed.

onTouchEvent

abstract fun onTouchEvent(motionEvent: MotionEvent?): Boolean

Called when user touches the screen, all positions are absolute.

removeOnFlingListener

abstract fun removeOnFlingListener(onFlingListener: OnFlingListener)

Remove a fling gesture listener that is invoked when a map is flinged

removeOnMapClickListener

abstract fun removeOnMapClickListener(onMapClickListener: OnMapClickListener)

Remove a map click listener that is invoked when a map is clicked.

removeOnMapLongClickListener

abstract fun removeOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

Add a map long click listener that is invoked when a map is clicked.

removeOnMoveListener

abstract fun removeOnMoveListener(listener: OnMoveListener)

Remove a move gesture listener that is invoked when a map is moved

removeOnRotateListener

abstract fun removeOnRotateListener(listener: OnRotateListener)

Remove a rotate gesture listener that is invoked when a map is rotated

removeOnScaleListener

abstract fun removeOnScaleListener(listener: OnScaleListener)

Remove a callback that is invoked when the map is scaled.

removeOnShoveListener

abstract fun removeOnShoveListener(listener: OnShoveListener)

Remove a shove gesture listener that is invoked wen a map is shoved

removeProtectedAnimationOwner

abstract fun removeProtectedAnimationOwner(owner: String)

Remove animator owner (see CameraAnimatorOptions.owner or MapAnimationOptions.owner) which animation will not be canceled with when gesture animation is about to start.

setGesturesManager

abstract fun setGesturesManager(internalGesturesManager: AndroidGesturesManager, attachDefaultListeners: Boolean, setDefaultMutuallyExclusives: Boolean)

Set internal gesture manager

toString

open fun toString(): String

updateSettings

abstract fun updateSettings(block: GesturesSettings.() -> Unit)

Update gestures configuration, the update will be applied to the plugin automatically.

Properties

doubleTapToZoomInEnabled

abstract var doubleTapToZoomInEnabled: Boolean

Whether double tapping the map with one touch results in a zoom-in animation.

doubleTouchToZoomOutEnabled

abstract var doubleTouchToZoomOutEnabled: Boolean

Whether single tapping the map with two touches results in a zoom-out animation.

focalPoint

abstract var focalPoint: ScreenCoordinate?

By default, gestures rotate and zoom around the center of the gesture.

increasePinchToZoomThresholdWhenRotating

abstract var increasePinchToZoomThresholdWhenRotating: Boolean

Whether pinch to zoom threshold increases when rotating.

increaseRotateThresholdWhenPinchingToZoom

abstract var increaseRotateThresholdWhenPinchingToZoom: Boolean

Whether rotate threshold increases when pinching to zoom.

pinchToZoomDecelerationEnabled

abstract var pinchToZoomDecelerationEnabled: Boolean

Whether a deceleration animation following a pinch-to-zoom gesture is enabled.

pinchToZoomEnabled

abstract var pinchToZoomEnabled: Boolean

Whether the pinch to zoom gesture is enabled.

pitchEnabled

abstract var pitchEnabled: Boolean

Whether the pitch gesture is enabled.

quickZoomEnabled

abstract var quickZoomEnabled: Boolean

Whether the quick zoom gesture is enabled.

rotateDecelerationEnabled

abstract var rotateDecelerationEnabled: Boolean

Whether a deceleration animation following a rotate gesture is enabled.

rotateEnabled

abstract var rotateEnabled: Boolean

Whether the rotate gesture is enabled.

scrollDecelerationEnabled

abstract var scrollDecelerationEnabled: Boolean

Whether a deceleration animation following a scroll gesture is enabled.

scrollEnabled

abstract var scrollEnabled: Boolean

Whether the single-touch scroll gesture is enabled.

scrollMode

abstract var scrollMode: ScrollMode

Configures the directions in which the map is allowed to move during a scroll gesture.

simultaneousRotateAndPinchToZoomEnabled

abstract var simultaneousRotateAndPinchToZoomEnabled: Boolean

Whether rotation is enabled for the pinch to zoom gesture.

zoomAnimationAmount

abstract var zoomAnimationAmount: Float

The amount by which the zoom level increases or decreases during a double-tap-to-zoom-in or double-touch-to-zoom-out gesture.

Inheritors

GesturesPluginImpl