Package com.mapbox.maps.plugin.animation

Types

CameraAnimationsLifecycleListener

interface CameraAnimationsLifecycleListener

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

CameraAnimationsPlugin

interface CameraAnimationsPlugin : MapPlugin

Interface to interact with Camera Animations plugin

CameraAnimationsPluginImpl

class CameraAnimationsPluginImpl : CameraAnimationsPlugin

CameraAnimationsPluginImpl is designed to rule all the animations happening to the map driven by changing CameraOptions.

CameraAnimatorChangeListener

fun fun interface CameraAnimatorChangeListener<T>

Interface to get updated non-nullable animator values.

CameraAnimatorNullableChangeListener

fun fun interface CameraAnimatorNullableChangeListener<T>

Interface to get updated animator values including nulls.

CameraAnimatorOptions

class CameraAnimatorOptions<T>

Class responsible for storing options used by all CameraAnimator's from CameraAnimationsPlugin.

CameraAnimatorsFactory

class CameraAnimatorsFactory

CameraAnimatorsFactory stands for storing default animation options.

CameraAnimatorType

enum CameraAnimatorType : Enum<CameraAnimatorType>

Enum class representing all possible camera animator types.

Cancelable

fun fun interface Cancelable

Interface describing cancelable animation set for high-level functions like flyTo, easeTo etc.

MapAnimationOptions

class 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.

MapAnimationOwnerRegistry

object MapAnimationOwnerRegistry

Registry for all plugins using Camera Animation system.

Functions

easeTo

@JvmOverloads()

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

Extension easeTo() for MapPluginExtensionsDelegate Ease the map camera to a given camera options and animation optionsCamera plugin with id = Plugin.MAPBOX_CAMERA_PLUGIN_ID must be added while constructing com.mapbox.maps.

flyTo

@JvmOverloads()

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

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

moveBy

@JvmOverloads()

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

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

pitchBy

@JvmOverloads()

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

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

rotateBy

@JvmOverloads()

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

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

scaleBy

@JvmOverloads()

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

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

Properties

camera

val MapPluginProviderDelegate.camera: CameraAnimationsPlugin

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