navigation:engine/com.tomtom.sdk.navigation.replanning/RouteReplanningEngine

RouteReplanningEngine

interface RouteReplanningEngine : Disposable
Content copied to clipboard

Responsible for replanning a route.

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

Link copied to clipboard
data class ReplanningParameters(    val routePlan: RoutePlan,     val routeProgress: RouteProgress,     val routingApi: RoutingApi,     val currentLocation: GeoLocation,     val routeCreationTime: Long,     val hasDeviated: Boolean,     val numberOfVisitedWaypoints: Int)
Content copied to clipboard

Parameters for a route refresh.

Functions

Link copied to clipboard
abstract fun dispose()
Content copied to clipboard
Link copied to clipboard
abstract fun replan(replanningParameters: RouteReplanningEngine.ReplanningParameters): Result<ReplannedRoute, RouteReplanningError>
Content copied to clipboard

Replans a given Route. If supporting points were given when planning the route, they will be used in the reconstruction as well, otherwise the road geometry points will be used.

Link copied to clipboard
abstract fun shouldReplan(replanningParameters: RouteReplanningEngine.ReplanningParameters): Boolean
Content copied to clipboard

Checks if current Route should be replanned.