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

Package com.mapbox.maps.plugin.animation

Types

Interface responsible to notify about any CameraAnimator lifecycle events registered in CameraAnimationsPlugin. Those events are:

animator is about to start
animator is about to cancel already running animator of same type
animator is about to end
animator is about to cancel

interface CameraAnimationsLifecycleListener

CameraAnimationsPlugin

Interface to interact with Camera Animations plugin

interface CameraAnimationsPlugin : MapPlugin

CameraAnimatorChangeListener

Interface to get updated non-nullable animator values.

fun fun interface CameraAnimatorChangeListener<T>

CameraAnimatorNullableChangeListener

Interface to get updated animator values including nulls.

fun fun interface CameraAnimatorNullableChangeListener<T>

CameraAnimatorOptions

Class responsible for storing options used by all CameraAnimator's from CameraAnimationsPlugin. CameraAnimatorOptions.Builder should be used to create options object via DSL function cameraAnimatorOptions.

class CameraAnimatorOptions<T>

CameraAnimatorsFactory

CameraAnimatorsFactory stands for storing default animation options. Provides default animators for "easeTo", "scaleBy", "pitchBy", "moveBy", "rotateBy" animations

class CameraAnimatorsFactory

CameraAnimatorType

Enum class representing all possible camera animator types.

enum CameraAnimatorType : Enum<CameraAnimatorType>

MapAnimationOptions

Map transition options which are used to configure animation if using high-level API like CameraAnimationsPlugin.easeTo, CameraAnimationsPlugin.flyTo etc MapAnimationOptions.Builder should be used to create options object via DSL function mapAnimationOptions.

class MapAnimationOptions

MapAnimationOwnerRegistry

Registry for all plugins using Camera Animation system. This means that all animations controlled by any plugin will create animators with their owner.

object MapAnimationOwnerRegistry

Functions

easeTo

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

fun MapPluginExtensionsDelegate.easeTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?): Any?

flyTo

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

fun MapPluginExtensionsDelegate.flyTo(cameraOptions: CameraOptions, animationOptions: MapAnimationOptions?): Any?

getCameraAnimationsPlugin

Extension function for MapView to get the Camera Animations plugin instance.

fun MapPluginProviderDelegate.getCameraAnimationsPlugin(): CameraAnimationsPlugin

moveBy

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

fun MapPluginExtensionsDelegate.moveBy(screenCoordinate: ScreenCoordinate, animationOptions: MapAnimationOptions?): Any?

pitchBy

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

fun MapPluginExtensionsDelegate.pitchBy(pitch: Double, animationOptions: MapAnimationOptions?): Any?

rotateBy

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

fun MapPluginExtensionsDelegate.rotateBy(first: ScreenCoordinate, second: ScreenCoordinate, animationOptions: MapAnimationOptions?): Any?

scaleBy

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

fun MapPluginExtensionsDelegate.scaleBy(amount: Double, screenCoordinate: ScreenCoordinate?, animationOptions: MapAnimationOptions?): Any?