com.mapbox.services.android.navigation.ui.v5.camera

Class NavigationCamera

java.lang.Object

com.mapbox.services.android.navigation.ui.v5.camera.NavigationCamera

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

public class NavigationCamera
extends java.lang.Object
implements android.arch.lifecycle.LifecycleObserver

Updates the map camera while navigating.

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

Since:

0.6.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NavigationCamera.TrackingMode

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAVIGATION_TRACKING_MODE_GPS Camera tracks the user location, with bearing provided by the location update.
static int	NAVIGATION_TRACKING_MODE_NONE Camera does not tack the user location.
static int	NAVIGATION_TRACKING_MODE_NORTH Camera tracks the user location, with bearing always set to north (0).

Constructor Summary

Constructors

Constructor and Description
NavigationCamera(com.mapbox.mapboxsdk.maps.MapboxMap mapboxMap, com.mapbox.mapboxsdk.location.LocationComponent locationComponent) Creates an instance of NavigationCamera.
NavigationCamera(com.mapbox.mapboxsdk.maps.MapboxMap mapboxMap, com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation navigation, com.mapbox.mapboxsdk.location.LocationComponent locationComponent) Creates an instance of NavigationCamera.

Method Summary

Modifier and Type	Method and Description
void	addProgressChangeListener(com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation navigation) This method can be called if you did not pass an instance of MapboxNavigation to the constructor.
int	getCameraTrackingMode() Getter for NavigationCamera.TrackingMode that's being used when tracking is enabled.
boolean	isTrackingEnabled() Getter for current state of tracking.
void	onStart() Call in FragmentActivity.onStart() to properly add the ProgressChangeListener for the camera and prevent any leaks or further updates.
void	onStop() Call in FragmentActivity.onStop() to properly remove the ProgressChangeListener for the camera and prevent any leaks or further updates.
void	resetCameraPositionWith(int trackingMode) Resets the map camera / padding to the last known camera position.
void	resume(android.location.Location location) Called during rotation to update route information.
void	showRouteOverview(int[] padding) This method stops the map camera from tracking the current location, and then zooms out to an overview of the current route being traveled.
void	start(com.mapbox.api.directions.v5.models.DirectionsRoute route) Called when beginning navigation with a route.
void	updateCameraTrackingMode(int trackingMode) Updates the NavigationCamera.TrackingMode that's going to be used when camera tracking is enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAVIGATION_TRACKING_MODE_GPS

public static final int NAVIGATION_TRACKING_MODE_GPS

Camera tracks the user location, with bearing provided by the location update.

Equivalent of the CameraMode.TRACKING_GPS.

See Also:

Constant Field Values

NAVIGATION_TRACKING_MODE_NORTH

public static final int NAVIGATION_TRACKING_MODE_NORTH

Camera tracks the user location, with bearing always set to north (0).

Equivalent of the CameraMode.TRACKING_GPS_NORTH.

See Also:

Constant Field Values

NAVIGATION_TRACKING_MODE_NONE

public static final int NAVIGATION_TRACKING_MODE_NONE

Camera does not tack the user location.

Equivalent of the CameraMode.NONE.

See Also:

Constant Field Values

Constructor Detail

NavigationCamera

public NavigationCamera(@NonNull
                        com.mapbox.mapboxsdk.maps.MapboxMap mapboxMap,
                        @NonNull
                        com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation navigation,
                        @NonNull
                        com.mapbox.mapboxsdk.location.LocationComponent locationComponent)

Creates an instance of NavigationCamera.

Parameters:

mapboxMap - for moving the camera

navigation - for listening to location updates

locationComponent - for managing camera mode

NavigationCamera

public NavigationCamera(@NonNull
                        com.mapbox.mapboxsdk.maps.MapboxMap mapboxMap,
                        com.mapbox.mapboxsdk.location.LocationComponent locationComponent)

Creates an instance of NavigationCamera.

Camera will start tracking current user location by default.

Parameters:

mapboxMap - for moving the camera

locationComponent - for managing camera mode

Method Detail

start

public void start(com.mapbox.api.directions.v5.models.DirectionsRoute route)

Called when beginning navigation with a route.

Parameters:

route - used to update route information

resume

public void resume(android.location.Location location)

Called during rotation to update route information.

Parameters:

location - used to update route information

updateCameraTrackingMode

public void updateCameraTrackingMode(int trackingMode)

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

Parameters:

trackingMode - the tracking mode

isTrackingEnabled

public boolean isTrackingEnabled()

Getter for current state of tracking.

Returns:

true if tracking, false if not

getCameraTrackingMode

public int getCameraTrackingMode()

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

Returns:

tracking mode

resetCameraPositionWith

public void resetCameraPositionWith(int trackingMode)

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

You can also specify a tracking mode to reset with. For example if you would like to reset the camera and continue tracking, you would use NAVIGATION_TRACKING_MODE_GPS.

Parameters:

trackingMode - the tracking mode

showRouteOverview

public void showRouteOverview(int[] padding)

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

Parameters:

padding - in pixels around the bounding box of the overview (left, top, right, bottom)

onStart

public void onStart()

Call in FragmentActivity.onStart() to properly add the ProgressChangeListener for the camera and prevent any leaks or further updates.

onStop

public void onStop()

Call in FragmentActivity.onStop() to properly remove the ProgressChangeListener for the camera and prevent any leaks or further updates.

addProgressChangeListener

public void addProgressChangeListener(com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation navigation)

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

The camera will begin listening to progress updates and update the route accordingly.

Parameters:

navigation - to add the camera progress change listener