Mapbox Maps Android/com.mapbox.maps.plugin.animation/CameraAnimationsPlugin

CameraAnimationsPlugin

Interface to interact with Camera Animations plugin

interface CameraAnimationsPlugin : MapPlugin

Functions

addCameraAnchorChangeListener

Add camera anchor change listener

abstract fun addCameraAnchorChangeListener(listener: CameraAnimatorChangeListener<ScreenCoordinate>)

addCameraAnimationsLifecycleListener

Add given CameraAnimationsLifecycleListener for capturing all events about animators lifecycle.

abstract fun addCameraAnimationsLifecycleListener(listener: CameraAnimationsLifecycleListener)

addCameraBearingChangeListener

Add camera bearing change listener

abstract fun addCameraBearingChangeListener(listener: CameraAnimatorChangeListener<Double>)

addCameraCenterChangeListener

Add camera center change listener

abstract fun addCameraCenterChangeListener(listener: CameraAnimatorChangeListener<Point>)

addCameraPaddingChangeListener

Add camera padding change listener

abstract fun addCameraPaddingChangeListener(listener: CameraAnimatorChangeListener<EdgeInsets>)

addCameraPitchChangeListener

Add camera pitch change listener

abstract fun addCameraPitchChangeListener(listener: CameraAnimatorChangeListener<Double>)

addCameraZoomChangeListener

Add camera zoom change listener

abstract fun addCameraZoomChangeListener(listener: CameraAnimatorChangeListener<Double>)

calculateMoveBy

Utility method to calculate move by based on a offset screencoordinate

abstract fun calculateMoveBy(offset: ScreenCoordinate): Point?

calculateScaleBy

Utility method to calculate scale by using the amount and current zoom

abstract fun calculateScaleBy(amount: Double, currentZoom: Double): Double

cancelAllAnimators

Cancel all animators except ones owned by exceptOwnerList list.

abstract fun cancelAllAnimators(exceptOwnerList: List<String>)

cleanup

Called when the map is destroyed. Should be used to cleanup plugin resources for that map.

open override fun cleanup()

createAnchorAnimator

Create CameraAnchorAnimator

abstract fun createAnchorAnimator(options: CameraAnimatorOptions<ScreenCoordinate>, block: ValueAnimator.() -> Unit?): ValueAnimator

createBearingAnimator

Create CameraBearingAnimator. Current map camera option will be applied on animation start.

abstract fun createBearingAnimator(options: CameraAnimatorOptions<Double>, block: ValueAnimator.() -> Unit?): ValueAnimator

createCenterAnimator

Create CameraCenterAnimator. Current map camera option will be applied on animation start.

abstract fun createCenterAnimator(options: CameraAnimatorOptions<Point>, block: ValueAnimator.() -> Unit?): ValueAnimator

createPaddingAnimator

Create CameraPaddingAnimator. Current map camera option will be applied on animation start.

abstract fun createPaddingAnimator(options: CameraAnimatorOptions<EdgeInsets>, block: ValueAnimator.() -> Unit?): ValueAnimator

createPitchAnimator

Create CameraPitchAnimator. Current map camera option will be applied on animation start.

abstract fun createPitchAnimator(options: CameraAnimatorOptions<Double>, block: ValueAnimator.() -> Unit?): ValueAnimator

createZoomAnimator

Create CameraZoomAnimator

abstract fun createZoomAnimator(options: CameraAnimatorOptions<Double>, block: ValueAnimator.() -> Unit?): ValueAnimator

easeTo

Ease the map camera to a given camera options.

abstract fun easeTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?)

equals

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

flyTo

Fly the map camera to a given camera options.

This method implements an “optimal path” animation, as detailed in:

Van Wijk, Jarke J.; Nuij, Wim A. A. “Smooth and efficient zooming and panning.” INFOVIS ’03. pp. 15–22. https://www.win.tue.nl/~vanwijk/zoompan.pdf#page=5.

Where applicable, local variable documentation begins with the associated variable or function in van Wijk (2003).

abstract fun flyTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?)

hashCode

open override fun hashCode(): Int

initialize

Called when the plugin is first added to the map.

open override fun initialize()

moveBy

Move the map by a given screen coordinate with optional animation.

abstract fun moveBy(screenCoordinate: ScreenCoordinate, animationOptions: MapAnimationOptions?)

onDelegateProvider

Provides all map delegate instances.

open override fun onDelegateProvider(delegateProvider: MapDelegateProvider)

pitchBy

Pitch the map by with optional animation.

abstract fun pitchBy(pitch: Double, animationOptions: MapAnimationOptions?)

playAnimatorsSequentially

Play given ValueAnimator's sequentially

abstract fun playAnimatorsSequentially(vararg animators: Array<out ValueAnimator>)

playAnimatorsTogether

Play given ValueAnimator's together

abstract fun playAnimatorsTogether(vararg animators: Array<out ValueAnimator>)

registerAnimators

abstract fun registerAnimators(vararg cameraAnimators: Array<out ValueAnimator>)

removeCameraAnchorChangeListener

Remove camera anchor change listener

abstract fun removeCameraAnchorChangeListener(listener: CameraAnimatorChangeListener<ScreenCoordinate>)

removeCameraAnimationsLifecycleListener

Remove given CameraAnimationsLifecycleListener for capturing all events about animators lifecycle.

abstract fun removeCameraAnimationsLifecycleListener(listener: CameraAnimationsLifecycleListener)

removeCameraBearingChangeListener

Add camera bearing change listener

abstract fun removeCameraBearingChangeListener(listener: CameraAnimatorChangeListener<Double>)

removeCameraCenterChangeListener

Remove camera center change listener

abstract fun removeCameraCenterChangeListener(listener: CameraAnimatorChangeListener<Point>)

removeCameraPaddingChangeListener

Remove camera padding change listener

abstract fun removeCameraPaddingChangeListener(listener: CameraAnimatorChangeListener<EdgeInsets>)

removeCameraPitchChangeListener

Remove camera pitch change listener

abstract fun removeCameraPitchChangeListener(listener: CameraAnimatorChangeListener<Double>)

removeCameraZoomChangeListener

Remove camera zoom change listener

abstract fun removeCameraZoomChangeListener(listener: CameraAnimatorChangeListener<Double>)

rotateBy

Rotate the map by with optional animation.

abstract fun rotateBy(first: ScreenCoordinate, second: ScreenCoordinate, animationOptions: MapAnimationOptions?)

scaleBy

Scale the map by with optional animation.

abstract fun scaleBy(amount: Double, screenCoordinate: ScreenCoordinate?, animationOptions: MapAnimationOptions?)

toString

open override fun toString(): String

unregisterAnimators

Unregister all animators

abstract fun unregisterAnimators(vararg cameraAnimators: Array<out ValueAnimator>, cancelAnimators: Boolean)