Annotate intersections in active navigation session only.

Author: ShanMa1991

CHANGELOG.md

@@ -21,7 +21,7 @@
 * 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))
 * Fixed an issue where the shields in the instruction are using the style from last navigation session with the `NavigationMapView` injection used in the new session. ([#4197](https://github.com/mapbox/mapbox-navigation-ios/pull/4197))
 * Fixed an issue where the `NavigationMapView.localizeLabels()` method only localized map labels according to the user’s Preferred Language Order setting if the application also had a localization in the preferred language. ([#4205](https://github.com/mapbox/mapbox-navigation-ios/pull/4205))
-* 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))
+* Added `NavigationViewController.annotatesIntersectionsAlongRoute` and `CarPlayNavigationViewController.annotatesIntersectionsAlongRoute` to annotate intersections 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,6 @@ 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?.showsIntersectionSignals = true
 
         // Example of building highlighting in 3D.
         navigationViewController.waypointStyle = .extrudedBuilding

Example/CustomViewController.swift

@@ -67,7 +67,6 @@ 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)
@@ -152,9 +151,6 @@ 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) {
@@ -177,8 +173,6 @@ 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,6 @@ class ViewController: UIViewController {
             self.navigationMapView = nil
             self.passiveLocationManager = nil
             navigationViewController.navigationMapView?.showsRestrictedAreasOnRoute = true
-            navigationViewController.navigationMapView?.showsIntersectionSignals = true
 
             // Animate top and bottom banner views presentation.
             navigationViewController.navigationView.bottomBannerContainerView.show(duration: 1.0,

Sources/MapboxNavigation/CarPlayNavigationViewController.swift

@@ -80,6 +80,17 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
         }
     }
 
+    /**
+     A Boolean value that determines whether the map annotates the intersections on current step during active navigation.
+     
+     Defaults to `true`.
+     */
+    public var annotatesIntersectionsAlongRoute: Bool = true {
+        didSet {
+            updateIntersectionsAlongRoute()
+        }
+    }
+    
     /**
      `AlternativeRoute`s user might take during this trip to reach the destination using another road.
 
@@ -777,10 +788,13 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
             navigationMapView?.showWaypoints(on: routeProgress.route, legIndex: legIndex)
         }
 
+        if annotatesIntersectionsAlongRoute {
+            navigationMapView?.updateIntersectionSignals(with: routeProgress)
+        }
+        
         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) {
@@ -875,7 +889,9 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
         }
         navigationMapView?.showWaypoints(on: progress.route, legIndex: legIndex)
 
-        navigationMapView?.showIntersectionSignals(with: progress)
+        if annotatesIntersectionsAlongRoute {
+            navigationMapView?.updateIntersectionSignals(with: progress)
+        }
     }
 
     func updateManeuvers(_ routeProgress: RouteProgress) {
@@ -1017,6 +1033,15 @@ open class CarPlayNavigationViewController: UIViewController, BuildingHighlighti
         carInterfaceController.dismissTemplate(animated: true)
         carInterfaceController.presentTemplate(waypointArrival, animated: true)
     }
+    
+    func updateIntersectionsAlongRoute() {
+        if annotatesIntersectionsAlongRoute {
+            navigationMapView?.updateIntersectionSymbolImages(styleType: styleManager?.currentStyleType)
+            navigationMapView?.updateIntersectionSignals(with: navigationService.routeProgress)
+        } else {
+            navigationMapView?.removeIntersectionSignals()
+        }
+    }
 }
 
 // MARK: StyleManagerDelegate Methods
@@ -1044,6 +1069,7 @@ extension CarPlayNavigationViewController: StyleManagerDelegate {
         wayNameView?.label.updateStyle(styleURI: styleURI, idiom: .carPlay)
         updateMapTemplateStyle()
         updateManeuvers(navigationService.routeProgress)
+        updateIntersectionsAlongRoute()
     }
 
     public func styleManagerDidRefreshAppearance(_ styleManager: StyleManager) {

Sources/MapboxNavigation/NavigationMapView+Annotations.swift

@@ -398,27 +398,33 @@ extension NavigationMapView {
     /**
      Updates the image assets in the map style for the route intersection signals.
      */
-    func updateIntersectionSymbolImages() throws {
+    func updateIntersectionSymbolImages(styleType: StyleType?) {
         let style = mapView.mapboxMap.style
+        let styleType = styleType ?? .day
 
-        if style.image(withId: ImageIdentifier.trafficSignalDay) == nil,
-           let trafficSignlaDay =  Bundle.mapboxNavigation.image(named: "TrafficSignalDay") {
-            try style.addImage(trafficSignlaDay, id: ImageIdentifier.trafficSignalDay)
-        }
-        
-        if style.image(withId: ImageIdentifier.trafficSignalNight) == nil,
-           let trafficSignalNight =  Bundle.mapboxNavigation.image(named: "TrafficSignalNight") {
-            try style.addImage(trafficSignalNight, id: ImageIdentifier.trafficSignalNight)
-        }
-        
-        if style.image(withId: ImageIdentifier.railroadCrossingDay) == nil,
-           let railroadCrossingDay =  Bundle.mapboxNavigation.image(named: "RailroadCrossingDay") {
-            try style.addImage(railroadCrossingDay, id: ImageIdentifier.railroadCrossingDay)
-        }
-        
-        if style.image(withId: ImageIdentifier.railroadCrossingNight) == nil,
-           let railroadCrossingNight =  Bundle.mapboxNavigation.image(named: "RailroadCrossingNight") {
-            try style.addImage(railroadCrossingNight, id: ImageIdentifier.railroadCrossingNight)
+        do {
+            if styleType == .day {
+                if let trafficSignlaDay = Bundle.mapboxNavigation.image(named: "TrafficSignalDay") {
+                    try style.addImage(trafficSignlaDay, id: ImageIdentifier.trafficSignal)
+                }
+                
+                if let railroadCrossingDay = Bundle.mapboxNavigation.image(named: "RailroadCrossingDay") {
+                    try style.addImage(railroadCrossingDay, id: ImageIdentifier.railroadCrossing)
+                }
+                
+            } else {
+                if let trafficSignalNight = Bundle.mapboxNavigation.image(named: "TrafficSignalNight") {
+                    try style.addImage(trafficSignalNight, id: ImageIdentifier.trafficSignal)
+                }
+                
+                if let railroadCrossingNight = Bundle.mapboxNavigation.image(named: "RailroadCrossingNight") {
+                    try style.addImage(railroadCrossingNight, id: ImageIdentifier.railroadCrossing)
+                }
+            }
+            
+        } catch {
+            Log.error("Error occured while updating intersection signal images: \(error.localizedDescription).",
+                      category: .navigationUI)
         }
     }
 
@@ -434,7 +440,7 @@ extension NavigationMapView {
         let stepIntersections = stepProgress.intersectionsIncludingUpcomingManeuverIntersection
 
         for intersection in stepIntersections?.suffix(from: intersectionIndex) ?? [] {
-            if let feature = signalFeature(from: intersection, styleType: styleType) {
+            if let feature = signalFeature(from: intersection) {
                 featureCollection.features.append(feature)
             }
         }
@@ -469,14 +475,13 @@ extension NavigationMapView {
         }
     }
 
-    private func signalFeature(from intersection: Intersection, styleType: StyleType) -> Feature? {
+    private func signalFeature(from intersection: Intersection) -> Feature? {
         var properties: JSONObject? = nil
-        let styleTypeString = (styleType == .day) ? "Day" : "Night"
         if intersection.railroadCrossing == true {
-            properties = ["imageName": .string("RailroadCrossing" + styleTypeString)]
+            properties = ["imageName": .string(ImageIdentifier.railroadCrossing)]
         }
         if intersection.trafficSignal == true {
-            properties = ["imageName": .string("TrafficSignal" + styleTypeString)]
+            properties = ["imageName": .string(ImageIdentifier.trafficSignal)]
         }
 
         guard let properties = properties else { return nil }

Sources/MapboxNavigation/NavigationMapView.swift

@@ -1125,43 +1125,6 @@ open class NavigationMapView: UIView {
         }
     }
 
-    /**
-     Show the signals on the intersections.
-     
-     - parameter routeProgress: The `RouteProgress` that the intersections will be displayed with.
-     */
-    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)
-    }
-    
-    /**
-     Shows the intersection signals on current step of current route during active navigation.
-     */
-    public var showsIntersectionSignals: Bool = false {
-        didSet {
-            if !showsIntersectionSignals {
-                removeIntersectionSignals()
-            }
-        }
-    }
-    
-    /**
-     The style type of `NavigationMapView` during active navigation.
-     */
-    var styleType: StyleType = .day
-    
     let continuousAlternativeDurationAnnotationOffset: LocationDistance = 75
 
     /**

Sources/MapboxNavigation/NavigationMapViewIdentifiers.swift

@@ -38,10 +38,8 @@ extension NavigationMapView {
         static let markerImage = "default_marker"
         static let routeAnnotationLeftHanded = "RouteInfoAnnotationLeftHanded"
         static let routeAnnotationRightHanded = "RouteInfoAnnotationRightHanded"
-        static let trafficSignalDay = "TrafficSignalDay"
-        static let trafficSignalNight = "TrafficSignalNight"
-        static let railroadCrossingDay = "RailroadCrossingDay"
-        static let railroadCrossingNight = "RailroadCrossingNight"
+        static let trafficSignal = "traffic_signal"
+        static let railroadCrossing = "railroad_crossing"
     }
 
     struct ModelKeyIdentifier {

Sources/MapboxNavigation/NavigationViewController.swift

@@ -115,6 +115,21 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
         }
     }
 
+    /**
+     A Boolean value that determines whether the map annotates the intersections on current step during active navigation.
+     
+     Defaults to `true`.
+     */
+    public var annotatesIntersectionsAlongRoute: Bool {
+        get {
+            routeOverlayController?.annotatesIntersections ?? true
+        }
+        set {
+            routeOverlayController?.annotatesIntersections = newValue
+            updateIntersectionsAlongRoute()
+        }
+    }
+    
     /**
      Toggles displaying alternative routes.
 
@@ -867,6 +882,15 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
             styleManager.applyStyle(type: .day)
         }
     }
+    
+    func updateIntersectionsAlongRoute() {
+        if annotatesIntersectionsAlongRoute {
+            navigationMapView?.updateIntersectionSymbolImages(styleType: styleManager?.currentStyleType)
+            navigationMapView?.updateIntersectionSignals(with: navigationService.routeProgress)
+        } else {
+            navigationMapView?.removeIntersectionSignals()
+        }
+    }
 }
 
 // MARK: - NavigationViewDelegate methods
@@ -1209,6 +1233,7 @@ extension NavigationViewController: StyleManagerDelegate {
 
         ornamentsController?.updateStyle(styleURI: styleURI)
         currentStatusBarStyle = style.statusBarStyle ?? .default
+        updateIntersectionsAlongRoute()
         setNeedsStatusBarAppearanceUpdate()
     }
 

Sources/MapboxNavigation/RouteLineController.swift

@@ -55,7 +55,9 @@ extension NavigationMapView {
                 navigationMapView.showVoiceInstructionsOnMap(route: router.route)
             }
 
-            navigationMapView.showIntersectionSignals(with: router.routeProgress)
+            if annotatesIntersections {
+                navigationMapView.updateIntersectionSignals(with: router.routeProgress)
+            }
         }
 
         func navigationViewDidAppear(_ animated: Bool) {
@@ -91,7 +93,9 @@ extension NavigationMapView {
                 navigationMapView.showVoiceInstructionsOnMap(route: route)
             }
 
-            navigationMapView.showIntersectionSignals(with: router.routeProgress)
+            if annotatesIntersections {
+                navigationMapView.updateIntersectionSignals(with: router.routeProgress)
+            }
         }
 
         func navigationService(_ service: NavigationService, didUpdate progress: RouteProgress, with location: CLLocation, rawLocation: CLLocation) {
@@ -113,10 +117,12 @@ extension NavigationMapView {
                 navigationMapView.showVoiceInstructionsOnMap(route: route)
             }
 
+            if annotatesIntersections {
+                navigationMapView.updateIntersectionSignals(with: progress)
+            }
+            
             navigationMapView.updateRouteLine(routeProgress: progress, coordinate: location.coordinate, shouldRedraw: currentLegIndexMapped != legIndex)
             currentLegIndexMapped = legIndex
-            
-            navigationMapView.showIntersectionSignals(with: router.routeProgress)
         }
 
         private func updateMapOverlays(for routeProgress: RouteProgress) {
@@ -133,6 +139,7 @@ extension NavigationMapView {
         // MARK: Annotations Overlay
 
         var annotatesSpokenInstructions = false
+        var annotatesIntersections: Bool = true
 
         private var currentLegIndexMapped = 0
         private var currentStepIndexMapped = 0