com.mapbox.services.android.navigation.v5

Class RouteProgress

java.lang.Object

com.mapbox.services.android.navigation.v5.RouteProgress

public abstract class RouteProgress
extends java.lang.Object

The routeProgress class contains all progress information of user along the route, leg and step.

You can use this together with MapboxNavigation to obtain this object from the AlertLevelChangeListener or the ProgressChangeListener. This object is immutable and a new, updated routeProgress object will be provided with each new location update.

This is an experimental API. Experimental APIs are quickly evolving and might change or be removed in minor versions.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
RouteProgress()

Method Summary

Modifier and Type	Method and Description
abstract int	alertUserLevel()
static RouteProgress	create(com.mapbox.services.api.directions.v5.models.DirectionsRoute route, com.mapbox.services.commons.models.Position userSnappedPosition, int legIndex, int stepIndex, int alertUserLevel) Constructor for the route routeProgress information.
abstract RouteLegProgress	currentLegProgress()
int	getAlertUserLevel() Get the most recently provided alert level, this can and will only be one of the alert constants.
com.mapbox.services.api.directions.v5.models.RouteLeg	getCurrentLeg() Provides the current RouteLeg the user is on.
RouteLegProgress	getCurrentLegProgress() Gives a RouteLegProgress object with information about the particular leg the user is currently on.
double	getDistanceRemaining() Provides the duration remaining in seconds till the user reaches the end of the route.
double	getDistanceTraveled() Total distance traveled in meters along route.
double	getDurationRemaining() Provides the duration remaining in seconds till the user reaches the end of the route.
float	getFractionTraveled() Get the fraction traveled along the current route, this is a float value between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the end of the route.
int	getLegIndex() Index representing the current leg.
com.mapbox.services.api.directions.v5.models.DirectionsRoute	getRoute() Get the route the navigation session is currently using.
abstract int	legIndex()
abstract com.mapbox.services.api.directions.v5.models.DirectionsRoute	route()
abstract com.mapbox.services.commons.models.Position	userSnappedPosition()

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteProgress

public RouteProgress()

Method Detail

currentLegProgress

public abstract RouteLegProgress currentLegProgress()

route

public abstract com.mapbox.services.api.directions.v5.models.DirectionsRoute route()

userSnappedPosition

public abstract com.mapbox.services.commons.models.Position userSnappedPosition()

legIndex

public abstract int legIndex()

alertUserLevel

public abstract int alertUserLevel()

create

public static RouteProgress create(com.mapbox.services.api.directions.v5.models.DirectionsRoute route,
                                   com.mapbox.services.commons.models.Position userSnappedPosition,
                                   int legIndex,
                                   int stepIndex,
                                   int alertUserLevel)

Constructor for the route routeProgress information.

Parameters:

route - the DirectionsRoute being used for the navigation session. When a user is rerouted this route is updated.

userSnappedPosition - the users position most recently used when creating this object.

stepIndex - an integer representing the current step index the user is on.

alertUserLevel - the most recently calculated alert level.

Since:

0.1.0

getCurrentLegProgress

public RouteLegProgress getCurrentLegProgress()

Gives a RouteLegProgress object with information about the particular leg the user is currently on.

Returns:

a RouteLegProgress object.

Since:

0.1.0

getLegIndex

public int getLegIndex()

Index representing the current leg.

Returns:

an integer representing the current leg the user is on.

Since:

0.1.0

getCurrentLeg

public com.mapbox.services.api.directions.v5.models.RouteLeg getCurrentLeg()

Provides the current RouteLeg the user is on.

Returns:

a RouteLeg the user is currently on.

getDistanceTraveled

public double getDistanceTraveled()

Total distance traveled in meters along route.

Returns:

a double value representing the total distance the user has traveled along the route, using unit meters.

Since:

0.1.0

getDurationRemaining

public double getDurationRemaining()

Provides the duration remaining in seconds till the user reaches the end of the route.

Returns:

long value representing the duration remaining till end of route, in unit seconds.

Since:

0.1.0

getFractionTraveled

public float getFractionTraveled()

Get the fraction traveled along the current route, this is a float value between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the end of the route.

Returns:

a float value between 0 and 1 representing the fraction the user has traveled along the route.

Since:

0.1.0

getDistanceRemaining

public double getDistanceRemaining()

Provides the duration remaining in seconds till the user reaches the end of the route.

Returns:

long value representing the duration remaining till end of route, in unit seconds.

Since:

0.1.0

getAlertUserLevel

public int getAlertUserLevel()

Get the most recently provided alert level, this can and will only be one of the alert constants.

Returns:

an integer representing the most recent user alert level.

Since:

0.1.0

getRoute

public com.mapbox.services.api.directions.v5.models.DirectionsRoute getRoute()

Get the route the navigation session is currently using.

Returns:

a DirectionsRoute currently being used for the navigation session.

Since:

0.1.0