Package com.mapbox.maps.plugin.animation

Types

CameraAnimationsLifecycleListener
Link copied to clipboard
interface CameraAnimationsLifecycleListener

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

CameraAnimationsPlugin
Link copied to clipboard
interface CameraAnimationsPlugin : MapPlugin

Interface to interact with Camera Animations plugin

CameraAnimationsPluginImpl
Link copied to clipboard

CameraAnimationsPluginImpl is designed to rule all the animations happening to the map driven by changing CameraOptions. It is responsible for:

CameraAnimatorChangeListener
Link copied to clipboard
fun interface CameraAnimatorChangeListener<T>

Interface to get updated non-nullable animator values.

CameraAnimatorNullableChangeListener
Link copied to clipboard
fun interface CameraAnimatorNullableChangeListener<T>

Interface to get updated animator values including nulls.

CameraAnimatorOptions
Link copied to clipboard
class CameraAnimatorOptions<T>

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.

CameraAnimatorsFactory
Link copied to clipboard
class CameraAnimatorsFactory

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

CameraAnimatorType
Link copied to clipboard
enum CameraAnimatorType : Enum<CameraAnimatorType>

Enum class representing all possible camera animator types.

Cancelable
Link copied to clipboard
fun interface Cancelable

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

MapAnimationOptions
Link copied to clipboard
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
Link copied to clipboard
object MapAnimationOwnerRegistry

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

Functions

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

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

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

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

moveBy
Link copied to clipboard
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
Link copied to clipboard
fun MapPluginExtensionsDelegate.pitchBy(pitch: Double, animationOptions: MapAnimationOptions? = null): Cancelable

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

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

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

scaleBy
Link copied to clipboard
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
Link copied to clipboard
@get:JvmName(name = "getCamera")
val MapPluginProviderDelegate.camera: CameraAnimationsPlugin

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