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

MapViewportState

class MapViewportState(initialCameraState: 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

initialCameraState

the initial camera position

Constructors

MapViewportState

fun MapViewportState(initialCameraState: CameraState = INIT_CAMERA_STATE)

Types

Companion

object Companion

Companion object of MapViewportState.

Functions

cameraForCoordinates

@UiThread

suspend fun cameraForCoordinates(coordinates: List<Point>, camera: CameraOptions = cameraOptions { }, coordinatesPadding: EdgeInsets? = null, maxZoom: Double? = null, offset: ScreenCoordinate? = null): CameraOptions

Convenience method that returns the CameraOptions object for given parameters.

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.

@UiThread

fun setCameraOptions(block: CameraOptions.Builder.() -> Unit)

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

transitionToFollowPuckState

fun transitionToFollowPuckState(followPuckViewportStateOptions: FollowPuckViewportStateOptions = FollowPuckViewportStateOptions.Builder() .build(), 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

val cameraState: CameraState?

The current CameraState of the map or null if this MapViewportState is not yet associated with a map.

mapViewportStatus

val mapViewportStatus: ViewportStatus?

The current ViewportStatus that represents the status of the viewport or null if this MapViewportState is not yet associated with a map.

mapViewportStatusChangedReason

val mapViewportStatusChangedReason: ViewportStatusChangeReason?

The reason why the ViewportStatus has been changed or null if this MapViewportState is not yet associated with a map.

styleDefaultCameraOptions

val styleDefaultCameraOptions: CameraOptions?

A utility function to get the default CameraOptions defined in the style or null if this MapViewportState is not yet associated with a map.