checkBearingForStepCompletion

fun checkBearingForStepCompletion(userLocation: Location, previousRouteProgress: RouteProgress, stepDistanceRemaining: Double, maxTurnCompletionOffset: Double): Boolean

Checks whether the user's bearing matches the next step's maneuver provided bearingAfter variable. This is one of the criteria's required for the user location to be recognized as being on the next step or potentially arriving.

If the expected turn angle is less than the max turn completion offset, this method will wait for the step distance remaining to be 0. This way, the step index does not increase prematurely.

Return

boolean true if the user location matches (using a tolerance) the final heading

Since

0.2.0

Parameters

userLocation

the location of the user

previousRouteProgress

used for getting the most recent route information