GesturesPlugin

Define the interfaces for the Layer plugin.

Functions

addOnFlingListener
Link copied to clipboard
abstract fun addOnFlingListener(onFlingListener: OnFlingListener)

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

addOnMapClickListener
Link copied to clipboard
abstract fun addOnMapClickListener(onMapClickListener: OnMapClickListener)

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

addOnMapLongClickListener
Link copied to clipboard
abstract fun addOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

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

addOnMoveListener
Link copied to clipboard
abstract fun addOnMoveListener(onMoveListener: OnMoveListener)

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

addOnRotateListener
Link copied to clipboard
abstract fun addOnRotateListener(onRotateListener: OnRotateListener)

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

addOnScaleListener
Link copied to clipboard
abstract fun addOnScaleListener(onScaleListener: OnScaleListener)

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

addOnShoveListener
Link copied to clipboard
abstract fun addOnShoveListener(onShoveListener: OnShoveListener)

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

addProtectedAnimationOwner
Link copied to clipboard
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. When specified, you are responsible for listening to gesture interactions and canceling the specified owners' animations to avoid competing with gestures.

bind
Link copied to clipboard
abstract fun bind(context: Context, attrs: AttributeSet?, pixelRatio: Float)

Bind the ViewPlugin with current map context. This will create a View that will be added to the MapView.

cleanup
Link copied to clipboard
open fun cleanup()

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

getGesturesManager
Link copied to clipboard
abstract fun getGesturesManager(): AndroidGesturesManager

Get the current configured gesture manager

getSettings
Link copied to clipboard
abstract fun getSettings(): GesturesSettings

Get current gestures configuration.

initialize
Link copied to clipboard
open fun initialize()

Called when the plugin is first added to the map.

onDelegateProvider
Link copied to clipboard
open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

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

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

onSizeChanged
Link copied to clipboard
open fun onSizeChanged(width: Int, height: Int)

Invoked when MapView's width and height have changed.

onTouchEvent
Link copied to clipboard
abstract fun onTouchEvent(motionEvent: MotionEvent?): Boolean

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

removeOnFlingListener
Link copied to clipboard
abstract fun removeOnFlingListener(onFlingListener: OnFlingListener)

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

removeOnMapClickListener
Link copied to clipboard
abstract fun removeOnMapClickListener(onMapClickListener: OnMapClickListener)

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

removeOnMapLongClickListener
Link copied to clipboard
abstract fun removeOnMapLongClickListener(onMapLongClickListener: OnMapLongClickListener)

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

removeOnMoveListener
Link copied to clipboard
abstract fun removeOnMoveListener(listener: OnMoveListener)

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

removeOnRotateListener
Link copied to clipboard
abstract fun removeOnRotateListener(listener: OnRotateListener)

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

removeOnScaleListener
Link copied to clipboard
abstract fun removeOnScaleListener(listener: OnScaleListener)

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

removeOnShoveListener
Link copied to clipboard
abstract fun removeOnShoveListener(listener: OnShoveListener)

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

removeProtectedAnimationOwner
Link copied to clipboard
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. When specified, you are responsible for listening to gesture interactions and canceling the specified owners' animations to avoid competing with gestures.

setGesturesManager
Link copied to clipboard
abstract fun setGesturesManager(internalGesturesManager: AndroidGesturesManager, attachDefaultListeners: Boolean, setDefaultMutuallyExclusives: Boolean)

Set internal gesture manager

updateSettings
Link copied to clipboard
abstract fun updateSettings(block: GesturesSettings.() -> Unit)

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

Properties

doubleTapToZoomInEnabled
Link copied to clipboard
abstract var doubleTapToZoomInEnabled: Boolean

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

doubleTouchToZoomOutEnabled
Link copied to clipboard
abstract var doubleTouchToZoomOutEnabled: Boolean

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

focalPoint
Link copied to clipboard
abstract var focalPoint: ScreenCoordinate?

By default, gestures rotate and zoom around the center of the gesture. Set this property to rotate and zoom around a fixed point instead.

abstract var increasePinchToZoomThresholdWhenRotating: Boolean

Whether pinch to zoom threshold increases when rotating. true by default.

abstract var increaseRotateThresholdWhenPinchingToZoom: Boolean

Whether rotate threshold increases when pinching to zoom. true by default.

pinchScrollEnabled
Link copied to clipboard
abstract var pinchScrollEnabled: Boolean

Whether pan is enabled for the pinch gesture.

pinchToZoomDecelerationEnabled
Link copied to clipboard
abstract var pinchToZoomDecelerationEnabled: Boolean

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

pinchToZoomEnabled
Link copied to clipboard
abstract var pinchToZoomEnabled: Boolean

Whether the pinch to zoom gesture is enabled.

pitchEnabled
Link copied to clipboard
abstract var pitchEnabled: Boolean

Whether the pitch gesture is enabled.

quickZoomEnabled
Link copied to clipboard
abstract var quickZoomEnabled: Boolean

Whether the quick zoom gesture is enabled.

rotateDecelerationEnabled
Link copied to clipboard
abstract var rotateDecelerationEnabled: Boolean

Whether a deceleration animation following a rotate gesture is enabled. True by default.

rotateEnabled
Link copied to clipboard
abstract var rotateEnabled: Boolean

Whether the rotate gesture is enabled.

scrollDecelerationEnabled
Link copied to clipboard
abstract var scrollDecelerationEnabled: Boolean

Whether a deceleration animation following a scroll gesture is enabled. True by default.

scrollEnabled
Link copied to clipboard
abstract var scrollEnabled: Boolean

Whether the single-touch scroll gesture is enabled.

scrollMode
Link copied to clipboard
abstract var scrollMode: ScrollMode

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

simultaneousRotateAndPinchToZoomEnabled
Link copied to clipboard
abstract var simultaneousRotateAndPinchToZoomEnabled: Boolean

Whether rotation is enabled for the pinch to zoom gesture.

zoomAnimationAmount
Link copied to clipboard
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. 1.0 by default. Must be positive.

Inheritors

GesturesPluginImpl
Link copied to clipboard