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

androidJvm

abstract fun addOnFlingListener(onFlingListener: OnFlingListener)

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

addOnMapClickListener

androidJvm

abstract fun addOnMapClickListener(onMapClickListener: OnMapClickListener)

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

addOnMapLongClickListener

androidJvm

abstract fun addOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

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

addOnMoveListener

androidJvm

abstract fun addOnMoveListener(onMoveListener: OnMoveListener)

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

addOnRotateListener

androidJvm

abstract fun addOnRotateListener(onRotateListener: OnRotateListener)

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

addOnScaleListener

androidJvm

abstract fun addOnScaleListener(onScaleListener: OnScaleListener)

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

addOnShoveListener

androidJvm

abstract fun addOnShoveListener(onShoveListener: OnShoveListener)

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

addProtectedAnimationOwner

androidJvm

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

androidJvm

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

Bind the ViewPlugin with current map context.

cleanup

androidJvm

open fun cleanup()

Called when the map is destroyed.

equals

androidJvm

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

getGesturesManager

androidJvm

abstract fun getGesturesManager(): AndroidGesturesManager

Get the current configured gesture manager

getSettings

androidJvm

abstract fun getSettings(): GesturesSettings

Get current gestures configuration.

hashCode

androidJvm

open fun hashCode(): Int

initialize

androidJvm

open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider

androidJvm

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

onGenericMotionEvent

androidJvm

abstract fun onGenericMotionEvent(event: MotionEvent): Boolean

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

onSizeChanged

androidJvm

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

Invoked when MapView's width and height have changed.

onTouchEvent

androidJvm

abstract fun onTouchEvent(motionEvent: MotionEvent?): Boolean

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

removeOnFlingListener

androidJvm

abstract fun removeOnFlingListener(onFlingListener: OnFlingListener)

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

removeOnMapClickListener

androidJvm

abstract fun removeOnMapClickListener(onMapClickListener: OnMapClickListener)

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

removeOnMapLongClickListener

androidJvm

abstract fun removeOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

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

removeOnMoveListener

androidJvm

abstract fun removeOnMoveListener(listener: OnMoveListener)

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

removeOnRotateListener

androidJvm

abstract fun removeOnRotateListener(listener: OnRotateListener)

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

removeOnScaleListener

androidJvm

abstract fun removeOnScaleListener(listener: OnScaleListener)

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

removeOnShoveListener

androidJvm

abstract fun removeOnShoveListener(listener: OnShoveListener)

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

removeProtectedAnimationOwner

androidJvm

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

androidJvm

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

Set internal gesture manager

toString

androidJvm

open fun toString(): String

updateSettings

androidJvm

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

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