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

Class RouteStepProgress

java.lang.Object

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

public abstract class RouteStepProgress
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RouteStepProgress()

Method Summary

Modifier and Type	Method and Description
double	getDistanceRemaining() Total distance in meters from user to end of step.
double	getDistanceTraveled() Returns distance user has traveled along current step in unit meters.
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 step, this is a float value between 0 and 1 and isn't guaranteed to reach 1 before the user reaches the next step (if another step exist in route).
abstract com.mapbox.services.api.directions.v5.models.LegStep	step()
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

RouteStepProgress

public RouteStepProgress()

Method Detail

step

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

userSnappedPosition

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

getDistanceTraveled

public double getDistanceTraveled()

Returns distance user has traveled along current step in unit meters.

Returns:

double value representing the distance the user has traveled so far along the current step. Uses unit meters.

Since:

0.1.0

getDistanceRemaining

public double getDistanceRemaining()

Total distance in meters from user to end of step.

Returns:

double value representing the distance the user has remaining till they reach the end of the current step. Uses unit meters.

Since:

0.1.0

getFractionTraveled

public float getFractionTraveled()

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

Returns:

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

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