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
Link copied to clipboard
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
Link copied to clipboard
operator fun component1(): Boolean
component10
Link copied to clipboard
operator fun component10(): Boolean
component11
Link copied to clipboard
operator fun component11(): Boolean
component12
Link copied to clipboard
operator fun component12(): Boolean
component13
Link copied to clipboard
operator fun component13(): Boolean
component14
Link copied to clipboard
operator fun component14(): Boolean
component15
Link copied to clipboard
operator fun component15(): Float
component2
Link copied to clipboard
operator fun component2(): Boolean
component3
Link copied to clipboard
operator fun component3(): Boolean
component4
Link copied to clipboard
operator fun component4(): Boolean
component5
Link copied to clipboard
operator fun component5(): ScrollMode
component6
Link copied to clipboard
operator fun component6(): Boolean
component7
Link copied to clipboard
operator fun component7(): Boolean
component8
Link copied to clipboard
operator fun component8(): Boolean
component9
Link copied to clipboard
operator fun component9(): ScreenCoordinate?
copy
Link copied to clipboard
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
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Properties

doubleTapToZoomInEnabled
Link copied to clipboard

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

var doubleTapToZoomInEnabled: Boolean
doubleTouchToZoomOutEnabled
Link copied to clipboard

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

var doubleTouchToZoomOutEnabled: Boolean
focalPoint
Link copied to clipboard

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?

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

var increasePinchToZoomThresholdWhenRotating: Boolean

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

var increaseRotateThresholdWhenPinchingToZoom: Boolean
pinchToZoomDecelerationEnabled
Link copied to clipboard

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

var pinchToZoomDecelerationEnabled: Boolean
pinchToZoomEnabled
Link copied to clipboard

Whether the pinch to zoom gesture is enabled.

var pinchToZoomEnabled: Boolean
pitchEnabled
Link copied to clipboard

Whether the pitch gesture is enabled.

var pitchEnabled: Boolean
quickZoomEnabled
Link copied to clipboard

Whether the quick zoom gesture is enabled.

var quickZoomEnabled: Boolean
rotateDecelerationEnabled
Link copied to clipboard

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

var rotateDecelerationEnabled: Boolean
rotateEnabled
Link copied to clipboard

Whether the rotate gesture is enabled.

var rotateEnabled: Boolean
scrollDecelerationEnabled
Link copied to clipboard

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

var scrollDecelerationEnabled: Boolean
scrollEnabled
Link copied to clipboard

Whether the single-touch scroll gesture is enabled.

var scrollEnabled: Boolean
scrollMode
Link copied to clipboard

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

var scrollMode: ScrollMode
zoomAnimationAmount
Link copied to clipboard

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

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

fun GesturesSettings.isScrollHorizontallyLimited(): Boolean
isScrollVerticallyLimited
Link copied to clipboard

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

fun GesturesSettings.isScrollVerticallyLimited(): Boolean