NavigationCamera

@UiThread()

open class NavigationCamera

Updates the map camera while navigating.

This class listens to the progress of MapboxNavigation and moves the MapboxMap camera based on the location updates.

Constructors

NavigationCamera

open fun NavigationCamera(mapboxMap: MapboxMap)

Creates an instance of NavigationCamera.

NavigationCamera

@TestOnly()

open fun NavigationCamera(mapboxMap: MapboxMap, navigation: MapboxNavigation, locationComponent: LocationComponent)

Types

TrackingMode

@Retention(value = RetentionPolicy.SOURCE)

annotation class TrackingMode

Functions

addOnTrackingModeChangedListener

open fun addOnTrackingModeChangedListener(listener: OnTrackingModeChangedListener)

Adds given tracking mode changed listener for receiving notification of cameramode changes.

addOnTrackingModeTransitionListener

open fun addOnTrackingModeTransitionListener(listener: OnTrackingModeTransitionListener)

Adds given tracking mode transition listener for receiving notification of cameratransition updates.

addProgressChangeListener

open fun addProgressChangeListener(navigation: MapboxNavigation)

This method can be called if you did not pass an instance of MapboxNavigation to the constructor.

findTrackingModeFor

@Nullable()

open fun findTrackingModeFor(cameraMode: Int): Integer

getCameraTrackingMode

open fun getCameraTrackingMode(): Int

Getter for TrackingMode that's being used when tracking is enabled.

isTrackingEnabled

open fun isTrackingEnabled(): Boolean

Getter for current state of tracking.

onStart

open fun onStart()

Call in onStart to properly add the RouteProgressObserver and LocationObserver for the camera and prevent any leaks or further updates.

onStop

open fun onStop()

Call in onStop to properly remove the RouteProgressObserver and LocationObserver for the camera and prevent any leaks or further updates.

removeOnTrackingModeChangedListener

open fun removeOnTrackingModeChangedListener(listener: OnTrackingModeChangedListener)

Removes given tracking mode transition listener for receiving notification of cameramode changes.

removeOnTrackingModeTransitionListener

open fun removeOnTrackingModeTransitionListener(listener: OnTrackingModeTransitionListener)

Removes given tracking mode transition listener for receiving notification of cameratransition updates.

removeProgressChangeListener

open fun removeProgressChangeListener()

Removes the previously registered progress change listener.

resetCameraPositionWith

open fun resetCameraPositionWith(trackingMode: Int)

Resets the map camera / padding to the last known camera position.

resume

open fun resume(location: Location)

Called during rotation to update route information.

showRouteGeometryOverview

open fun showRouteGeometryOverview(padding: Array<Int>): Boolean

This method stops the map camera from tracking the current location, and then zoomsout to an overview of the current route being traveled.

showRouteGeometryRemainingOverview

open fun showRouteGeometryRemainingOverview(padding: Array<Int>): Boolean

This method stops the map camera from tracking the current location, and then zoomsout to an overview of the current route that has yet to be traveled.

showRouteOverview

@Deprecated()

open fun showRouteOverview(padding: Array<Int>)

This method stops the map camera from tracking the current location, and then zoomsout to an overview of the current route being traveled.

start

open fun start(route: DirectionsRoute)

Called when beginning navigation with a route.

update

open fun update(update: NavigationCameraUpdate)

Animate the camera to a new location defined within CameraUpdate passed to the NavigationCameraUpdate using a transition animation that evokes powered flight.

open fun update(update: NavigationCameraUpdate, durationMs: Int)

Animate the camera to a new location defined within CameraUpdate passed to the NavigationCameraUpdate using a transition animation that evokes powered flight.The animation will last a specified amount of time given in milliseconds.

open fun update(update: NavigationCameraUpdate, durationMs: Int, callback: MapboxMap.CancelableCallback)

Animate the camera to a new location defined within CameraUpdate passed to the NavigationCameraUpdate using a transition animation that evokes powered flight.

updateCameraTrackingMode

open fun updateCameraTrackingMode(trackingMode: Int)

Updates the TrackingMode that's going to be used when camera tracking is enabled.

updateIsResetting

open fun updateIsResetting(isResetting: Boolean)

updateTransitionListenersCancelled

open fun updateTransitionListenersCancelled(cameraMode: Int)

updateTransitionListenersFinished

open fun updateTransitionListenersFinished(cameraMode: Int)