Open RouteController to custom location snapping

CHANGELOG.md

@@ -14,6 +14,7 @@
         self.startNavigation(with: route, animated: false)
     #endif
     ```
+* Custom location snapping in the `RouteController` via the delegate
 
 ## 3.0.0 (Jun 15, 2024)
 * The `speak` method in `RouteVoiceController` can be used without a given `RouteProgress` or the `RouteProgress` can explicitly ignored so that it will not be added to the voice instruction.

MapboxCoreNavigation/RouteController.swift

@@ -230,7 +230,12 @@
      - important: If the rawLocation is outside of the route snapping tolerances, this value is nil.
      */
     var snappedLocation: CLLocation? {
-        self.rawLocation?.snapped(to: self.routeProgress.currentLegProgress)
+        guard let raw = self.rawLocation else {
+            return nil
+        }
+
+        let customSnap = self.delegate?.routeControllerSnap?(rawLocation: raw)
+        return customSnap ?? raw.snapped(to: self.routeProgress.currentLegProgress)
     }
 
     var heading: CLHeading?
@@ -664,7 +669,7 @@
             if let _ = error { return }
             guard let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 200 else { return }
 
             guard let data, let currentVersion = String(data: data, encoding: .utf8)?.trimmingCharacters(in: .newlines) else { return }
 
             if latestVersion != currentVersion {
                 let updateString = NSLocalizedString("UPDATE_AVAILABLE", bundle: .mapboxCoreNavigation, value: "Mapbox Navigation SDK for iOS version %@ is now available.", comment: "Inform developer an update is available")

MapboxCoreNavigation/RouteControllerDelegate.swift

@@ -125,4 +125,13 @@ public protocol RouteControllerDelegate: AnyObject {
       */
     @objc(routeControllerGetDirections:along:completion:)
     optional func routeControllerGetDirections(from location: CLLocation, along progress: RouteProgress, completion: @escaping (_ mostSimilarRoute: Route?, _ routes: [Route]?, _ error: Error?) -> Void) -> Bool
+
+    /**
+     Allows to customize the snapping of raw and pre-snapped location. If no implementation is provided, the default snapping will be used.
+
+        - parameter rawLocation: The raw location from the controller
+        - returns: The snapped location or nil if snapping were impossible.
+     */
+    @objc(routeControllerSnapLocation:)
+    optional func routeControllerSnap(rawLocation: CLLocation) -> CLLocation?
 }