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

GesturesSettings

Gesture configuration allows to control the user touch interaction.

data class GesturesSettings @JvmOverloads() constructor(rotateEnabled: Boolean, pinchToZoomEnabled: Boolean, scrollEnabled: Boolean, pitchEnabled: Boolean, scrollMode: ScrollMode, doubleTapToZoomInEnabled: Boolean, doubleTouchToZoomOutEnabled: Boolean, quickZoomEnabled: Boolean, focalPoint: ScreenCoordinate?, pinchToZoomDecelerationEnabled: Boolean, rotateDecelerationEnabled: Boolean, scrollDecelerationEnabled: Boolean, increaseRotateThresholdWhenPinchingToZoom: Boolean, increasePinchToZoomThresholdWhenRotating: Boolean, zoomAnimationAmount: Float)

Constructors

GesturesSettings

@JvmOverloads()

fun GesturesSettings(rotateEnabled: Boolean, pinchToZoomEnabled: Boolean, scrollEnabled: Boolean, pitchEnabled: Boolean, scrollMode: ScrollMode, doubleTapToZoomInEnabled: Boolean, doubleTouchToZoomOutEnabled: Boolean, quickZoomEnabled: Boolean, focalPoint: ScreenCoordinate?, pinchToZoomDecelerationEnabled: Boolean, rotateDecelerationEnabled: Boolean, scrollDecelerationEnabled: Boolean, increaseRotateThresholdWhenPinchingToZoom: Boolean, increasePinchToZoomThresholdWhenRotating: Boolean, zoomAnimationAmount: Float)

Functions

component1

operator fun component1(): Boolean

component10

operator fun component10(): Boolean

component11

operator fun component11(): Boolean

component12

operator fun component12(): Boolean

component13

operator fun component13(): Boolean

component14

operator fun component14(): Boolean

component15

operator fun component15(): Float

component2

operator fun component2(): Boolean

component3

operator fun component3(): Boolean

component4

operator fun component4(): Boolean

component5

operator fun component5(): ScrollMode

component6

operator fun component6(): Boolean

component7

operator fun component7(): Boolean

component8

operator fun component8(): Boolean

component9

operator fun component9(): ScreenCoordinate?

copy

fun copy(rotateEnabled: Boolean, pinchToZoomEnabled: Boolean, scrollEnabled: Boolean, pitchEnabled: Boolean, scrollMode: ScrollMode, doubleTapToZoomInEnabled: Boolean, doubleTouchToZoomOutEnabled: Boolean, quickZoomEnabled: Boolean, focalPoint: ScreenCoordinate?, pinchToZoomDecelerationEnabled: Boolean, rotateDecelerationEnabled: Boolean, scrollDecelerationEnabled: Boolean, increaseRotateThresholdWhenPinchingToZoom: Boolean, increasePinchToZoomThresholdWhenRotating: Boolean, zoomAnimationAmount: Float): GesturesSettings

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

doubleTapToZoomInEnabled

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

var doubleTapToZoomInEnabled: Boolean

doubleTouchToZoomOutEnabled

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

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.

var focalPoint: ScreenCoordinate?

increasePinchToZoomThresholdWhenRotating

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

var increasePinchToZoomThresholdWhenRotating: Boolean

increaseRotateThresholdWhenPinchingToZoom

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

var increaseRotateThresholdWhenPinchingToZoom: Boolean

pinchToZoomDecelerationEnabled

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

var pinchToZoomDecelerationEnabled: Boolean

pinchToZoomEnabled

Whether the pinch to zoom gesture is enabled.

var pinchToZoomEnabled: Boolean

pitchEnabled

Whether the pitch gesture is enabled.

var pitchEnabled: Boolean

quickZoomEnabled

Whether the quick zoom gesture is enabled.

var quickZoomEnabled: Boolean

rotateDecelerationEnabled

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

var rotateDecelerationEnabled: Boolean

rotateEnabled

Whether the rotate gesture is enabled.

var rotateEnabled: Boolean

scrollDecelerationEnabled

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

var scrollDecelerationEnabled: Boolean

scrollEnabled

Whether the single-touch scroll gesture is enabled.

var scrollEnabled: Boolean

scrollMode

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

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.

var zoomAnimationAmount: Float

Extensions

isScrollHorizontallyLimited

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

fun GesturesSettings.isScrollHorizontallyLimited(): Boolean

isScrollVerticallyLimited

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

fun GesturesSettings.isScrollVerticallyLimited(): Boolean