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

GesturesSettings

class GesturesSettings : Parcelable

Gesture configuration allows to control the user touch interaction.

Types

Composes and builds a GesturesSettings object.

Functions

describeContents

abstract fun describeContents(): Int

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

Overloaded equals function.

open override fun hashCode(): Int

Overloaded hashCode function based on all class properties.

fun toBuilder(): GesturesSettings.Builder

Convert to Builder allowing to change class properties.

open override fun toString(): String

Overloaded toString function.

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

doubleTapToZoomInEnabled

val doubleTapToZoomInEnabled: Boolean

Whether double tapping the map with one touch results in a zoom-in animation. Default value: true.

doubleTouchToZoomOutEnabled

val doubleTouchToZoomOutEnabled: Boolean

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

val 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

val increasePinchToZoomThresholdWhenRotating: Boolean

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

increaseRotateThresholdWhenPinchingToZoom

val increaseRotateThresholdWhenPinchingToZoom: Boolean

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

pinchScrollEnabled

val pinchScrollEnabled: Boolean

Whether pan is enabled for the pinch gesture. Default value: true.

pinchToZoomDecelerationEnabled

val pinchToZoomDecelerationEnabled: Boolean

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

pinchToZoomEnabled

val pinchToZoomEnabled: Boolean

Whether the pinch to zoom gesture is enabled. Default value: true.

val pitchEnabled: Boolean

Whether the pitch gesture is enabled. Default value: true.

quickZoomEnabled

val quickZoomEnabled: Boolean

Whether the quick zoom gesture is enabled. Default value: true.

rotateDecelerationEnabled

val rotateDecelerationEnabled: Boolean

Whether a deceleration animation following a rotate gesture is enabled. True by default. Default value: true.

val rotateEnabled: Boolean

Whether the rotate gesture is enabled. Default value: true.

scrollDecelerationEnabled

val scrollDecelerationEnabled: Boolean

Whether a deceleration animation following a scroll gesture is enabled. True by default. Default value: true.

val scrollEnabled: Boolean

Whether the single-touch scroll gesture is enabled. Default value: true.

val scrollMode: ScrollMode

Configures the directions in which the map is allowed to move during a scroll gesture. Default value: "horizontal-and-vertical".

simultaneousRotateAndPinchToZoomEnabled

val simultaneousRotateAndPinchToZoomEnabled: Boolean

Whether rotation is enabled for the pinch to zoom gesture. Default value: true.

zoomAnimationAmount

val 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. Default value: 1.

Extensions

isScrollHorizontallyLimited

fun GesturesSettings.isScrollHorizontallyLimited(): Boolean

Returns if the scroll is horizontally limited, In other words, the scroll mode is set to vertical.

isScrollVerticallyLimited

fun GesturesSettings.isScrollVerticallyLimited(): Boolean

Returns if the scroll is vertically limited, In other words, the scroll mode is set to horizontal.