Mapbox Maps Android/com.mapbox.maps.plugin.delegates/MapTransformDelegate

MapTransformDelegate

Definition of a map transform delegate.

Functions

drag

Drags the map from one screen point to another. The method should be called after dragStart and before dragEnd.

abstract fun drag(fromPoint: ScreenCoordinate, toPoint: ScreenCoordinate, animation: AnimationOptions?)

dragEnd

Ends the ongoing drag gesture. This function should be called always after the user has ended a drag gesture initiated by dragStart.

abstract fun dragEnd()

dragStart

Prepares the drag gesture to use the provided screen coordinate as a pivot point. This function should be called each time when user starts a dragging action (e.g. by clicking on the map). The following dragging will be relative to the pivot.

abstract fun dragStart(point: ScreenCoordinate)

equals

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

getBounds

Get the map bounds options.

abstract fun getBounds(): BoundOptions

getCameraOptions

Get the current camera options given an optional padding.

abstract fun getCameraOptions(edgeInsets: EdgeInsets?): CameraOptions

getMapOptions

Get map options.

abstract fun getMapOptions(): MapOptions

getMaxZoom

Get maximum zoom.

abstract fun getMaxZoom(): Double

getMinZoom

Get minimum zoom.

abstract fun getMinZoom(): Double

getScale

The current zoom factor applied on the map meaning 2 ^ Current zoom

abstract fun getScale(): Double

getSize

Gets the size of the map.

abstract fun getSize(): Size

hashCode

open override fun hashCode(): Int

isGestureInProgress

Returns if a gesture is in progress.

abstract fun isGestureInProgress(): Boolean

isUserAnimationInProgress

Returns if user animation is currently in progress.

abstract fun isUserAnimationInProgress(): Boolean

jumpTo

Set the map camera to a given camera options.

abstract fun jumpTo(cameraOptions: CameraOptions)

setBounds

Set the map bounds.

abstract fun setBounds(boundOptions: BoundOptions)

setConstrainMode

Set the map constrain mode

abstract fun setConstrainMode(constrainMode: ConstrainMode)

setGestureInProgress

Notify map about gesture being in progress.

abstract fun setGestureInProgress(inProgress: Boolean)

setNorthOrientation

Set the map north orientation

abstract fun setNorthOrientation(northOrientation: NorthOrientation)

setUserAnimationInProgress

Tells the map rendering engine that the animation is currently performed by the user (e.g. with a jumpTo() calls series). It adjusts the engine for the animation use case. In particular, it brings more stability to symbol placement and rendering.

abstract fun setUserAnimationInProgress(inProgress: Boolean)

setViewportMode

Set the map viewport mode

abstract fun setViewportMode(viewportMode: ViewportMode)

terrainEnabled

Is terrain enabled for loaded style of the map.

abstract fun terrainEnabled(): Boolean

toString

open override fun toString(): String

Inheritors

MapboxMap

Extensions

easeTo

Extension easeTo() for MapTransformDelegate Ease the map camera to a given camera options and animation options.

fun MapTransformDelegate.easeTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?): Unit?

flyTo

Extension flyTo() function for MapTransformDelegate Fly the map camera to a given camera options.

fun MapTransformDelegate.flyTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?): Unit?

moveBy

Extension moveBy() function for MapTransformDelegate Move the map by a given screen coordinate with optional animation.

fun MapTransformDelegate.moveBy(screenCoordinate: ScreenCoordinate, animationOptions: MapAnimationOptions?): Unit?

pitchBy

Extension pitchBy() function for MapTransformDelegate Pitch the map by with optional animation.

fun MapTransformDelegate.pitchBy(pitch: Double, animationOptions: MapAnimationOptions?): Unit?

rotateBy

Extension rotateBy() function for MapTransformDelegate Rotate the map by with optional animation.

fun MapTransformDelegate.rotateBy(first: ScreenCoordinate, second: ScreenCoordinate, animationOptions: MapAnimationOptions?): Unit?

scaleBy

Extension scaleBy() function for MapTransformDelegate Scale the map by with optional animation.

fun MapTransformDelegate.scaleBy(amount: Double, screenCoordinate: ScreenCoordinate?, animationOptions: MapAnimationOptions?): Unit?