com.tomtom.sdk.navigation:route-replanner-hybrid/com.tomtom.sdk.navigation.routereplanner.hybrid/HybridRouteReplanner

HybridRouteReplanner

class HybridRouteReplanner : RouteReplanner

A hybrid implementation of the RouteReplanner, designed to utilize both online and offline routing capabilities for route replanning during a navigation session.

To create an instance of HybridRouteReplanner, use the create factory method and provide instances of the RoutePlanner for online and offline routing, along with an optional RouteReplannerConfiguration.

val hybridRouteReplanner = HybridRouteReplanner.create(onlineRoutePlanner, offlineRoutePlanner)

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

Types

Companion

object Companion

Functions

backToRoute

open override fun backToRoute(navigationSnapshot: NavigationSnapshot): Result<RouteReplannerResponse, RouteReplanningFailure>

open override fun close()

fullReplan

open override fun fullReplan(navigationSnapshot: NavigationSnapshot): Result<RouteReplannerResponse, RouteReplanningFailure>

Plans a new route that leads to the destination. It is used when the user deviates from the current route or the language is changed. The newly planned route does not necessarily have to follow the same geometry as the active one if the user has deviated. However, if the active route was initially planned with supporting points, the route planning will consider the undriven part of the active route. This also applies when re-planning due to a language change.

incrementRouteContents

open override fun incrementRouteContents(navigationSnapshot: NavigationSnapshot): Result<RouteReplannerResponse, RouteReplanningFailure>

Calculates route contents (instructions, lane guidance) for the first sequence of instructions following the last successful increment.

toString

open override fun toString(): String

Returns a string representation of the hybrid route re-planner.

update

open override fun update(navigationSnapshot: NavigationSnapshot): Result<RouteReplannerResponse, RouteReplanningFailure>

Updates a route using the provided NavigationSnapshot object. It is used for the continuous replanning of the route during navigation. The RouteReplannerResponse contains the current route with refreshed data and the alternative route, if any. The refreshed route is the first one in the RouteReplannerResponse.routes list.