Building extrusion highlights

CHANGELOG.md

@@ -26,8 +26,8 @@
   * `NavigationMapViewDelegate.navigationMapView(_:alternativeRouteStyleLayerWithIdentifier:source:)` to style alternative routes.
   * `NavigationMapViewDelegate.navigationMapView(_:alternativeRouteCasingStyleLayerWithIdentifier:source:)` to style the casing of alternative routes.
   * Fixed an issue where the casing for the main route would not overlap alternative routes. ([#2377](https://github.com/mapbox/mapbox-navigation-ios/pull/2377))
-* Added the NavigationViewController.highlightsDestinationBuildings property and NavigationMapView.highlightBuildings(at:in3D:) method to highlight the destination building in UIColor.defaultBuildingHighlightColor as the user approaches it.
-* Added the NavigationViewController.highlightsBuilidngsIn3D property to additionally extrude the destination building in 3D.
+  * Added `NavigationViewController.DestinationBuildingHighlightType` enum to control building highlighting. ([#2535](https://github.com/mapbox/mapbox-navigation-ios/pull/2535))
+  * Added `NavigationMapView.highlightBuildings(at:in3D:)` method to highlight the destination building in `UIColor.defaultBuildingHighlightColor` as the user approaches it. Added `NavigationMapView.unhighlightBuildings` to give the ability to unhighlight buildings. ([#2535](https://github.com/mapbox/mapbox-navigation-ios/pull/2535))
 
 ### Feedback
 

Example/ViewController.swift

@@ -249,8 +249,8 @@ class ViewController: UIViewController {
         // Render part of the route that has been traversed with full transparency, to give the illusion of a disappearing route.
         navigationViewController.mapView?.routeLineTracksTraversal = true
 
-        // Example of building highlighting using the NavigationViewController.
-        navigationViewController.highlightsDestinationBuildings = true
+        // Example of building highlighting in 3D.
+        navigationViewController.destinationBuildingHighlightType = .highlightIn3D
 
         presentAndRemoveMapview(navigationViewController, completion: beginCarPlayNavigation)
     }
@@ -262,11 +262,8 @@ class ViewController: UIViewController {
         let navigationViewController = NavigationViewController(for: route, routeOptions: routeOptions, navigationOptions: options)
         navigationViewController.delegate = self
 
-        // Example of building highlighting using the NavigationViewController.
-        navigationViewController.highlightsDestinationBuildings = true
-
-        // Extrude buildings in 2D.
-        navigationViewController.highlightBuildingsIn3D = false
+        // Example of building highlighting in 2D.
+        navigationViewController.destinationBuildingHighlightType = .highlightIn2D
 
         presentAndRemoveMapview(navigationViewController, completion: beginCarPlayNavigation)
     }

MapboxNavigation/NavigationMapView.swift

@@ -266,8 +266,6 @@ open class NavigationMapView: MGLMapView, UIGestureRecognizerDelegate {
         addGestureRecognizer(mapTapGesture)
 
         installUserCourseView()
-
-        styleURL = MGLStyle.navigationDayStyleURL
     }
 
     open override func layoutMarginsDidChange() {
@@ -295,11 +293,6 @@ open class NavigationMapView: MGLMapView, UIGestureRecognizerDelegate {
         if (tracksUserCourse) {
             updateCourseTracking(location: userLocationForCourseTracking, camera:self.camera, animated: false)
         }
-
-        // TODO: Add style observation to be able to re-add highlighted building whenever it happens.
-
-        // FIXME: Since building might be already highlighted and we do not have any info
-        // regarding its identification after style change such highlighted building will be lost.
     }
 
     open override func anchorPoint(forGesture gesture: UIGestureRecognizer) -> CGPoint {
@@ -1359,16 +1352,17 @@ open class NavigationMapView: MGLMapView, UIGestureRecognizerDelegate {
 extension NavigationMapView {
 
     /**
-     Receives coordinates for searching the map for buildings. If buildings are found, they will be highlighted in 2d or 3d depending on the `in3D` value.
-     `in3D` defaults to true
-     `buildingHighlightingEnabled` must be set to true before this function will work.
+     Receives coordinates for searching the map for buildings. If buildings are found, they will be highlighted in 2D or 3D depending on the `in3D` value.
+
+     - parameter coordinates: Coordinates which represent buildings locations.
+     - parameter extrudesBuildings: Switch which allows to highlight buildings in either 2D or 3D. Defaults to true.
      */
     public func highlightBuildings(at coordinates: [CLLocationCoordinate2D], in3D extrudesBuildings: Bool = true) {
-        highlightBuildings(Set(coordinates.compactMap({ buildingIdentifier(at: $0) })), in3D: extrudesBuildings, extrudeAll: false)
+        highlightBuildings(with: Set(coordinates.compactMap({ buildingIdentifier(at: $0) })), in3D: extrudesBuildings, extrudeAll: false)
     }
 
     /**
-     Removes the highlight from all buildings highlighted by `highlightBuildings(for coordinates:, in3D:)`.
+     Removes the highlight from all buildings highlighted by `highlightBuildings(at:in3D:)`.
      */
     public func unhighlightBuildings() {
         guard let highlightedBuildingsLayer = style?.layer(withIdentifier: StyleLayerIdentifier.buildingExtrusion) else { return }
@@ -1410,23 +1404,23 @@ extension NavigationMapView {
         return nil
     }
 
-    private func highlightBuildings(_ buildingIdentifiers: Set<Int64>, in3D: Bool = false, extrudeAll: Bool = false) {
+    private func highlightBuildings(with identifiers: Set<Int64>, in3D: Bool = false, extrudeAll: Bool = false) {
         // In case if set with highlighted building identifiers is empty - do nothing.
-        if buildingIdentifiers.isEmpty { return }
+        if identifiers.isEmpty { return }
         // Add layer which will be used to highlight buildings if it wasn't added yet.
         guard let highlightedBuildingsLayer = addBuildingsLayer() else { return }
 
         if extrudeAll {
             highlightedBuildingsLayer.predicate = NSPredicate(format: "extrude = 'true' AND type = 'building' AND underground = 'false'")
         } else {
             // Form a predicate to filter out the other buildings from the datasource so only the desired ones are included.
-            highlightedBuildingsLayer.predicate = NSPredicate(format: "extrude = 'true' AND type = 'building' AND underground = 'false' AND $featureIdentifier IN %@", buildingIdentifiers.map { $0 })
+            highlightedBuildingsLayer.predicate = NSPredicate(format: "extrude = 'true' AND type = 'building' AND underground = 'false' AND $featureIdentifier IN %@", identifiers.map { $0 })
         }
 
         // Buildings with identifiers will be highlighted with provided color. Rest of the buildings will be highlighted, but kept at a uniform color.
-        let highlightedBuildingHeightExpression = "MGL_MATCH($featureIdentifier, \(buildingIdentifiers.map { "\($0), \(in3D ? "height" : "0"), " }.joined(separator: ""))\(extrudeAll ? "height" : "0"))"
-        let highlightedBuildingColorExpression = "MGL_MATCH($featureIdentifier, \(buildingIdentifiers.map { "\($0), %@, " }.joined(separator: ""))%@)"
-        var colorsList = buildingIdentifiers.map { _ in buildingHighlightColor }
+        let highlightedBuildingHeightExpression = "MGL_MATCH($featureIdentifier, \(identifiers.map { "\($0), \(in3D ? "height" : "0"), " }.joined(separator: ""))\(extrudeAll ? "height" : "0"))"
+        let highlightedBuildingColorExpression = "MGL_MATCH($featureIdentifier, \(identifiers.map { "\($0), %@, " }.joined(separator: ""))%@)"
+        var colorsList = identifiers.map { _ in buildingHighlightColor }
 
         colorsList.append(buildingDefaultColor)
 

MapboxNavigation/NavigationViewController.swift

@@ -148,16 +148,29 @@ open class NavigationViewController: UIViewController, NavigationStatusPresenter
     public var shouldManageApplicationIdleTimer = true
 
     /**
-     Enables highlighting of the destination building when arriving.
+     Enum denoting the types of the destination building highlighting on arrival.
      */
-    public var highlightsDestinationBuildings: Bool = false
+    public enum DestinationBuildingHighlightType: Int {
+        /**
+         Do not highlight destination building on arrival.
+         */
+        case noHighlight
+
+        /**
+         Highlight destination building on arrival in 2D.
+         */
+        case highlightIn2D
+
+        /**
+         Highlight destination building on arrival in 3D.
+         */
+        case highlightIn3D
+    }
 
     /**
-     When destination building highlighting is enabled, this option controls whether the building will be presented in 3d or 2d.
-
-     The default value of this property is `true`.
+     Allows to control highlighting of the destination building on arrival. By default destination buildings will not be highlighted.
      */
-    public var highlightBuildingsIn3D: Bool = true
+    public var destinationBuildingHighlightType: DestinationBuildingHighlightType = .noHighlight
 
     var isConnectedToCarPlay: Bool {
         if #available(iOS 12.0, *) {
@@ -593,7 +606,7 @@ extension NavigationViewController: NavigationServiceDelegate {
     }
 
     private func zoomInAndHighlightBuilding(for location: CLLocation?) {
-        if !highlightsDestinationBuildings { return }
+        if destinationBuildingHighlightType == .noHighlight { return }
         guard let mapViewController = self.mapViewController else { return }
         guard let location = location else { return }
 
@@ -613,7 +626,7 @@ extension NavigationViewController: NavigationServiceDelegate {
                           animated: true,
                           completionHandler: {
                             // Highlight buildings which were marked as target destination coordinate in waypoint.
-                            mapView.highlightBuildings(at: self.routeOptions.waypoints.compactMap({ $0.targetCoordinate }), in3D: self.highlightBuildingsIn3D)
+                            mapView.highlightBuildings(at: self.routeOptions.waypoints.compactMap({ $0.targetCoordinate }), in3D: self.destinationBuildingHighlightType == .highlightIn3D ? true : false)
 
                             // Update insets to be able to correctly center map view after presenting end of route view.
                             mapViewController.updateMapViewContentInsets()

MapboxNavigation/RouteMapViewController.swift

@@ -145,6 +145,9 @@ class RouteMapViewController: UIViewController {
             self?.showRouteIfNeeded()
             mapView.localizeLabels()
             mapView.showsTraffic = false
+
+            // FIXME: In case when building highlighting feature is enabled due to style changes and no info currently being stored
+            // regarding building identification such highlighted building will disappear.
         }
 
         makeGestureRecognizersResetFrameRate()