routoMapSDK Android/com.mapbox.maps.plugin.gestures.generated/GesturesSettings/Builder

Builder

class Builder

Composes and builds a GesturesSettings object.

This is a concrete implementation of the builder design pattern.

Constructors

Builder

fun Builder()

Functions

build

fun build(): GesturesSettings

Returns a GesturesSettings reference to the object being constructed by the builder.

setDoubleTapToZoomInEnabled

fun setDoubleTapToZoomInEnabled(doubleTapToZoomInEnabled: Boolean): GesturesSettings.Builder

Setter for doubleTapToZoomInEnabled: whether double tapping the map with one touch results in a zoom-in animation. Default value: true.

setDoubleTouchToZoomOutEnabled

fun setDoubleTouchToZoomOutEnabled(doubleTouchToZoomOutEnabled: Boolean): GesturesSettings.Builder

Setter for doubleTouchToZoomOutEnabled: whether single tapping the map with two touches results in a zoom-out animation. Default value: true.

setFocalPoint

fun setFocalPoint(focalPoint: ScreenCoordinate?): GesturesSettings.Builder

Setter for 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.

setIncreasePinchToZoomThresholdWhenRotating

fun setIncreasePinchToZoomThresholdWhenRotating(increasePinchToZoomThresholdWhenRotating: Boolean): GesturesSettings.Builder

Setter for increasePinchToZoomThresholdWhenRotating: whether pinch to zoom threshold increases when rotating. true by default. Default value: true.

setIncreaseRotateThresholdWhenPinchingToZoom

fun setIncreaseRotateThresholdWhenPinchingToZoom(increaseRotateThresholdWhenPinchingToZoom: Boolean): GesturesSettings.Builder

Setter for increaseRotateThresholdWhenPinchingToZoom: whether rotate threshold increases when pinching to zoom. true by default. Default value: true.

setPinchScrollEnabled

fun setPinchScrollEnabled(pinchScrollEnabled: Boolean): GesturesSettings.Builder

Setter for pinchScrollEnabled: whether pan is enabled for the pinch gesture. Default value: true.

setPinchToZoomDecelerationEnabled

fun setPinchToZoomDecelerationEnabled(pinchToZoomDecelerationEnabled: Boolean): GesturesSettings.Builder

Setter for pinchToZoomDecelerationEnabled: whether a deceleration animation following a pinch-to-zoom gesture is enabled. True by default. Default value: true.

setPinchToZoomEnabled

fun setPinchToZoomEnabled(pinchToZoomEnabled: Boolean): GesturesSettings.Builder

Setter for pinchToZoomEnabled: whether the pinch to zoom gesture is enabled. Default value: true.

setPitchEnabled

fun setPitchEnabled(pitchEnabled: Boolean): GesturesSettings.Builder

Setter for pitchEnabled: whether the pitch gesture is enabled. Default value: true.

setQuickZoomEnabled

fun setQuickZoomEnabled(quickZoomEnabled: Boolean): GesturesSettings.Builder

Setter for quickZoomEnabled: whether the quick zoom gesture is enabled. Default value: true.

setRotateDecelerationEnabled

fun setRotateDecelerationEnabled(rotateDecelerationEnabled: Boolean): GesturesSettings.Builder

Setter for rotateDecelerationEnabled: whether a deceleration animation following a rotate gesture is enabled. True by default. Default value: true.

setRotateEnabled

fun setRotateEnabled(rotateEnabled: Boolean): GesturesSettings.Builder

Setter for rotateEnabled: whether the rotate gesture is enabled. Default value: true.

setScrollDecelerationEnabled

fun setScrollDecelerationEnabled(scrollDecelerationEnabled: Boolean): GesturesSettings.Builder

Setter for scrollDecelerationEnabled: whether a deceleration animation following a scroll gesture is enabled. True by default. Default value: true.

setScrollEnabled

fun setScrollEnabled(scrollEnabled: Boolean): GesturesSettings.Builder

Setter for scrollEnabled: whether the single-touch scroll gesture is enabled. Default value: true.

setScrollMode

fun setScrollMode(scrollMode: ScrollMode): GesturesSettings.Builder

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

setSimultaneousRotateAndPinchToZoomEnabled

fun setSimultaneousRotateAndPinchToZoomEnabled(simultaneousRotateAndPinchToZoomEnabled: Boolean): GesturesSettings.Builder

Setter for simultaneousRotateAndPinchToZoomEnabled: whether rotation is enabled for the pinch to zoom gesture. Default value: true.

setZoomAnimationAmount

fun setZoomAnimationAmount(zoomAnimationAmount: Float): GesturesSettings.Builder

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

Properties

doubleTapToZoomInEnabled

var doubleTapToZoomInEnabled: Boolean = true

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

doubleTouchToZoomOutEnabled

var doubleTouchToZoomOutEnabled: Boolean = true

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

focalPoint

var focalPoint: ScreenCoordinate? = null

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

var increasePinchToZoomThresholdWhenRotating: Boolean = true

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

increaseRotateThresholdWhenPinchingToZoom

var increaseRotateThresholdWhenPinchingToZoom: Boolean = true

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

pinchScrollEnabled

var pinchScrollEnabled: Boolean = true

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

pinchToZoomDecelerationEnabled

var pinchToZoomDecelerationEnabled: Boolean = true

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

pinchToZoomEnabled

var pinchToZoomEnabled: Boolean = true

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

pitchEnabled

var pitchEnabled: Boolean = true

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

quickZoomEnabled

var quickZoomEnabled: Boolean = true

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

rotateDecelerationEnabled

var rotateDecelerationEnabled: Boolean = true

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

rotateEnabled

var rotateEnabled: Boolean = true

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

scrollDecelerationEnabled

var scrollDecelerationEnabled: Boolean = true

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

scrollEnabled

var scrollEnabled: Boolean = true

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

scrollMode

var scrollMode: ScrollMode

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

simultaneousRotateAndPinchToZoomEnabled

var simultaneousRotateAndPinchToZoomEnabled: Boolean = true

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

zoomAnimationAmount

var zoomAnimationAmount: Float = 1.0f

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.