MapTransformDelegate

Definition of a map transform delegate.

interface MapTransformDelegate

Functions

dragEnd
Link copied to clipboard

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
Link copied to clipboard

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
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getBounds
Link copied to clipboard

Get the map bounds options.

abstract fun getBounds(): BoundOptions
getCameraOptions
Link copied to clipboard

Get the current camera options given an optional padding.

abstract fun getCameraOptions(edgeInsets: EdgeInsets?): CameraOptions
getDragCameraOptions
Link copied to clipboard

Calculates target point where camera should move after drag. The method should be called after dragStart and before dragEnd.

abstract fun getDragCameraOptions(fromPoint: ScreenCoordinate, toPoint: ScreenCoordinate): CameraOptions
getMapOptions
Link copied to clipboard

Get map options.

abstract fun getMapOptions(): MapOptions
getMaxZoom
Link copied to clipboard

Get maximum zoom.

abstract fun getMaxZoom(): Double
getMinZoom
Link copied to clipboard

Get minimum zoom.

abstract fun getMinZoom(): Double
getScale
Link copied to clipboard

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

abstract fun getScale(): Double
getSize
Link copied to clipboard

Gets the size of the map.

abstract fun getSize(): Size
hashCode
Link copied to clipboard
open override fun hashCode(): Int
isGestureInProgress
Link copied to clipboard

Returns if a gesture is in progress.

abstract fun isGestureInProgress(): Boolean
isUserAnimationInProgress
Link copied to clipboard

Returns if user animation is currently in progress.

abstract fun isUserAnimationInProgress(): Boolean
setBounds
Link copied to clipboard

Set the map bounds.

abstract fun setBounds(boundOptions: BoundOptions)
setCamera
Link copied to clipboard

Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition. The map will retain its current values for any details not passed via the camera options argument.

abstract fun setCamera(cameraOptions: CameraOptions)
setConstrainMode
Link copied to clipboard

Set the map constrain mode

abstract fun setConstrainMode(constrainMode: ConstrainMode)
setGestureInProgress
Link copied to clipboard

Notify map about gesture being in progress.

abstract fun setGestureInProgress(inProgress: Boolean)
setNorthOrientation
Link copied to clipboard

Set the map north orientation

abstract fun setNorthOrientation(northOrientation: NorthOrientation)
setUserAnimationInProgress
Link copied to clipboard

Tells the map rendering engine that the animation is currently performed by the user (e.g. with a setCamera() 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
Link copied to clipboard

Set the map viewport mode

abstract fun setViewportMode(viewportMode: ViewportMode)
toString
Link copied to clipboard
open override fun toString(): String

Inheritors

MapboxMap
Link copied to clipboard