RouteStepProgress

data class RouteStepProgress(val distanceRemaining: Double, val intersections: List<StepIntersection>?, val currentIntersection: StepIntersection?, val upcomingIntersection: StepIntersection?, val intersectionDistancesAlongStep: Map<StepIntersection, Double>?, val step: LegStep, val nextStep: LegStep?)

This is a progress object specific to the current step the user is on.

The latest route step progress object can be obtained through either the ProgressChangeListener or the MilestoneEventListener callbacks. Note that the route step progress object's immutable.

Since

0.1.0

Constructors

Link copied to clipboard
constructor(distanceRemaining: Double, intersections: List<StepIntersection>?, currentIntersection: StepIntersection?, upcomingIntersection: StepIntersection?, intersectionDistancesAlongStep: Map<StepIntersection, Double>?, step: LegStep, nextStep: LegStep?)

Properties

Link copied to clipboard

The current intersection that has been passed along the route.

Link copied to clipboard

Total distance in meters from user to end of step.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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).

Link copied to clipboard

Provides a list of pairs containing two distances, in meters, along the route.

Link copied to clipboard

A collection of all the current steps intersections and the next steps maneuver location (if one exist).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The intersection being traveled towards on the route.