mapbox-maps-android/com.mapbox.maps.plugin.animation/CameraAnimationsPlugin

CameraAnimationsPlugin

interface CameraAnimationsPlugin : MapPlugin

Interface to interact with Camera Animations plugin

Functions

addCameraAnchorChangeListener

abstract fun addCameraAnchorChangeListener(listener: CameraAnimatorNullableChangeListener<ScreenCoordinate?>)

Add camera anchor change listener

addCameraAnimationsLifecycleListener

abstract fun addCameraAnimationsLifecycleListener(listener: CameraAnimationsLifecycleListener)

Add given CameraAnimationsLifecycleListener for capturing all events about animators lifecycle.

addCameraBearingChangeListener

abstract fun addCameraBearingChangeListener(listener: CameraAnimatorChangeListener<Double>)

Add camera bearing change listener

addCameraCenterChangeListener

abstract fun addCameraCenterChangeListener(listener: CameraAnimatorChangeListener<Point>)

Add camera center change listener

addCameraPaddingChangeListener

abstract fun addCameraPaddingChangeListener(listener: CameraAnimatorChangeListener<EdgeInsets>)

Add camera padding change listener

addCameraPitchChangeListener

abstract fun addCameraPitchChangeListener(listener: CameraAnimatorChangeListener<Double>)

Add camera pitch change listener

addCameraZoomChangeListener

abstract fun addCameraZoomChangeListener(listener: CameraAnimatorChangeListener<Double>)

Add camera zoom change listener

calculateScaleBy

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

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

cancelAllAnimators

abstract fun cancelAllAnimators(exceptOwnerList: List<String> = emptyList())

Cancel all animators except ones owned by exceptOwnerList list.

cleanup

open fun cleanup()

Called when the map is destroyed.

createAnchorAnimator

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

Create CameraAnchorAnimator

createBearingAnimator

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

Create CameraBearingAnimator.

createCenterAnimator

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

Create CameraCenterAnimator.

createPaddingAnimator

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

Create CameraPaddingAnimator.

createPitchAnimator

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

Create CameraPitchAnimator.

createZoomAnimator

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

Create CameraZoomAnimator

easeTo

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

Ease the map camera to a given camera options.

equals

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

flyTo

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

Fly the map camera to a given camera options.

hashCode

open fun hashCode(): Int

initialize

open fun initialize()

Called when the plugin is first added to the map.

moveBy

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

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

onDelegateProvider

open fun onDelegateProvider(delegateProvider: MapDelegateProvider)

Provides all map delegate instances.

pitchBy

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

Pitch the map by with optional animation.

playAnimatorsSequentially

abstract fun playAnimatorsSequentially(vararg animators: ValueAnimator)

Play given ValueAnimator's sequentially

playAnimatorsTogether

abstract fun playAnimatorsTogether(vararg animators: ValueAnimator)

Play given ValueAnimator's together

registerAnimators

abstract fun registerAnimators(vararg cameraAnimators: ValueAnimator)

removeCameraAnchorChangeListener

abstract fun removeCameraAnchorChangeListener(listener: CameraAnimatorNullableChangeListener<ScreenCoordinate?>)

Remove camera anchor change listener

removeCameraAnimationsLifecycleListener

abstract fun removeCameraAnimationsLifecycleListener(listener: CameraAnimationsLifecycleListener)

Remove given CameraAnimationsLifecycleListener for capturing all events about animators lifecycle.

removeCameraBearingChangeListener

abstract fun removeCameraBearingChangeListener(listener: CameraAnimatorChangeListener<Double>)

Add camera bearing change listener

removeCameraCenterChangeListener

abstract fun removeCameraCenterChangeListener(listener: CameraAnimatorChangeListener<Point>)

Remove camera center change listener

removeCameraPaddingChangeListener

abstract fun removeCameraPaddingChangeListener(listener: CameraAnimatorChangeListener<EdgeInsets>)

Remove camera padding change listener

removeCameraPitchChangeListener

abstract fun removeCameraPitchChangeListener(listener: CameraAnimatorChangeListener<Double>)

Remove camera pitch change listener

removeCameraZoomChangeListener

abstract fun removeCameraZoomChangeListener(listener: CameraAnimatorChangeListener<Double>)

Remove camera zoom change listener

rotateBy

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

Rotate the map by with optional animation.

scaleBy

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

Scale the map by with optional animation.

toString

open fun toString(): String

unregisterAnimators

abstract fun unregisterAnimators(vararg cameraAnimators: ValueAnimator, cancelAnimators: Boolean = true)

Unregister all animators

Properties

anchor

abstract var anchor: ScreenCoordinate?

Map camera anchor value.

debugMode

abstract var debugMode: Boolean

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

Inheritors

CameraAnimationsPluginImpl