GesturesSettingsInterface

interface GesturesSettingsInterface

Interface that defines the public settings interface for GesturesPlugin.

Functions

getSettings

abstract fun getSettings(): GesturesSettings

Get current gestures configuration.

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. Set this property to rotate and zoom around a fixed point instead.

increasePinchToZoomThresholdWhenRotating

abstract var increasePinchToZoomThresholdWhenRotating: Boolean

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

increaseRotateThresholdWhenPinchingToZoom

~~abstract~~ ~~var~~ ~~increaseRotateThresholdWhenPinchingToZoom~~: Boolean

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

pinchScrollEnabled

abstract var pinchScrollEnabled: Boolean

Whether pan is enabled for the pinch gesture.

pinchToZoomDecelerationEnabled

abstract var pinchToZoomDecelerationEnabled: Boolean

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

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. True by default.

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. True by default.

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. 1.0 by default. Must be positive.

Inheritors

GesturesPlugin

GesturesSettingsBase