Add waypoint handling

Examples/Swift/Base.lproj/Main.storyboard

@@ -106,8 +106,20 @@
                             <constraint firstAttribute="trailing" secondItem="Tfo-Ic-OqD" secondAttribute="trailing" constant="16" id="veQ-GA-9Zk"/>
                         </constraints>
                     </view>
-                    <navigationItem key="navigationItem" title="Mapbox Navigation" id="zxr-0T-HBr"/>
+                    <navigationItem key="navigationItem" title="Mapbox Navigation" id="zxr-0T-HBr">
+                        <barButtonItem key="leftBarButtonItem" style="plain" id="XbQ-fY-lUb">
+                            <button key="customView" hidden="YES" opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" id="6ux-mK-LQF">
+                                <rect key="frame" x="16" y="7" width="83" height="30"/>
+                                <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/>
+                                <state key="normal" title="Clear map"/>
+                                <connections>
+                                    <action selector="clearMapPressed:" destination="BYZ-38-t0r" eventType="touchUpInside" id="SHt-XT-eUM"/>
+                                </connections>
+                            </button>
+                        </barButtonItem>
+                    </navigationItem>
                     <connections>
+                        <outlet property="clearMap" destination="6ux-mK-LQF" id="9M7-CK-q1M"/>
                         <outlet property="longPressHintView" destination="Tfo-Ic-OqD" id="gYu-YW-6FX"/>
                         <outlet property="mapView" destination="A3N-JT-loC" id="iZS-hq-X5f"/>
                         <outlet property="simulationButton" destination="iiq-Gf-SKY" id="DHR-zB-Mwv"/>

Examples/Swift/ViewController.swift

@@ -16,7 +16,7 @@ enum ExampleMode {
 
 class ViewController: UIViewController, MGLMapViewDelegate {
 
-    var destination: MGLPointAnnotation?
+    var waypoints: [Waypoint] = []
     var currentRoute: Route? {
         didSet {
             self.startButton.isEnabled = currentRoute != nil
@@ -29,15 +29,16 @@ class ViewController: UIViewController, MGLMapViewDelegate {
     @IBOutlet weak var simulationButton: UIButton!
     @IBOutlet weak var startButton: UIButton!
 
+    @IBOutlet weak var clearMap: UIButton!
+
     var exampleMode: ExampleMode?
-    var nextWaypoint: CLLocationCoordinate2D?
 
     override func viewDidLoad() {
         super.viewDidLoad()
 
         automaticallyAdjustsScrollViewInsets = false
         mapView.delegate = self
-        
+
         mapView.userTrackingMode = .follow
 
         simulationButton.isSelected = true
@@ -56,15 +57,27 @@ class ViewController: UIViewController, MGLMapViewDelegate {
             return
         }
 
-        if let destination = destination {
-            mapView.removeAnnotation(destination)
+        clearMap.isHidden = false
+
+        if let annotation = mapView.annotations?.last, waypoints.count > 2 {
+            mapView.removeAnnotation(annotation)
+        }
+
+        if waypoints.count > 1 {
+            waypoints = Array(waypoints.suffix(1))
         }
 
+        let coordinates = mapView.convert(sender.location(in: mapView), toCoordinateFrom: mapView)
+
+        let annotation = MGLPointAnnotation()
+        annotation.coordinate = coordinates
+        mapView.addAnnotation(annotation)
+
         longPressHintView.isHidden = true
 
-        destination = MGLPointAnnotation()
-        destination?.coordinate = mapView.convert(sender.location(in: mapView), toCoordinateFrom: mapView)
-        mapView.addAnnotation(destination!)
+        let waypoint = Waypoint(coordinate: coordinates)
+        waypoint.coordinateAccuracy = -1
+        waypoints.append(waypoint)
 
         requestRoute()
     }
@@ -86,6 +99,13 @@ class ViewController: UIViewController, MGLMapViewDelegate {
         simulationButton.isSelected = !simulationButton.isSelected
     }
 
+    @IBAction func clearMapPressed(_ sender: Any) {
+        clearMap.isHidden = true
+        mapView.removeRoute()
+        mapView.removeAnnotations(mapView.annotations ?? [])
+        waypoints.removeAll()
+    }
+
     @IBAction func startButtonPressed(_ sender: Any) {
         let alertController = UIAlertController(title: "Start Navigation", message: "Select the navigation type", preferredStyle: .actionSheet)
         alertController.addAction(UIAlertAction(title: "Default UI", style: .default, handler: { (action) in
@@ -97,9 +117,11 @@ class ViewController: UIViewController, MGLMapViewDelegate {
         alertController.addAction(UIAlertAction(title: "Styled UI", style: .default, handler: { (action) in
             self.startStyledNavigation()
         }))
-        alertController.addAction(UIAlertAction(title: "Multiple Stops", style: .default, handler: { (action) in
-            self.startMultipleWaypoints()
-        }))
+        if self.waypoints.count > 2 {
+            alertController.addAction(UIAlertAction(title: "Multiple Stops", style: .default, handler: { (action) in
+                self.startMultipleWaypoints()
+            }))
+        }
         alertController.addAction(UIAlertAction(title: "Cancel", style: .cancel, handler: nil))
         DispatchQueue.main.async {
             self.present(alertController, animated: true, completion: nil)
@@ -108,12 +130,13 @@ class ViewController: UIViewController, MGLMapViewDelegate {
 
     // Helper for requesting a route
     func requestRoute() {
-        guard let destination = destination else { return }
+        guard waypoints.count > 0 else { return }
 
-        let options = RouteOptions(coordinates: [
-            mapView.userLocation!.coordinate,
-            destination.coordinate,
-        ])
+        let userWaypoint = Waypoint(location: mapView.userLocation!.location!, heading: mapView.userLocation?.heading, name: "user")
+        userWaypoint.coordinateAccuracy = -1
+        waypoints.insert(userWaypoint, at: 0)
+
+        let options = RouteOptions(waypoints: waypoints)
         options.includesSteps = true
         options.routeShapeResolution = .full
         options.profileIdentifier = .automobileAvoidingTraffic
@@ -123,7 +146,7 @@ class ViewController: UIViewController, MGLMapViewDelegate {
 
         _ = Directions.shared.calculate(options) { [weak self] (waypoints, routes, error) in
             guard error == nil else {
-                print(error!)
+                print(error!.localizedDescription)
                 return
             }
             guard let route = routes?.first else { return }
@@ -134,12 +157,12 @@ class ViewController: UIViewController, MGLMapViewDelegate {
             self?.mapView.showRoute(route)
         }
     }
-    
+
     // MARK: - Basic Navigation
-    
+
     func startBasicNavigation() {
         guard let route = currentRoute else { return }
-            
+
         exampleMode = .default
 
         let navigationViewController = NavigationViewController(for: route, locationManager: locationManager())
@@ -155,18 +178,17 @@ class ViewController: UIViewController, MGLMapViewDelegate {
         guard let route = self.currentRoute else { return }
 
         guard let customViewController = storyboard?.instantiateViewController(withIdentifier: "custom") as? CustomViewController else { return }
-            
+
         exampleMode = .custom
 
         customViewController.simulateLocation = simulationButton.isSelected
         customViewController.userRoute = route
-        customViewController.destination = destination
-
+
         present(customViewController, animated: true, completion: nil)
     }
-
-    // MARK: - Styling the default UI
 
+    // MARK: - Styling the default UI
+
     func startStyledNavigation() {
         guard let route = self.currentRoute else { return }
 
@@ -211,7 +233,7 @@ class ViewController: UIViewController, MGLMapViewDelegate {
 
         // Set a custom style URL
         navigationViewController.mapView?.styleURL = URL(string: "mapbox://styles/mapbox/navigation-guidance-day-v2")
-        
+
         present(navigationViewController, animated: true, completion: nil)
     }
 
@@ -226,67 +248,44 @@ class ViewController: UIViewController, MGLMapViewDelegate {
         guard let route = self.currentRoute else { return }
 
         exampleMode = .multipleWaypoints
-
-        // When the user arrives at their destination, we'll prompt them to return back to where they started
-        nextWaypoint = self.currentRoute?.coordinates?.first
-
+
         let navigationViewController = NavigationViewController(for: route, locationManager: locationManager())
         navigationViewController.navigationDelegate = self
 
         present(navigationViewController, animated: true, completion: nil)
     }
 
+    // By default, when the user arrives at a waypoint, the next leg starts immediately.
+    // If however you would like to pause and allow the user to provide input, set this delegate method to false.
+    // This does however require you to increment the leg count on your own. See the example below in `confirmationControllerDidConfirm()`.
+    func navigationViewController(_ navigationViewController: NavigationViewController, shouldIncrementLegWhenArrivingAtWaypoint waypoint: Waypoint) -> Bool {
+        return false
+    }
+}
+
+extension ViewController: WaypointConfirmationViewControllerDelegate {
+    func confirmationControllerDidConfirm(_ confirmationController: WaypointConfirmationViewController) {
+        confirmationController.dismiss(animated: true, completion: {
+            guard let navigationViewController = self.presentedViewController as? NavigationViewController else { return }
+
+            guard navigationViewController.routeController.routeProgress.route.legs.count > navigationViewController.routeController.routeProgress.legIndex + 1 else { return }
+            navigationViewController.routeController.routeProgress.legIndex += 1
+        })
+    }
 }
 
 extension ViewController: NavigationViewControllerDelegate {
-    func navigationViewController(_ navigationViewController: NavigationViewController, didArriveAt destination: MGLAnnotation) {
+    func navigationViewController(_ navigationViewController: NavigationViewController, didArriveAt waypoint: Waypoint) {
 
         // Multiple waypoint demo
-        guard exampleMode == .multipleWaypoints, nextWaypoint != nil else { return }
+        guard exampleMode == .multipleWaypoints else { return }
 
         // When the user arrives, present a view controller that prompts the user to continue to their next destination
         // This typ of screen could show information about a destination, pickup/dropoff confirmation, instructions upon arrival, etc.
         guard let confirmationController = self.storyboard?.instantiateViewController(withIdentifier: "waypointConfirmation") as? WaypointConfirmationViewController else { return }
-            
+
         confirmationController.delegate = self
 
         navigationViewController.present(confirmationController, animated: true, completion: nil)
     }
 }
-
-extension ViewController: WaypointConfirmationViewControllerDelegate {
-    func confirmationControllerDidConfirm(controller confirmationController: WaypointConfirmationViewController) {
-        guard let nextDestination = nextWaypoint else { return }
-        guard let navigationViewController = self.presentedViewController as? NavigationViewController else { return }
-
-        // Calculate directions to the next waypoint
-        let options = RouteOptions(coordinates: [
-            navigationViewController.mapView!.userLocation!.coordinate,
-            nextDestination,
-        ])
-        options.includesSteps = true
-        options.routeShapeResolution = .full
-        options.profileIdentifier = navigationViewController.route.routeOptions.profileIdentifier
-
-        // Adding the optional attribute `.congestionLevel` ensures the route line will show the congestion along the route line
-        options.attributeOptions = [.congestionLevel]
-
-        _ = Directions.shared.calculate(options) { [weak self] (waypoints, routes, error) in
-            guard error == nil else {
-                print(error!)
-                return
-            }
-            guard let route = routes?.first else { return }
-
-            // update the navigationViewController with the route to the next waypoint
-            navigationViewController.route = route
-
-            // Set the next waypoint to our start point
-            // We'll continue this waypoint loop until the user exits navigation
-            self?.nextWaypoint = route.coordinates?.first
-
-            // Dismiss the confirmation screen
-            confirmationController.dismiss(animated: true, completion: nil)
-        }
-    }
-}

Examples/Swift/WaypointConfirmationViewController.swift

@@ -1,14 +1,14 @@
 import UIKit
 
 protocol WaypointConfirmationViewControllerDelegate: NSObjectProtocol {
-    func confirmationControllerDidConfirm(controller: WaypointConfirmationViewController)
+    func confirmationControllerDidConfirm(_ controller: WaypointConfirmationViewController)
 }
 
 class WaypointConfirmationViewController: UIViewController {
 
     weak var delegate: WaypointConfirmationViewControllerDelegate?
 
     @IBAction func continueButtonPressed(_ sender: Any) {
-        delegate?.confirmationControllerDidConfirm(controller: self)
+        delegate?.confirmationControllerDidConfirm(self)
     }
 }

MapboxCoreNavigation/RouteController.swift

@@ -22,6 +22,9 @@ public protocol RouteControllerDelegate: class {
     @objc(routeController:shouldRerouteFromLocation:)
     optional func routeController(_ routeController: RouteController, shouldRerouteFrom location: CLLocation) -> Bool
 
+    @objc(routeController:shouldIncrementLegWhenArrivingAtWaypoint:)
+    optional func routeController(_ routeController: RouteController, shouldIncrementLegWhenArrivingAtWaypoint waypoint: Waypoint) -> Bool
+
     /**
      Called immediately before the route controller calculates a new route.
 
@@ -414,7 +417,8 @@ extension RouteController: CLLocationManagerDelegate {
         let userSnapToStepDistanceFromManeuver = distance(along: routeProgress.currentLegProgress.currentStep.coordinates!, from: location.coordinate)
         let secondsToEndOfStep = userSnapToStepDistanceFromManeuver / location.speed
 
-        guard routeProgress.currentLegProgress.alertUserLevel != .arrive else {
+        guard routeProgress.currentLegProgress.alertUserLevel != .arrive,
+            routeProgress.remainingWaypoints.count > 0 else {
             NotificationCenter.default.post(name: RouteControllerProgressDidChange, object: self, userInfo: [
                 RouteControllerProgressDidChangeNotificationProgressKey: routeProgress,
                 RouteControllerProgressDidChangeNotificationLocationKey: location,
@@ -532,6 +536,7 @@ extension RouteController: CLLocationManagerDelegate {
 
         if routeProgress.currentLegProgress.alertUserLevel != newlyCalculatedAlertLevel || updateStepIndex {
             routeProgress.currentLegProgress.alertUserLevel = newlyCalculatedAlertLevel
+
             // Use fresh user location distance to end of step
             // since the step could of changed
             let userDistance = distance(along: routeProgress.currentLegProgress.currentStep.coordinates!, from: location.coordinate)
@@ -540,6 +545,12 @@ extension RouteController: CLLocationManagerDelegate {
                 RouteControllerAlertLevelDidChangeNotificationRouteProgressKey: routeProgress,
                 RouteControllerAlertLevelDidChangeNotificationDistanceToEndOfManeuverKey: userDistance
                 ])
+
+            if routeProgress.currentLegProgress.alertUserLevel == .arrive,
+                routeProgress.remainingWaypoints.count > 1,
+                (delegate?.routeController?(self, shouldIncrementLegWhenArrivingAtWaypoint: routeProgress.currentLeg.destination) ?? true) {
+                routeProgress.legIndex += 1
+            }
         }
     }
 

MapboxCoreNavigation/RouteProgress.swift

@@ -62,6 +62,7 @@ open class RouteProgress: NSObject {
         didSet {
             assert(legIndex >= 0 && legIndex < route.legs.endIndex)
             // TODO: Set stepIndex to 0 or last index based on whether leg index was incremented or decremented.
+            currentLegProgress.alertUserLevel = .none
             currentLegProgress = RouteLegProgress(leg: currentLeg)
         }
     }