com.mapbox.services.android.navigation.v5.models

Class RouteLegProgress

java.lang.Object

com.mapbox.services.android.navigation.v5.models.RouteLegProgress

public abstract class RouteLegProgress
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RouteLegProgress()

Method Summary

Modifier and Type	Method and Description
static RouteLegProgress	create(com.mapbox.services.api.directions.v5.models.RouteLeg routeLeg, int stepIndex, com.mapbox.services.commons.models.Position userSnappedPosition) Constructor for the route leg routeProgress information.
abstract RouteStepProgress	currentStepProgress()
com.mapbox.services.api.directions.v5.models.LegStep	getCurrentStep() Returns the current step the user is traversing along.
RouteStepProgress	getCurrentStepProgress() Gives a RouteStepProgress object with information about the particular step 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 current leg.
double	getDurationRemaining() Provides the duration remaining in seconds till the user reaches the end of the current step.
float	getFractionTraveled() Get the fraction traveled along the current leg, this is a float value between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the next leg (if another leg exist in route).
com.mapbox.services.api.directions.v5.models.LegStep	getPreviousStep() Get the previous step the user traversed along, if the user is still on the first step, this will return null.
int	getStepIndex() Index representing the current step.
com.mapbox.services.api.directions.v5.models.LegStep	getUpComingStep() Get the next/upcoming step immediately after the current step.
abstract com.mapbox.services.api.directions.v5.models.RouteLeg	routeLeg()
abstract int	stepIndex()
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

RouteLegProgress

public RouteLegProgress()

Method Detail

routeLeg

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

stepIndex

public abstract int stepIndex()

userSnappedPosition

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

currentStepProgress

public abstract RouteStepProgress currentStepProgress()

create

public static RouteLegProgress create(@NonNull
                                      com.mapbox.services.api.directions.v5.models.RouteLeg routeLeg,
                                      int stepIndex,
                                      @NonNull
                                      com.mapbox.services.commons.models.Position userSnappedPosition)

Constructor for the route leg routeProgress information.

Parameters:

routeLeg - The current RouteLeg the user is traversing along.

stepIndex - The current step index the user is on.

userSnappedPosition - the users snapped location when routeProgress was last updated.

Since:

0.1.0

getCurrentStepProgress

public RouteStepProgress getCurrentStepProgress()

Gives a RouteStepProgress object with information about the particular step the user is currently on.

Returns:

a RouteStepProgress object.

Since:

0.1.0

getStepIndex

public int getStepIndex()

Index representing the current step.

Returns:

an integer representing the current step the user is on.

Since:

0.1.0

getDistanceTraveled

public double getDistanceTraveled()

Total distance traveled in meters along current leg.

Returns:

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

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

getDurationRemaining

public double getDurationRemaining()

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

Returns:

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

Since:

0.1.0

getFractionTraveled

public float getFractionTraveled()

Get the fraction traveled along the current leg, this is a float value between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the next leg (if another leg exist in route).

Returns:

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

Since:

0.1.0

getPreviousStep

public com.mapbox.services.api.directions.v5.models.LegStep getPreviousStep()

Get the previous step the user traversed along, if the user is still on the first step, this will return null.

Returns:

a LegStep representing the previous step the user was on, if still on first step in route, returns null.

Since:

0.1.0

getCurrentStep

public com.mapbox.services.api.directions.v5.models.LegStep getCurrentStep()

Returns the current step the user is traversing along.

Returns:

a LegStep representing the step the user is currently on.

Since:

0.1.0

getUpComingStep

public com.mapbox.services.api.directions.v5.models.LegStep getUpComingStep()

Get the next/upcoming step immediately after the current step. If the user is on the last step on the last leg, this will return null since a next step doesn't exist.

Returns:

a LegStep representing the next step the user will be on.

Since:

0.1.0