maplibre-compose

0.11.1

maplibre-compose/org.maplibre.compose.camera/CameraState

CameraState

class CameraState(firstPosition: CameraPosition)(source)

Use this class to access information about the map in relation to the camera.

Constructors

constructor(firstPosition: CameraPosition)

Properties

val isCameraMoving: Boolean

whether the camera is currently moving

metersPerDpAtTarget

val metersPerDpAtTarget: Double

meters per dp at the target position. Zero when the map is not initialized yet.

val moveReason: CameraMoveReason

reason why the camera moved, last time it moved

var position: CameraPosition

how the camera is oriented towards the map

val projection: CameraProjection?

null until the CameraState has been attached to a map

Functions

suspend fun animateTo(finalPosition: CameraPosition, duration: Duration = 300.milliseconds)

Animates the camera towards the finalPosition in duration time.

suspend fun animateTo(boundingBox: BoundingBox, bearing: Double = 0.0, tilt: Double = 0.0, padding: PaddingValues = PaddingValues(0.dp), duration: Duration = 300.milliseconds)

Animates the camera towards the specified boundingBox in the given duration time with the specified bearing, tilt, and padding.

awaitProjection

suspend fun awaitProjection(): CameraProjection

Suspends until the CameraState has been attached to the map.