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: CameraAnimatorNullableChangeListener<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>)

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 if not specified explicitly with options.startValue.

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

createCenterAnimator

Create CameraCenterAnimator. Current map camera option will be applied on animation start if not specified explicitly with options.startValue.

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

createPaddingAnimator

Create CameraPaddingAnimator. Current map camera option will be applied on animation start if not specified explicitly with options.startValue.

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

createPitchAnimator

Create CameraPitchAnimator. Current map camera option will be applied on animation start if not specified explicitly with options.startValue.

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?): Cancelable

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. The online documentation.

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

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

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?): Cancelable

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?): Cancelable

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: CameraAnimatorNullableChangeListener<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?): Cancelable

scaleBy

Scale the map by with optional animation.

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

toString

open override fun toString(): String

unregisterAnimators

Unregister all animators

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

Properties

anchor

Map camera anchor value. Default value is NULL meaning center of given map view. Left-top corner is represented as ScreenCoordinate (0.0, 0.0).

If anchor is set to some specific value (set directly or by some running anchor animation) it will be used as anchor for all upcoming animations even if they do not animate anchor directly.

Note: If anchor animator is started and no start value is specified explicitly and anchor = NULL - then start value will be set to ScreenCoordinate(0.0, 0.0) automatically and it will be start point for interpolation.

abstract var anchor: ScreenCoordinate?

debugMode

If debug mode is enabled extra logs will be written about animation lifecycle and some other events that may be useful for debugging.

abstract var debugMode: Boolean

Inheritors

CameraAnimationsPluginImpl