Update the mapSDK puck in NavigationMapView with location course for bearing (#3123)

Author: ShanMa1991

Example/ViewController+FreeDrive.swift

@@ -43,7 +43,6 @@ extension ViewController {
 
         if let location = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.locationKey] as? CLLocation {
             trackStyledFeature.lineString.coordinates.append(contentsOf: [location.coordinate])
-            navigationMapView.moveUserLocation(to: location)
         }
 
         if let rawLocation = notification.userInfo?[PassiveLocationManager.NotificationUserInfoKey.rawLocationKey] as? CLLocation {

Sources/MapboxNavigation/CarPlayManager.swift

@@ -228,6 +228,10 @@ public class CarPlayManager: NSObject {
         let route = navigationService.route
         let routeOptions = navigationService.routeProgress.routeOptions
 
+        // Stop the background `PassiveLocationProvider` sending location and heading update `mapView` before turn-by-turn navigation session starts.
+        navigationMapView?.mapView.location.locationProvider.stopUpdatingLocation()
+        navigationMapView?.mapView.location.locationProvider.stopUpdatingHeading()
+        
         var trip = CPTrip(routes: [route], routeOptions: routeOptions, waypoints: routeOptions.waypoints)
         trip = delegate?.carPlayManager(self, willPreview: trip) ?? trip
 

Sources/MapboxNavigation/NavigationMapView+VanishingRouteLine.swift

@@ -151,6 +151,7 @@ extension NavigationMapView {
      */
     func updateTraveledRouteLine(_ coordinate: CLLocationCoordinate2D?) {
         guard let granularDistances = routeLineGranularDistances,let index = routeRemainingDistancesIndex, let location = coordinate else { return }
+        guard index < granularDistances.distanceArray.endIndex else { return }
         let traveledIndex = granularDistances.distanceArray[index]
         let upcomingPoint = traveledIndex.point
 
@@ -205,27 +206,8 @@ extension NavigationMapView {
 
         let congestionSegments = routeProgress.route.congestionFeatures(legIndex: currentLegIndex, roadClassesWithOverriddenCongestionLevels: roadClassesWithOverriddenCongestionLevels)
 
-        switch userLocationStyle {
-        
-        case .courseView:
-            let startDate = Date()
-            vanishingRouteLineUpdateTimer = Timer.scheduledTimer(withTimeInterval: 0.05, repeats: true, block: { timer in
-                let timePassedInMilliseconds = Date().timeIntervalSince(startDate) * 1000
-                // In case if the time was already in the last interval - invalidate the timer and wait for the next routeProgress update.
-                if timePassedInMilliseconds >= 980 {
-                    timer.invalidate()
-                    return
-                }
-                
-                let newFractionTraveled = self.preFractionTraveled + traveledDifference * timePassedInMilliseconds.truncatingRemainder(dividingBy: 1000) / 1000
-                self.updateRouteLine(congestionSegments:congestionSegments, layerIdentifier: mainRouteLayerIdentifier, fractionTraveledUpdate: newFractionTraveled)
-                self.updateRouteLine(layerIdentifier: mainRouteCasingLayerIdentifier, fractionTraveledUpdate: newFractionTraveled)
-            })
-            
-        default:
-            self.updateRouteLine(congestionSegments:congestionSegments, layerIdentifier: mainRouteLayerIdentifier, fractionTraveledUpdate: fractionTraveled)
-            self.updateRouteLine(layerIdentifier: mainRouteCasingLayerIdentifier, fractionTraveledUpdate: fractionTraveled)
-        }
+        updateRouteLine(congestionSegments:congestionSegments, layerIdentifier: mainRouteLayerIdentifier, fractionTraveledUpdate: fractionTraveled)
+        updateRouteLine(layerIdentifier: mainRouteCasingLayerIdentifier, fractionTraveledUpdate: fractionTraveled)
     }
 
     func updateRouteLine(congestionSegments: [Turf.Feature]? = nil, layerIdentifier: String, fractionTraveledUpdate: Double) {

Sources/MapboxNavigation/NavigationMapView.swift

@@ -177,7 +177,7 @@ open class NavigationMapView: UIView {
     /**
      Specifies how the map displays the user’s current location, including the appearance and underlying implementation.
 
-     By default, this property is set to `UserLocationStyle.courseView`.
+     By default, this property is set to `UserLocationStyle.courseView`, the bearing source is location course.
      */
     public var userLocationStyle: UserLocationStyle = .courseView(UserPuckCourseView(frame: CGRect(origin: .zero, size: 75.0))) {
         didSet {
@@ -262,6 +262,7 @@ open class NavigationMapView: UIView {
                 self.mapView.location.options.puckType = .puck3D(configuration)
             }
         }
+        mapView.location.options.puckBearingSource = .course
     }
 
     deinit {
@@ -330,9 +331,12 @@ open class NavigationMapView: UIView {
         mapView.mapboxMap.onEvery(.renderFrameFinished) { [weak self] _ in
             guard let self = self,
                   let location = self.mostRecentUserCourseViewLocation else { return }
-            switch self.userLocationStyle {
-            case .courseView: self.moveUserLocation(to: location)
-            default: break
+            self.moveUserLocation(to: location)
+            
+            if self.simulatesLocation {
+                if let locationProvider = self.mapView.location.locationProvider {
+                    self.mapView.location.locationProvider(locationProvider, didUpdateLocations: [location])
+                }
             }
         }
 
@@ -463,49 +467,8 @@ open class NavigationMapView: UIView {
                                   direction: cameraOptions.bearing!,
                                   animated: animated,
                                   navigationCameraState: navigationCamera.state)
-        case .puck2D(configuration: _):
-            if simulatesLocation {
-                if !(mapView.location.locationProvider is PassiveLocationProvider) {
-                    mapView.location.locationProvider.stopUpdatingLocation()
-                }
-                if mapView.mapboxMap.style.layerExists(withId: NavigationMapView.LayerIdentifier.puck2DLayer) {
-                    let newLocation: [Double] = [
-                        location.coordinate.latitude,
-                        location.coordinate.longitude,
-                        location.altitude
-                    ]
-                    do {
-                        try mapView.mapboxMap.style.setLayerProperties(for: NavigationMapView.LayerIdentifier.puck2DLayer,
-                                                                       properties: [
-                                                                        "location": newLocation,
-                                                                        "bearing": location.course
-                                                                       ])
-                    } catch {
-                        print("Failed to perform operation while updating 2D puck bearing arrow with error: \(error.localizedDescription).")
-                    }
-                }
-            }
-        case .puck3D(configuration: let configuration):
-            if simulatesLocation {
-                if !(mapView.location.locationProvider is PassiveLocationProvider) {
-                    mapView.location.locationProvider.stopUpdatingLocation()
-                }
-                if mapView.mapboxMap.style.sourceExists(withId: NavigationMapView.SourceIdentifier.puck3DSource) {
-                    var model = configuration.model
-                    model.position = [location.coordinate.longitude, location.coordinate.latitude]
-                    if var orientation = model.orientation,
-                       orientation.count > 2 {
-                        orientation[2] = orientation[2] + location.course
-                        model.orientation = orientation
-                    }
-                    
-                    let modelSourceCode = [NavigationMapView.ModelKeyIdentifier.modelSouce: model]
-                    if let data = try? JSONEncoder().encode(modelSourceCode),
-                       let jsonDictionary = try? JSONSerialization.jsonObject(with: data, options: []) as? [String: Any] {
-                        try? mapView.mapboxMap.style.setSourceProperty(for: NavigationMapView.SourceIdentifier.puck3DSource, property: "models", value: jsonDictionary)
-                    }
-                }
-            }
+            
+        default: break
         }
     }
 

Sources/MapboxNavigation/NavigationViewController.swift

@@ -195,6 +195,7 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
         }
         set {
             navigationMapView?.routeLineTracksTraversal = newValue
+            routeOverlayController?.routeLineTracksTraversal = newValue
         }
     }
 
@@ -836,19 +837,22 @@ extension NavigationViewController: NavigationServiceDelegate {
         for component in navigationComponents {
             component.navigationService(service, didBeginSimulating: progress, becauseOf: reason)
         }
+        let simulatedLocationProvider = NavigationLocationProvider(locationManager: SimulatedLocationManager(routeProgress: progress))
+        navigationMapView?.mapView.location.overrideLocationProvider(with: simulatedLocationProvider)
     }
 
     public func navigationService(_ service: NavigationService, willEndSimulating progress: RouteProgress, becauseOf reason: SimulationIntent) {
         for component in navigationComponents {
             component.navigationService(service, willEndSimulating: progress, becauseOf: reason)
         }
-        navigationMapView?.simulatesLocation = true
+        navigationMapView?.simulatesLocation = false
     }
 
     public func navigationService(_ service: NavigationService, didEndSimulating progress: RouteProgress, becauseOf reason: SimulationIntent) {
         for component in navigationComponents {
             component.navigationService(service, didEndSimulating: progress, becauseOf: reason)
         }
+        navigationMapView?.mapView.location.overrideLocationProvider(with: AppleLocationProvider())
     }
 
     private func checkTunnelState(at location: CLLocation, along progress: RouteProgress) {

Sources/MapboxNavigation/RouteLineController.swift

@@ -1,11 +1,12 @@
 import MapboxDirections
 import MapboxCoreNavigation
+import MapboxMaps
 import CoreLocation
 import UIKit
 
 extension NavigationMapView {
     /// A component meant to assist displaying route line and related items like arrows, waypoints, annotations and other.
-    class RouteOverlayController: NavigationComponent, NavigationComponentDelegate {
+    class RouteOverlayController: NavigationComponent, NavigationComponentDelegate, LocationConsumer {
 
         // MARK: - Properties
 
@@ -20,12 +21,17 @@ extension NavigationMapView {
             navigationViewData.router
         }
 
-        fileprivate var routeLineTracksTraversal: Bool {
+        fileprivate var routeProgress: RouteProgress?
+        
+        var routeLineTracksTraversal: Bool {
             get {
                 navigationMapView.routeLineTracksTraversal
             }
             set {
                 navigationMapView.routeLineTracksTraversal = newValue
+                if newValue {
+                    navigationMapView.mapView.location.addLocationConsumer(newConsumer: self)
+                }
             }
         }
 
@@ -59,6 +65,12 @@ extension NavigationMapView {
             }
         }
 
+        internal func locationUpdate(newLocation: Location) {
+            guard routeLineTracksTraversal, let progress = routeProgress else { return }
+            navigationMapView.updateTraveledRouteLine(newLocation.coordinate)
+            navigationMapView.updateRoute(progress)
+        }
+        
         private func updateMapOverlays(for routeProgress: RouteProgress) {
             if routeProgress.currentLegProgress.followOnStep != nil {
                 navigationMapView.addArrow(route: routeProgress.route,
@@ -75,8 +87,7 @@ extension NavigationMapView {
             navigationMapView.show([routeProgress.route], legIndex: routeProgress.legIndex)
             if routeLineTracksTraversal {
                 navigationMapView.updateUpcomingRoutePointIndex(routeProgress: routeProgress)
-                navigationMapView.updateTraveledRouteLine(router.location?.coordinate)
-                navigationMapView.updateRoute(routeProgress)
+                self.routeProgress = routeProgress
             }
         }
 
@@ -121,8 +132,7 @@ extension NavigationMapView {
 
             if routeLineTracksTraversal {
                 navigationMapView.updateUpcomingRoutePointIndex(routeProgress: progress)
-                navigationMapView.updateTraveledRouteLine(location.coordinate)
-                navigationMapView.updateRoute(progress)
+                routeProgress = progress
             }
         }