mapbox-maps-android/com.mapbox.maps.extension.compose.gestures/GesturesState

GesturesState

@MapboxExperimental
class GesturesState(initialGesturesSettings: GesturesSettings = GesturesSettings { })

A state holder for gesture configuration and gesture event observation.

Obtain an instance through MapState.gesturesState.

Use gesturesSettings to configure which gestures are enabled, and GestureInput to observe individual gesture events in a coroutine-based, lifecycle-aware fashion.

Constructors

Link copied to clipboard
fun GesturesState(initialGesturesSettings: GesturesSettings = GesturesSettings { })

Types

Link copied to clipboard
object Companion

Public companion object of GesturesState.

Functions

Link copied to clipboard
@MapboxExperimental
suspend fun gestureInput(block: suspend GestureScope.() -> Unit)

Suspends until the coroutine is canceled, collecting each map attachment and running block with a GestureScope receiver. When the map is replaced or detaches, the current block invocation is canceled and restarted on the new map.

Link copied to clipboard
fun isGestureInProgress(): Boolean

Returns true if a gesture is currently in progress.

Link copied to clipboard
fun isUserAnimationInProgress(): Boolean

Returns true if a user-initiated animation is currently in progress.

Properties

Link copied to clipboard
var gesturesSettings: GesturesSettings

Gesture configuration that controls user touch interaction.