mapbox-maps-android/com.mapbox.maps.extension.compose.animation.viewport/MapViewportState

MapViewportState

class MapViewportState(cameraState: CameraState = INIT_CAMERA_STATE)

A state object that can be hoisted to control and observe the map's camera state. A MapViewportState may only be used by a single MapboxMap composable at a time as it reflects instance state for a single view of a map.

Parameters

cameraState

the initial camera position

Constructors

MapViewportState

fun MapViewportState(cameraState: CameraState = INIT_CAMERA_STATE)

Types

Companion

object Companion

Companion object of MapViewportState.

Functions

easeTo

fun easeTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions? = null, completionListener: CompletionListener? = null)

Ease the map camera to a given camera options.

flyTo

fun flyTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions? = null, completionListener: CompletionListener? = null)

Fly the map camera to a given camera options.

idle

fun idle()

Sets ViewportPlugin.status to ViewportStatus.Idle synchronously.

setCameraOptions

@UiThread

fun setCameraOptions(cameraOptions: CameraOptions)

Move the camera instantaneously as specified by cameraOptions. Any camera animation in progress will be cancelled.

transitionToFollowPuckState

fun transitionToFollowPuckState(followPuckViewportStateOptions: FollowPuckViewportStateOptions, defaultTransitionOptions: DefaultViewportTransitionOptions = DefaultViewportTransitionOptions.Builder() .build(), completionListener: CompletionListener? = null)

Transition to a new FollowPuckViewportState.

transitionToOverviewState

fun transitionToOverviewState(overviewViewportStateOptions: OverviewViewportStateOptions, defaultTransitionOptions: DefaultViewportTransitionOptions = DefaultViewportTransitionOptions.Builder() .build(), completionListener: CompletionListener? = null)

Transition to a new OverviewViewportState.

Properties

cameraState

var cameraState: CameraState

The current CameraState of the map.

mapViewportStatus

var mapViewportStatus: ViewportStatus

The current ViewportStatus that represents the status of the viewport.

mapViewportStatusChangedReason

var mapViewportStatusChangedReason: ViewportStatusChangeReason

The reason why the ViewportStatus has been changed.

styleDefaultCameraOptions

val styleDefaultCameraOptions: CameraOptions?

A utility function to get the default CameraOptions defined in the style.