Mapbox Maps Android/com.mapbox.maps.plugin.gestures.generated/GesturesSettingsInterface

GesturesSettingsInterface

Interface that defines the public settings interface for GesturesPlugin.

interface GesturesSettingsInterface

Functions

equals

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

getSettings

Get current gestures configuration.

abstract fun getSettings(): GesturesSettings

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

updateSettings

Update gestures configuration, the update will be applied to the plugin automatically.

abstract fun updateSettings(block: GesturesSettings.() -> Unit)

Properties

disableRotateWhenScaling

Whether rotate is disabled when scaling. true by default.

abstract var disableRotateWhenScaling: Boolean

doubleTapToZoomEnabled

Whether double tapping the map results in a zoom gesture.

abstract var doubleTapToZoomEnabled: Boolean

flingVelocityAnimationEnabled

Whether fling velocity animations are enabled, true by default.

abstract var flingVelocityAnimationEnabled: Boolean

focalPoint

Whether a gesture executes around a fixed focal point or the center of the gesture.

abstract var focalPoint: ScreenCoordinate?

increaseRotateThresholdWhenScaling

Whether rotate threshold increases when scaling. true by default.

abstract var increaseRotateThresholdWhenScaling: Boolean

increaseScaleThresholdWhenRotating

Whether scale threshold increases when rotating. true by default.

abstract var increaseScaleThresholdWhenRotating: Boolean

panScrollMode

Whether the user is restricted in which direction the map is scrolled.

abstract var panScrollMode: PanScrollMode

pitchEnabled

Whether pitch gestures are enabled.

abstract var pitchEnabled: Boolean

pixelRatio

The pixel ratio of the device that the gestures will take in account.

abstract var pixelRatio: Float

quickZoomEnabled

Whether quick zoom gesture is enabled.

abstract var quickZoomEnabled: Boolean

rotateEnabled

Whether rotation gestures are enabled.

abstract var rotateEnabled: Boolean

rotateVelocityAnimationEnabled

Whether rotate velocity animations are enabled, true by default.

abstract var rotateVelocityAnimationEnabled: Boolean

scaleVelocityAnimationEnabled

Whether scale velocity animations are enabled, true by default.

abstract var scaleVelocityAnimationEnabled: Boolean

scrollEnabled

Whether scroll gestures are enabled.

abstract var scrollEnabled: Boolean

zoomEnabled

Whether zoom gestures are enabled.

abstract var zoomEnabled: Boolean

zoomRate

The rate at which the zoom level increases. 1.0 by default

abstract var zoomRate: Float

Inheritors

GesturesPlugin

GesturesSettingsBase