Show the traffic devices on current route step during active navigation only.

Author: ShanMa1991

CHANGELOG.md

@@ -20,7 +20,7 @@
 
 * `NavigationMapView.removeAlternativeRoutes()` and `NavigationMapView.removeContinuousAlternativeRoutesDurations()` were made public to provide a way to remove previously shown alternative routes and alternative routes duration annotations, respectively. ([#4134](https://github.com/mapbox/mapbox-navigation-ios/pull/4134))
 * Fixed an issue where tapping on a route duration annotation that overlaps a different route would cause the wrong route to be passed into `NavigationMapViewDelegate.navigationMapView(_:didSelect:)` or `NavigationMapViewDelegate.navigationMapView(_:didSelect:)`. ([#4133](https://github.com/mapbox/mapbox-navigation-ios/pull/4133))
-* Added `NavigationMapView.showsIntersectionSignalsOnRoutes` to annotate traffic control devices along the current route line. ([#4185](https://github.com/mapbox/mapbox-navigation-ios/pull/4185))
+* Added `NavigationMapView.showsIntersectionSignals`, `NavigationMapView.showIntersectionSignals(with:)` and `NavigationMapView.removeIntersectionSignals()` to annotate traffic control devices on the current route step during active navigation. ([#4185](https://github.com/mapbox/mapbox-navigation-ios/pull/4185))
 
 ### Banners and guidance instructions
 

Example/AppDelegate+CarPlay.swift

@@ -92,7 +92,7 @@ extension AppDelegate: CarPlayManagerDelegate {
         // Render part of the route that has been traversed with full transparency, to give the illusion of a disappearing route.
         navigationViewController.routeLineTracksTraversal = true
         navigationViewController.navigationMapView?.showsRestrictedAreasOnRoute = true
-        navigationViewController.navigationMapView?.showsIntersectionSignalsOnRoutes = true
+        navigationViewController.navigationMapView?.showsIntersectionSignals = true
 
         // Example of building highlighting in 3D.
         navigationViewController.waypointStyle = .extrudedBuilding

Example/CustomViewController.swift

@@ -67,6 +67,7 @@ class CustomViewController: UIViewController {
             // By setting the `NavigationMapView.routeLineTracksTraversal` to `true`, it would allow the main route shown with
             // traversed part disappearing effect in a standalone `NavigationMapView` during active navigation.
             self.navigationMapView.routeLineTracksTraversal = true
+            self.navigationMapView.showsIntersectionSignals = true
             if self.navigationMapView.mapView.mapboxMap.style.layerExists(withId: "road-intersection") {
                 // Provide the custom layer position for route line in active navigation.
                 self.navigationMapView.show([self.navigationService.route], layerPosition: .below("road-intersection") ,legIndex: 0)
@@ -151,6 +152,9 @@ class CustomViewController: UIViewController {
         // without redrawing the main route.
         navigationMapView.updateRouteLine(routeProgress: routeProgress, coordinate: location.coordinate, shouldRedraw: routeProgress.legIndex != currentLegIndex)
         currentLegIndex = routeProgress.legIndex
+        
+        // Add intersection signals
+        navigationMapView.showIntersectionSignals(with: routeProgress)
     }
 
     @objc func updateInstructionsBanner(notification: NSNotification) {
@@ -173,6 +177,8 @@ class CustomViewController: UIViewController {
         navigationMapView.updateRouteLine(routeProgress: navigationService.routeProgress,
                                           coordinate: navigationService.router.location?.coordinate,
                                           shouldRedraw: true)
+        
+        navigationMapView.showIntersectionSignals(with: navigationService.routeProgress)
     }
 
     @objc func refresh(_ notification: NSNotification) {

Example/ViewController.swift

@@ -666,7 +666,7 @@ class ViewController: UIViewController {
             self.navigationMapView = nil
             self.passiveLocationManager = nil
             navigationViewController.navigationMapView?.showsRestrictedAreasOnRoute = true
-            navigationViewController.navigationMapView?.showsIntersectionSignalsOnRoutes = true
+            navigationViewController.navigationMapView?.showsIntersectionSignals = true
 
             // Animate top and bottom banner views presentation.
             navigationViewController.navigationView.bottomBannerContainerView.show(duration: 1.0,

Sources/MapboxNavigation/CarPlayMapViewController.swift

@@ -403,9 +403,9 @@ extension CarPlayMapViewController: StyleManagerDelegate {
     public func styleManager(_ styleManager: StyleManager, didApply style: Style) {
         let mapboxMapStyle = navigationMapView.mapView.mapboxMap.style
         if mapboxMapStyle.uri?.rawValue != style.mapStyleURL.absoluteString {
+            navigationMapView.styleType = style.styleType
             let styleURI = StyleURI(url: style.mapStyleURL)
             mapboxMapStyle.uri = styleURI
-            navigationMapView.styleType = style.styleType
             // Update the sprite repository of wayNameView when map style changes.
             wayNameView?.label.updateStyle(styleURI: styleURI, idiom: .carPlay)
         }

Sources/MapboxNavigation/CarPlayNavigationViewController.swift

@@ -779,6 +779,8 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
 
         navigationMapView?.updateRouteLine(routeProgress: routeProgress, coordinate: location.coordinate, shouldRedraw: legIndex != currentLegIndexMapped)
         currentLegIndexMapped = legIndex
+        
+        navigationMapView?.showIntersectionSignals(with: routeProgress)
     }
 
     private func checkTunnelState(at location: CLLocation, along progress: RouteProgress) {
@@ -872,6 +874,8 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
             navigationMapView?.removeArrow()
         }
         navigationMapView?.showWaypoints(on: progress.route, legIndex: legIndex)
+        
+        navigationMapView?.showIntersectionSignals(with: progress)
     }
 
     func updateManeuvers(_ routeProgress: RouteProgress) {
@@ -1033,9 +1037,9 @@ extension CarPlayNavigationViewController: StyleManagerDelegate {
     public func styleManager(_ styleManager: StyleManager, didApply style: Style) {
         let mapboxMapStyle = navigationMapView?.mapView.mapboxMap.style
         if mapboxMapStyle?.uri?.rawValue != style.mapStyleURL.absoluteString {
+            navigationMapView?.styleType = style.styleType
             let styleURI = StyleURI(url: style.mapStyleURL)
             mapboxMapStyle?.uri = styleURI
-            navigationMapView?.styleType = style.styleType
             // Update the sprite repository of wayNameView when map style changes.
             wayNameView?.label.updateStyle(styleURI: styleURI, idiom: .carPlay)
         }

Sources/MapboxNavigation/NavigationMapView+Annotations.swift

@@ -395,35 +395,10 @@ extension NavigationMapView {
 
     // MARK: Intersection Signals Annotations
 
-    /**
-     Removes all intersection signals on current route.
-     */
-    func removeIntersectionSignals() {
-        let style = mapView.mapboxMap.style
-        style.removeLayers([NavigationMapView.LayerIdentifier.intersectionSignalLayer])
-        style.removeSources([NavigationMapView.SourceIdentifier.intersectionSignalSource])
-    }
-    
-    func updateIntersectionSignalsAlongRouteOnMap(styleType: StyleType = .day) {
-        guard showsIntersectionSignalsOnRoutes, let route = routes?.first else {
-            removeIntersectionSignals()
-            return
-        }
-              
-        do {
-            try updateIntersectionSymbolImages()
-        } catch {
-            Log.error("Error occured while updating intersection signal images: \(error.localizedDescription).",
-                      category: .navigationUI)
-        }
-        
-        updateIntersectionSignals(along: route, styleType: styleType)
-    }
-    
     /**
      Updates the image assets in the map style for the route intersection signals.
      */
-    private func updateIntersectionSymbolImages() throws {
+    func updateIntersectionSymbolImages() throws {
         let style = mapView.mapboxMap.style
 
         if style.image(withId: ImageIdentifier.trafficSignalDay) == nil,
@@ -447,15 +422,20 @@ extension NavigationMapView {
         }
     }
 
-    private func updateIntersectionSignals(along route: Route, styleType: StyleType) {
+    func updateIntersectionSignals(with routeProgress: RouteProgress) {
+        guard !routeProgress.routeIsComplete else {
+            removeIntersectionSignals()
+            return
+        }
         var featureCollection = FeatureCollection(features: [])
-        for leg in route.legs {
-            for step in leg.steps {
-                guard let intersections = step.intersections else { continue }
-                for intersection in intersections {
-                    guard let feature = signalFeature(from: intersection, styleType: styleType) else { continue }
-                    featureCollection.features.append(feature)
-                }
+        
+        let stepProgress = routeProgress.currentLegProgress.currentStepProgress
+        let intersectionIndex = stepProgress.intersectionIndex
+        let stepIntersections = stepProgress.intersectionsIncludingUpcomingManeuverIntersection
+        
+        for intersection in stepIntersections?.suffix(from: intersectionIndex) ?? [] {
+            if let feature = signalFeature(from: intersection, styleType: styleType) {
+                featureCollection.features.append(feature)
             }
         }
 
@@ -472,14 +452,9 @@ extension NavigationMapView {
             }
 
             let layerIdentifier = NavigationMapView.LayerIdentifier.intersectionSignalLayer
-            var shapeLayer: SymbolLayer
-            if style.layerExists(withId: layerIdentifier),
-               let symbolLayer = try style.layer(withId: layerIdentifier) as? SymbolLayer {
-                shapeLayer = symbolLayer
-            } else {
-                shapeLayer = SymbolLayer(id: layerIdentifier)
-            }
+            guard !style.layerExists(withId: layerIdentifier) else { return }
 
+            var shapeLayer = SymbolLayer(id: layerIdentifier)
             shapeLayer.source = sourceIdentifier
             shapeLayer.iconAllowOverlap = .constant(false)
             shapeLayer.iconImage = .expression(Exp(.get) {

Sources/MapboxNavigation/NavigationMapView.swift

@@ -264,7 +264,6 @@ open class NavigationMapView: UIView {
         customRouteLineLayerPosition = layerPosition
 
         applyRoutesDisplay(layerPosition: layerPosition)
-        updateIntersectionSignalsAlongRouteOnMap(styleType: styleType)
     }
 
     func applyRoutesDisplay(layerPosition: MapboxMaps.LayerPosition? = nil) {
@@ -352,7 +351,6 @@ open class NavigationMapView: UIView {
 
         routes = nil
         removeLineGradientStops()
-        removeIntersectionSignals()
     }
 
     /**
@@ -1128,23 +1126,42 @@ open class NavigationMapView: UIView {
     }
 
     /**
-     Shows the intersection signals on current route.
+     Show the signals on the intersections.
+     
+     - parameter routeProgress: The `RouteProgress` that the intersections will be displayed with.
      */
-    public var showsIntersectionSignalsOnRoutes: Bool = false {
-        didSet {
-            updateIntersectionSignalsAlongRouteOnMap(styleType: styleType)
+    public func showIntersectionSignals(with routeProgress: RouteProgress) {
+        guard showsIntersectionSignals else {
+            removeIntersectionSignals()
+            return
+        }
+        
+        do {
+            try updateIntersectionSymbolImages()
+        } catch {
+            Log.error("Error occured while updating intersection signal images: \(error.localizedDescription).",
+                      category: .navigationUI)
         }
+        
+        updateIntersectionSignals(with: routeProgress)
     }
 
     /**
-     The style type of `NavigationMapView` during active navigation.
+     Shows the intersection signals on current step of current route during active navigation.
      */
-    var styleType: StyleType = .day {
+    public var showsIntersectionSignals: Bool = false {
         didSet {
-            updateIntersectionSignalsAlongRouteOnMap(styleType: styleType)
+            if !showsIntersectionSignals {
+                removeIntersectionSignals()
+            }
         }
     }
 
+    /**
+     The style type of `NavigationMapView` during active navigation.
+     */
+    var styleType: StyleType = .day
+    
     let continuousAlternativeDurationAnnotationOffset: LocationDistance = 75
 
     /**
@@ -1166,6 +1183,15 @@ open class NavigationMapView: UIView {
         style.removeSources([NavigationMapView.SourceIdentifier.continuousAlternativeRoutesDurationAnnotationsSource])
     }
 
+    /**
+     Removes all intersection signals on current route.
+     */
+    public func removeIntersectionSignals() {
+        let style = mapView.mapboxMap.style
+        style.removeLayers([NavigationMapView.LayerIdentifier.intersectionSignalLayer])
+        style.removeSources([NavigationMapView.SourceIdentifier.intersectionSignalSource])
+    }
+    
     /**
      `PointAnnotation`, which should be added to the `MapView` when `PointAnnotationManager` becomes
      available. Since `PointAnnotationManager` is created only after loading `MapView` style, there
@@ -1464,11 +1490,11 @@ open class NavigationMapView: UIView {
             route?.identifier(.restrictedRouteAreaRoute)
         ].compactMap{ $0 }
         let arrowLayers: [String] = [
-            LayerIdentifier.intersectionSignalLayer,
             LayerIdentifier.arrowStrokeLayer,
             LayerIdentifier.arrowLayer,
             LayerIdentifier.arrowSymbolCasingLayer,
-            LayerIdentifier.arrowSymbolLayer
+            LayerIdentifier.arrowSymbolLayer,
+            LayerIdentifier.intersectionSignalLayer
         ]
         let uppermostSymbolLayers: [String] = [
             LayerIdentifier.waypointCircleLayer,

Sources/MapboxNavigation/NavigationViewController.swift

@@ -1156,9 +1156,9 @@ extension NavigationViewController: StyleManagerDelegate {
 
     private func updateMapStyle(_ style: Style) {
         if navigationMapView?.mapView.mapboxMap.style.uri?.rawValue != style.mapStyleURL.absoluteString {
+            navigationMapView?.styleType = style.styleType
             let styleURI = StyleURI(url: style.mapStyleURL)
             navigationMapView?.mapView.mapboxMap.style.uri = styleURI
-            navigationMapView?.styleType = style.styleType
             // Update the sprite repository of wayNameView when map style changes.
             ornamentsController?.updateStyle(styleURI: styleURI)
         }

Sources/MapboxNavigation/RouteLineController.swift

@@ -54,6 +54,8 @@ extension NavigationMapView {
             if annotatesSpokenInstructions {
                 navigationMapView.showVoiceInstructionsOnMap(route: router.route)
             }
+            
+            navigationMapView.showIntersectionSignals(with: router.routeProgress)
         }
 
         func navigationViewDidAppear(_ animated: Bool) {
@@ -88,6 +90,8 @@ extension NavigationMapView {
             if annotatesSpokenInstructions {
                 navigationMapView.showVoiceInstructionsOnMap(route: route)
             }
+            
+            navigationMapView.showIntersectionSignals(with: router.routeProgress)
         }
 
         func navigationService(_ service: NavigationService, didUpdate progress: RouteProgress, with location: CLLocation, rawLocation: CLLocation) {
@@ -111,6 +115,8 @@ extension NavigationMapView {
 
             navigationMapView.updateRouteLine(routeProgress: progress, coordinate: location.coordinate, shouldRedraw: currentLegIndexMapped != legIndex)
             currentLegIndexMapped = legIndex
+            
+            navigationMapView.showIntersectionSignals(with: router.routeProgress)
         }
 
         private func updateMapOverlays(for routeProgress: RouteProgress) {