mapbox-maps-android/com.mapbox.maps.plugin.gestures.generated/GesturesSettingsBase

GesturesSettingsBase

Abstract settings class for GesturesPlugin.

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

abstract class GesturesSettingsBase : GesturesSettingsInterface

Constructors

GesturesSettingsBase

fun GesturesSettingsBase()

Functions

equals

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

getSettings

Get current gestures configuration.

open override fun getSettings(): GesturesSettings

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

updateSettings

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

open override fun updateSettings(block: GesturesSettings.() -> Unit)

Properties

doubleTapToZoomInEnabled

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

open override var doubleTapToZoomInEnabled: Boolean

doubleTouchToZoomOutEnabled

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

open override var doubleTouchToZoomOutEnabled: Boolean

focalPoint

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 focalPoint: ScreenCoordinate?

increasePinchToZoomThresholdWhenRotating

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

open override var increasePinchToZoomThresholdWhenRotating: Boolean

increaseRotateThresholdWhenPinchingToZoom

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

open override var increaseRotateThresholdWhenPinchingToZoom: Boolean

pinchToZoomDecelerationEnabled

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

open override var pinchToZoomDecelerationEnabled: Boolean

pinchToZoomEnabled

Whether the pinch to zoom gesture is enabled.

open override var pinchToZoomEnabled: Boolean

pitchEnabled

Whether the pitch gesture is enabled.

open override var pitchEnabled: Boolean

quickZoomEnabled

Whether the quick zoom gesture is enabled.

open override var quickZoomEnabled: Boolean

rotateDecelerationEnabled

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

open override var rotateDecelerationEnabled: Boolean

rotateEnabled

Whether the rotate gesture is enabled.

open override var rotateEnabled: Boolean

scrollDecelerationEnabled

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

open override var scrollDecelerationEnabled: Boolean

scrollEnabled

Whether the single-touch scroll gesture is enabled.

open override var scrollEnabled: Boolean

scrollMode

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

open override var scrollMode: ScrollMode

zoomAnimationAmount

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.

open override var zoomAnimationAmount: Float

Inheritors

GesturesPluginImpl