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

GesturesSettings

data class GesturesSettings @JvmOverloads() constructor(rotateEnabled: Boolean, pinchToZoomEnabled: Boolean, scrollEnabled: Boolean, simultaneousRotateAndPinchToZoomEnabled: 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)
Content copied to clipboard

Gesture configuration allows to control the user touch interaction.

Constructors

GesturesSettings
Link copied to clipboard
@JvmOverloads()
fun GesturesSettings(rotateEnabled: Boolean = true, pinchToZoomEnabled: Boolean = true, scrollEnabled: Boolean = true, simultaneousRotateAndPinchToZoomEnabled: Boolean = true, pitchEnabled: Boolean = true, scrollMode: ScrollMode = ScrollMode.HORIZONTAL_AND_VERTICAL, doubleTapToZoomInEnabled: Boolean = true, doubleTouchToZoomOutEnabled: Boolean = true, quickZoomEnabled: Boolean = true, focalPoint: ScreenCoordinate? = null, pinchToZoomDecelerationEnabled: Boolean = true, rotateDecelerationEnabled: Boolean = true, scrollDecelerationEnabled: Boolean = true, increaseRotateThresholdWhenPinchingToZoom: Boolean = true, increasePinchToZoomThresholdWhenRotating: Boolean = true, zoomAnimationAmount: Float = 1f)
Content copied to clipboard

Functions

component1
Link copied to clipboard
operator fun component1(): Boolean
Content copied to clipboard
component10
Link copied to clipboard
operator fun component10(): ScreenCoordinate?
Content copied to clipboard
component11
Link copied to clipboard
operator fun component11(): Boolean
Content copied to clipboard
component12
Link copied to clipboard
operator fun component12(): Boolean
Content copied to clipboard
component13
Link copied to clipboard
operator fun component13(): Boolean
Content copied to clipboard
component14
Link copied to clipboard
operator fun component14(): Boolean
Content copied to clipboard
component15
Link copied to clipboard
operator fun component15(): Boolean
Content copied to clipboard
component16
Link copied to clipboard
operator fun component16(): Float
Content copied to clipboard
component2
Link copied to clipboard
operator fun component2(): Boolean
Content copied to clipboard
component3
Link copied to clipboard
operator fun component3(): Boolean
Content copied to clipboard
component4
Link copied to clipboard
operator fun component4(): Boolean
Content copied to clipboard
component5
Link copied to clipboard
operator fun component5(): Boolean
Content copied to clipboard
component6
Link copied to clipboard
operator fun component6(): ScrollMode
Content copied to clipboard
component7
Link copied to clipboard
operator fun component7(): Boolean
Content copied to clipboard
component8
Link copied to clipboard
operator fun component8(): Boolean
Content copied to clipboard
component9
Link copied to clipboard
operator fun component9(): Boolean
Content copied to clipboard
copy
Link copied to clipboard
fun copy(rotateEnabled: Boolean = true, pinchToZoomEnabled: Boolean = true, scrollEnabled: Boolean = true, simultaneousRotateAndPinchToZoomEnabled: Boolean = true, pitchEnabled: Boolean = true, scrollMode: ScrollMode = ScrollMode.HORIZONTAL_AND_VERTICAL, doubleTapToZoomInEnabled: Boolean = true, doubleTouchToZoomOutEnabled: Boolean = true, quickZoomEnabled: Boolean = true, focalPoint: ScreenCoordinate? = null, pinchToZoomDecelerationEnabled: Boolean = true, rotateDecelerationEnabled: Boolean = true, scrollDecelerationEnabled: Boolean = true, increaseRotateThresholdWhenPinchingToZoom: Boolean = true, increasePinchToZoomThresholdWhenRotating: Boolean = true, zoomAnimationAmount: Float = 1f): GesturesSettings
Content copied to clipboard
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Content copied to clipboard
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Content copied to clipboard
toString
Link copied to clipboard
open override fun toString(): String
Content copied to clipboard

Properties

doubleTapToZoomInEnabled
Link copied to clipboard
var doubleTapToZoomInEnabled: Boolean = true
Content copied to clipboard
Whether double tapping the map with one touch results in a zoom-in animation.
doubleTouchToZoomOutEnabled
Link copied to clipboard
var doubleTouchToZoomOutEnabled: Boolean = true
Content copied to clipboard
Whether single tapping the map with two touches results in a zoom-out animation.
focalPoint
Link copied to clipboard
var focalPoint: ScreenCoordinate? = null
Content copied to clipboard
By default, gestures rotate and zoom around the center of the gesture.
var increasePinchToZoomThresholdWhenRotating: Boolean = true
Content copied to clipboard
Whether pinch to zoom threshold increases when rotating.
var increaseRotateThresholdWhenPinchingToZoom: Boolean = true
Content copied to clipboard
Whether rotate threshold increases when pinching to zoom.
pinchToZoomDecelerationEnabled
Link copied to clipboard
var pinchToZoomDecelerationEnabled: Boolean = true
Content copied to clipboard
Whether a deceleration animation following a pinch-to-zoom gesture is enabled.
pinchToZoomEnabled
Link copied to clipboard
var pinchToZoomEnabled: Boolean = true
Content copied to clipboard
Whether the pinch to zoom gesture is enabled.
pitchEnabled
Link copied to clipboard
var pitchEnabled: Boolean = true
Content copied to clipboard
Whether the pitch gesture is enabled.
quickZoomEnabled
Link copied to clipboard
var quickZoomEnabled: Boolean = true
Content copied to clipboard
Whether the quick zoom gesture is enabled.
rotateDecelerationEnabled
Link copied to clipboard
var rotateDecelerationEnabled: Boolean = true
Content copied to clipboard
Whether a deceleration animation following a rotate gesture is enabled.
rotateEnabled
Link copied to clipboard
var rotateEnabled: Boolean = true
Content copied to clipboard
Whether the rotate gesture is enabled.
scrollDecelerationEnabled
Link copied to clipboard
var scrollDecelerationEnabled: Boolean = true
Content copied to clipboard
Whether a deceleration animation following a scroll gesture is enabled.
scrollEnabled
Link copied to clipboard
var scrollEnabled: Boolean = true
Content copied to clipboard
Whether the single-touch scroll gesture is enabled.
scrollMode
Link copied to clipboard
var scrollMode: ScrollMode
Content copied to clipboard
Configures the directions in which the map is allowed to move during a scroll gesture.
simultaneousRotateAndPinchToZoomEnabled
Link copied to clipboard
var simultaneousRotateAndPinchToZoomEnabled: Boolean = true
Content copied to clipboard
Whether rotation is enabled for the pinch to zoom gesture.
zoomAnimationAmount
Link copied to clipboard
var zoomAnimationAmount: Float = 1f
Content 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.

Extensions

isScrollHorizontallyLimited
Link copied to clipboard
fun GesturesSettings.isScrollHorizontallyLimited(): Boolean
Content copied to clipboard
Returns if the scroll is horizontally limited, In other words, the scroll mode is set to vertical.
isScrollVerticallyLimited
Link copied to clipboard
fun GesturesSettings.isScrollVerticallyLimited(): Boolean
Content copied to clipboard
Returns if the scroll is vertically limited, In other words, the scroll mode is set to horizontal.
© 2020 CopyrightSponsored and developed by dokka