Overwrite rerouting logic

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
  - Removed setCamera() from updateCourseTracking()
  - Added setCamera() to progressDidChange()
+ - Allow to customize rerouting logic by implementing RouteControllerDelegate#routeControllerGetDirections 
 
 ## v2.0.0 (May 23, 2023)
  - Upgrade minimum iOS version from 11.0 to 12.0.

MapboxCoreNavigation/RouteController.swift

@@ -634,6 +634,9 @@ extension RouteController: CLLocationManagerDelegate {
             guard let strongSelf = self else {
                 return
             }
+
+            // Update the rerouting state
+            strongSelf.isRerouting = false
 
             if let error = error {
                 strongSelf.delegate?.routeController?(strongSelf, didFailToRerouteWith: error)
@@ -679,25 +682,27 @@ extension RouteController: CLLocationManagerDelegate {
     }
 
     func getDirections(from location: CLLocation, along progress: RouteProgress, completion: @escaping (_ mostSimilarRoute: Route?, _ routes: [Route]?, _ error: Error?)->Void) {
-        routeTask?.cancel()
-        let options = progress.reroutingOptions(with: location)
-
-        self.lastRerouteLocation = location
-
-        let complete = { [weak self] (mostSimilarRoute: Route?, routes: [Route]?, error: NSError?) in
-            self?.isRerouting = false
-            completion(mostSimilarRoute, routes, error)
-        }
-
-        routeTask = directions.calculate(options) {(waypoints, potentialRoutes, potentialError) in
-
-            guard let routes = potentialRoutes else {
-                return complete(nil, nil, potentialError)
+        if(delegate?.routeControllerGetDirections?(from: location, along: progress, completion: completion) != true){
+            // Run the default route calculation if the delegate method is not defined or does not return true
+            routeTask?.cancel()
+            let options = progress.reroutingOptions(with: location)
+
+            self.lastRerouteLocation = location
+
+            let complete = { [weak self] (mostSimilarRoute: Route?, routes: [Route]?, error: NSError?) in
+                completion(mostSimilarRoute, routes, error)
             }
 
-            // Checks by comparing leg `name` properties and see if the edit distance is within threshold
-            let mostSimilar = routes.mostSimilar(to: progress.route)
-            return complete(mostSimilar ?? routes.first, routes, potentialError)
+            routeTask = directions.calculate(options) {(waypoints, potentialRoutes, potentialError) in
+
+                guard let routes = potentialRoutes else {
+                    return complete(nil, nil, potentialError)
+                }
+
+                // Checks by comparing leg `name` properties and see if the edit distance is within threshold
+                let mostSimilar = routes.mostSimilar(to: progress.route)
+                return complete(mostSimilar ?? routes.first, routes, potentialError)
+            }
         }
     }
 

MapboxCoreNavigation/RouteControllerDelegate.swift

@@ -114,4 +114,17 @@ public protocol RouteControllerDelegate: AnyObject {
      */
     @objc(routeControllerShouldDisableBatteryMonitoring:)
     optional func routeControllerShouldDisableBatteryMonitoring(_ routeController: RouteController) -> Bool
+
+    /**
+    Allows to customise the calculation of a route.
+
+    If you want to overwrite the defult rerouting loigc, return true.
+
+     - parameter from: The current olocation of the user
+     - parameter along: The route progress
+     - parameter completion: Callbackc function when either the route was sucessfully caluclated or if there was an error
+     - return: True to preferent the route controller from running its own rerouting logic
+     */
+    @objc(routeControllerGetDirections:along:completion:)
+    optional func routeControllerGetDirections(from location: CLLocation, along progress: RouteProgress, completion: @escaping (_ mostSimilarRoute: Route?, _ routes: [Route]?, _ error: Error?)->Void) -> Bool
 }