GesturesSettingsBase

abstract class GesturesSettingsBase : GesturesSettingsInterface

Abstract settings class for GesturesPlugin.

This abstract class exposes all the required public APIs to configure the GesturesPlugin.

Constructors

GesturesSettingsBase
Link copied to clipboard
fun GesturesSettingsBase()

Functions

getSettings
Link copied to clipboard
open override fun getSettings(): GesturesSettings

Get current gestures configuration.

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

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

Properties

doubleTapToZoomInEnabled
Link copied to clipboard
open override var doubleTapToZoomInEnabled: Boolean

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

doubleTouchToZoomOutEnabled
Link copied to clipboard
open override var doubleTouchToZoomOutEnabled: Boolean

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

focalPoint
Link copied to clipboard
open override 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.

open override var increasePinchToZoomThresholdWhenRotating: Boolean

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

open override var increaseRotateThresholdWhenPinchingToZoom: Boolean

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

pinchScrollEnabled
Link copied to clipboard
open override var pinchScrollEnabled: Boolean

Whether pan is enabled for the pinch gesture.

pinchToZoomDecelerationEnabled
Link copied to clipboard
open override var pinchToZoomDecelerationEnabled: Boolean

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

pinchToZoomEnabled
Link copied to clipboard
open override var pinchToZoomEnabled: Boolean

Whether the pinch to zoom gesture is enabled.

pitchEnabled
Link copied to clipboard
open override var pitchEnabled: Boolean

Whether the pitch gesture is enabled.

quickZoomEnabled
Link copied to clipboard
open override var quickZoomEnabled: Boolean

Whether the quick zoom gesture is enabled.

rotateDecelerationEnabled
Link copied to clipboard
open override var rotateDecelerationEnabled: Boolean

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

rotateEnabled
Link copied to clipboard
open override var rotateEnabled: Boolean

Whether the rotate gesture is enabled.

scrollDecelerationEnabled
Link copied to clipboard
open override var scrollDecelerationEnabled: Boolean

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

scrollEnabled
Link copied to clipboard
open override var scrollEnabled: Boolean

Whether the single-touch scroll gesture is enabled.

scrollMode
Link copied to clipboard
open override var scrollMode: ScrollMode

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

simultaneousRotateAndPinchToZoomEnabled
Link copied to clipboard
open override var simultaneousRotateAndPinchToZoomEnabled: Boolean

Whether rotation is enabled for the pinch to zoom gesture.

zoomAnimationAmount
Link copied to clipboard
open override 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