RouteStepProgress

class RouteStepProgress

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

The latest route step progress object can be obtained through the RouteProgressObserver. Note that the route step progress object's immutable.

Parameters

stepIndex

Int Index representing the current step the user is on

intersectionIndex

Int Index representing the current intersection the user is on

instructionIndex

Int Index of the current instruction in the list of available instructions for this step

step

LegStep Returns the current step the user is traversing along

stepPoints

List that represent the current step geometry

distanceRemaining

Float Total distance in meters from user to end of step

distanceTraveled

Float Distance user has traveled along current step in unit meters

fractionTraveled

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

durationRemaining

Double The duration remaining in seconds until the user reaches the end of the current step

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Regenerate whenever a change is made
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Regenerate whenever a change is made
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

distanceRemaining
Link copied to clipboard
val distanceRemaining: Float
Float Total distance in meters from user to end of step
distanceTraveled
Link copied to clipboard
val distanceTraveled: Float
Float Distance user has traveled along current step in unit meters
durationRemaining
Link copied to clipboard
val durationRemaining: Double
Double The duration remaining in seconds until the user reaches the end of the current step
fractionTraveled
Link copied to clipboard
val fractionTraveled: Float
Float 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)
instructionIndex
Link copied to clipboard
val instructionIndex: Int?
Int Index of the current instruction in the list of available instructions for this step
intersectionIndex
Link copied to clipboard
val intersectionIndex: Int
Int Index representing the current intersection the user is on
step
Link copied to clipboard
val step: LegStep?
LegStep Returns the current step the user is traversing along
stepIndex
Link copied to clipboard
val stepIndex: Int
Int Index representing the current step the user is on
stepPoints
Link copied to clipboard
val stepPoints: List<Point>?
List that represent the current step geometry