Merge pull request #39 from HudHud-Maps/enhancement/unify-navigation

Support Maplibre Navigation iOS

Author: ianthetechie

.swiftpm/xcode/xcshareddata/xcschemes/MapLibreSwiftDSL.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1510"
+   LastUpgradeVersion = "1540"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

.swiftpm/xcode/xcshareddata/xcschemes/MapLibreSwiftUI-Package.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1510"
+   LastUpgradeVersion = "1540"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

.swiftpm/xcode/xcshareddata/xcschemes/MapLibreSwiftUI.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1510"
+   LastUpgradeVersion = "1540"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

README.md

@@ -25,6 +25,7 @@ can move fast without breaking anything important.
     * Overlays
     * Dynamic styling
     * Camera control / animation??
+    * Navigation
 2. Prevent most common classes of mistakes that users make with the lower level APIs (ex: adding the same source twice)
 3. Deeper SwiftUI integration (ex: SwiftUI callout views)
 
@@ -46,6 +47,45 @@ Then, for each target add either the DSL (for just the DSL) or both (for the Swi
 Check out the (super basic) [previews at the bottom of MapView.swift](Sources/MapLibreSwiftUI/MapView.swift)
 or more detailed [Examples](Sources/MapLibreSwiftUI/Examples) to see how it works in practice.
 
+## Navigation
+
+If you need to support navigation add https://github.com/HudHud-Maps/maplibre-navigation-ios.git to your Package.swift and add this code:
+
+```swift
+import MapboxCoreNavigation
+import MapboxNavigation
+
+extension NavigationViewController: MapViewHostViewController {
+    public typealias MapType = NavigationMapView
+}
+
+
+@State var route: Route?
+@State var navigationInProgress: Bool = false
+
+@ViewBuilder
+var mapView: some View {
+    MapView<NavigationViewController>(makeViewController: NavigationViewController(dayStyleURL: self.styleURL), styleURL: self.styleURL, camera: self.$mapStore.camera) {
+
+    }
+    .unsafeMapViewControllerModifier { navigationViewController in
+        navigationViewController.delegate = self.mapStore
+        if let route = self.route, self.navigationInProgress == false {
+            let locationManager = SimulatedLocationManager(route: route)
+            navigationViewController.startNavigation(with: route, locationManager: locationManager)
+            self.navigationInProgress = true
+        } else if self.route == nil, self.navigationInProgress == true {
+            navigationViewController.endNavigation()
+            self.navigationInProgress = false
+        }
+
+        navigationViewController.mapView.showsUserLocation = self.showUserLocation && self.mapStore.streetView == .disabled
+    }
+    .cameraModifierDisabled(self.route != nil)
+}
+```
+We choose this approach so MapLibreSwiftUI is not depdending on maplibre-navigation as most users don't need it.
+
 ## Developer Quick Start
 
 This project uses [`swiftformat`](https://github.com/nicklockwood/SwiftFormat) to automatically handle basic swift formatting

Sources/MapLibreSwiftUI/Examples/Gestures.swift

@@ -18,15 +18,15 @@ import SwiftUI
             .iconColor(.white)
     }
     .onTapMapGesture(on: [tappableID], onTapChanged: { _, features in
-        print("Tapped on \(features.first)")
+        print("Tapped on \(features.first?.description ?? "<nil>")")
     })
     .ignoresSafeArea(.all)
 }
 
 #Preview("Tappable Countries") {
     MapView(styleURL: demoTilesURL)
         .onTapMapGesture(on: ["countries-fill"], onTapChanged: { _, features in
-            print("Tapped on \(features.first)")
+            print("Tapped on \(features.first?.description ?? "<nil>")")
         })
         .ignoresSafeArea(.all)
 }

Sources/MapLibreSwiftUI/Examples/Layers.swift

@@ -124,7 +124,7 @@ let clustered = ShapeSource(identifier: "points", options: [.clustered: true, .c
             .predicate(NSPredicate(format: "cluster != YES"))
     }
     .onTapMapGesture(on: ["simple-circles-non-clusters"], onTapChanged: { _, features in
-        print("Tapped on \(features.first)")
+        print("Tapped on \(features.first?.debugDescription ?? "<nil>")")
     })
     .expandClustersOnTapping(clusteredLayers: [ClusterLayer(
         layerIdentifier: "simple-circles-clusters",

Sources/MapLibreSwiftUI/Examples/Other.swift

@@ -27,11 +27,11 @@ import SwiftUI
         SymbolStyleLayer(identifier: "simple-symbols", source: pointSource)
             .iconImage(UIImage(systemName: "mappin")!)
     }
-    .unsafeMapViewModifier { mapView in
+    .unsafeMapViewControllerModifier { viewController in
         // Not all properties have modifiers yet. Until they do, you can use this 'escape hatch' to the underlying
         // MLNMapView. Be careful: if you modify properties that the DSL controls already, they may be overridden. This
         // modifier is a "hack", not a final function.
-        mapView.logoView.isHidden = false
-        mapView.compassViewPosition = .topLeft
+        viewController.mapView.logoView.isHidden = false
+        viewController.mapView.compassViewPosition = .topLeft
     }
 }

Sources/MapLibreSwiftUI/Examples/Preview Helpers.swift

@@ -2,5 +2,4 @@
 import CoreLocation
 
 let switzerland = CLLocationCoordinate2D(latitude: 47.03041, longitude: 8.29470)
-let demoTilesURL =
-    URL(string: "https://demotiles.maplibre.org/style.json")!
+public let demoTilesURL = URL(string: "https://demotiles.maplibre.org/style.json")!

Sources/MapLibreSwiftUI/Extensions/MapLibre/MLNMapViewCameraUpdating.swift

@@ -5,7 +5,7 @@ import Mockable
 
 // NOTE: We should eventually mark the entire protocol @MainActor, but Mockable generates some unsafe code at the moment
 @Mockable
-protocol MLNMapViewCameraUpdating: AnyObject {
+public protocol MLNMapViewCameraUpdating: AnyObject {
     @MainActor var userTrackingMode: MLNUserTrackingMode { get set }
     @MainActor var minimumPitch: CGFloat { get set }
     @MainActor var maximumPitch: CGFloat { get set }

Sources/MapLibreSwiftUI/Extensions/UIKit/UIGestureRecognizing.swift

@@ -2,7 +2,7 @@ import Mockable
 import UIKit
 
 @Mockable
-protocol UIGestureRecognizing: AnyObject {
+public protocol UIGestureRecognizing: AnyObject {
     @MainActor var state: UIGestureRecognizer.State { get }
     @MainActor func location(in view: UIView?) -> CGPoint
     @MainActor func location(ofTouch touchIndex: Int, in view: UIView?) -> CGPoint