Add waypoint handling

Cartfile

@@ -1,5 +1,5 @@
 binary "https://www.mapbox.com/ios-sdk/Mapbox-iOS-SDK.json" ~> 3.5
-github "mapbox/MapboxDirections.swift" ~> 0.9.0
+github "mapbox/MapboxDirections.swift" "d18561afc477bdd6e844020725c8b9eadf0ffd12"
 github "52inc/Pulley" ~> 1.3.1
 github "rs/SDWebImage" ~> 4.0
 github "Project-OSRM/osrm-text-instructions.swift" ~> 0.1.2

Cartfile.resolved

@@ -3,6 +3,6 @@ github "52inc/Pulley" "1.4"
 github "Project-OSRM/osrm-text-instructions.swift" "v0.1.2"
 github "facebook/ios-snapshot-test-case" "2.1.4"
 github "frederoni/aws-sdk-ios" "40c7d5d60e0b80d70cd1502ef0cf8507f023f8d5"
-github "mapbox/MapboxDirections.swift" "v0.9.1"
+github "mapbox/MapboxDirections.swift" "d18561afc477bdd6e844020725c8b9eadf0ffd12"
 github "raphaelmor/Polyline" "v4.1.1"
 github "rs/SDWebImage" "4.0.0"

Examples/Swift/Base.lproj/Main.storyboard

@@ -56,6 +56,24 @@
                                         <nil key="textColor"/>
                                         <nil key="highlightedColor"/>
                                     </label>
+                                    <button hidden="YES" opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="oWT-TG-jZs">
+                                        <rect key="frame" x="0.0" y="623" width="375" height="44"/>
+                                        <color key="backgroundColor" white="1" alpha="0.60000002379999995" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
+                                        <constraints>
+                                            <constraint firstAttribute="height" constant="44" id="MXR-Fb-48J"/>
+                                        </constraints>
+                                        <state key="normal" title="Get Route"/>
+                                        <connections>
+                                            <action selector="didTapGetRoute:" destination="BYZ-38-t0r" eventType="touchUpInside" id="ffn-fF-Lba"/>
+                                        </connections>
+                                    </button>
+                                    <button hidden="YES" opaque="NO" contentMode="scaleToFill" contentHorizontalAlignment="center" contentVerticalAlignment="center" buttonType="roundedRect" lineBreakMode="middleTruncation" translatesAutoresizingMaskIntoConstraints="NO" id="p1Q-wj-seE">
+                                        <rect key="frame" x="8" y="565" width="70" height="30"/>
+                                        <state key="normal" title="Clear map"/>
+                                        <connections>
+                                            <action selector="didTapClearmap:" destination="BYZ-38-t0r" eventType="touchUpInside" id="YbJ-3h-xu2"/>
+                                        </connections>
+                                    </button>
                                 </subviews>
                                 <color key="backgroundColor" white="1" alpha="1" colorSpace="calibratedWhite"/>
                                 <gestureRecognizers/>
@@ -64,8 +82,13 @@
                                     <constraint firstAttribute="bottom" secondItem="8Sl-bV-xyU" secondAttribute="bottom" id="LOb-l9-Iql"/>
                                     <constraint firstItem="8Sl-bV-xyU" firstAttribute="width" secondItem="A3N-JT-loC" secondAttribute="width" multiplier="1:2" id="Pds-uP-zSB"/>
                                     <constraint firstAttribute="trailing" secondItem="KIU-cH-IXd" secondAttribute="trailing" id="Q7E-HM-WIz"/>
+                                    <constraint firstItem="oWT-TG-jZs" firstAttribute="top" secondItem="p1Q-wj-seE" secondAttribute="bottom" constant="28" id="SbN-yI-sn0"/>
+                                    <constraint firstAttribute="trailing" secondItem="oWT-TG-jZs" secondAttribute="trailing" id="TC4-VU-ggG"/>
                                     <constraint firstAttribute="bottom" secondItem="KIU-cH-IXd" secondAttribute="bottom" id="TjN-pb-n3K"/>
+                                    <constraint firstItem="p1Q-wj-seE" firstAttribute="leading" secondItem="A3N-JT-loC" secondAttribute="leading" constant="8" id="djs-kC-Hft"/>
                                     <constraint firstItem="8Sl-bV-xyU" firstAttribute="leading" secondItem="A3N-JT-loC" secondAttribute="leading" id="dsN-v1-DQf"/>
+                                    <constraint firstAttribute="bottom" secondItem="oWT-TG-jZs" secondAttribute="bottom" id="e7k-3v-zuf"/>
+                                    <constraint firstItem="oWT-TG-jZs" firstAttribute="leading" secondItem="A3N-JT-loC" secondAttribute="leading" id="gH1-mU-Ajg"/>
                                     <constraint firstItem="KIU-cH-IXd" firstAttribute="leading" secondItem="8Sl-bV-xyU" secondAttribute="trailing" id="q92-IP-Nlc"/>
                                     <constraint firstAttribute="trailing" secondItem="Hk0-SM-2Wl" secondAttribute="trailing" id="qaa-r0-NSw"/>
                                     <constraint firstItem="Hk0-SM-2Wl" firstAttribute="leading" secondItem="A3N-JT-loC" secondAttribute="leading" id="vRW-UT-mQD"/>
@@ -98,6 +121,8 @@
                         </constraints>
                     </view>
                     <connections>
+                        <outlet property="clearMapButton" destination="p1Q-wj-seE" id="ULz-0n-Sys"/>
+                        <outlet property="getRouteButton" destination="oWT-TG-jZs" id="b4W-Xb-oB7"/>
                         <outlet property="howToBeginLabel" destination="Hk0-SM-2Wl" id="iU7-G1-DBc"/>
                         <outlet property="mapView" destination="A3N-JT-loC" id="iZS-hq-X5f"/>
                         <outlet property="simulateNavigationButton" destination="KIU-cH-IXd" id="Bdk-oG-55B"/>

Examples/Swift/ViewController.swift

@@ -9,15 +9,16 @@ let layerIdentifier = "layerIdentifier"
 
 class ViewController: UIViewController, MGLMapViewDelegate, NavigationViewControllerDelegate, NavigationMapViewDelegate {
 
-    var destination: MGLPointAnnotation?
     var navigation: RouteController?
     var userRoute: Route?
+    var waypoints: [Waypoint] = []
 
     @IBOutlet weak var mapView: NavigationMapView!
     @IBOutlet weak var startNavigationButton: UIButton!
     @IBOutlet weak var simulateNavigationButton: UIButton!
     @IBOutlet weak var howToBeginLabel: UILabel!
-
+    @IBOutlet weak var getRouteButton: UIButton!
+    @IBOutlet weak var clearMapButton: UIButton!
 
     override func viewDidLoad() {
         super.viewDidLoad()
@@ -41,21 +42,42 @@ class ViewController: UIViewController, MGLMapViewDelegate, NavigationViewContro
             return
         }
 
-        if let destination = destination {
-            mapView.removeAnnotation(destination)
-        }
+        let coordinates = mapView.convert(sender.location(in: mapView), toCoordinateFrom: mapView)
 
-        destination = MGLPointAnnotation()
-        destination?.coordinate = mapView.convert(sender.location(in: mapView), toCoordinateFrom: mapView)
-        mapView.addAnnotation(destination!)
+        howToBeginLabel.isHidden = true
+        getRouteButton.isHidden = false
+        clearMapButton.isHidden = false
 
-        getRoute()
+        let annotation = MGLPointAnnotation()
+        annotation.coordinate = coordinates
+        mapView.addAnnotation(annotation)
+
+        let waypoint = Waypoint(coordinate: coordinates)
+        waypoint.coordinateAccuracy = -1
+        waypoints.append(waypoint)
     }
 
     @IBAction func didTapStartNavigation(_ sender: Any) {
         startNavigation(along: userRoute!)
     }
 
+    @IBAction func didTapClearmap(_ sender: Any) {
+        mapView.removeAnnotations(mapView.annotations ?? [])
+
+        startNavigationButton.isHidden = true
+        simulateNavigationButton.isHidden = true
+        getRouteButton.isHidden = true
+        clearMapButton.isHidden = true
+        howToBeginLabel.isHidden = false
+
+        waypoints.removeAll()
+        mapView.removeRoute()
+    }
+
+    @IBAction func didTapGetRoute(_ sender: Any) {
+        getRoute()
+    }
+
     @IBAction func didTapSimulateNavigation(_ sender: Any) {
         startNavigation(along: userRoute!, simulatesLocationUpdates: true)
     }
@@ -104,26 +126,31 @@ class ViewController: UIViewController, MGLMapViewDelegate, NavigationViewContro
     }
 
     func getRoute(didFinish: (()->())? = nil) {
-        guard let destination = destination else { return }
+
+        let userWaypoint = Waypoint(location: mapView.userLocation!.location!, heading: mapView.userLocation?.heading, name: "user")
+        userWaypoint.coordinateAccuracy = -1
+        waypoints.insert(userWaypoint, at: 0)
 
-        let options = RouteOptions(coordinates: [mapView.userLocation!.coordinate, destination.coordinate])
+        let options = RouteOptions(waypoints: waypoints)
         options.includesSteps = true
         options.routeShapeResolution = .full
         options.profileIdentifier = .automobileAvoidingTraffic
 
         _ = 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 {
+                print("No routes")
                 return
             }
 
             self?.userRoute = route
             self?.startNavigationButton.isHidden = false
             self?.simulateNavigationButton.isHidden = false
             self?.howToBeginLabel.isHidden = true
+            self?.getRouteButton.isHidden = true
 
             // Open method for adding and updating the route line
             self?.mapView.showRoute(route)
@@ -252,7 +279,7 @@ class ViewController: UIViewController, MGLMapViewDelegate, NavigationViewContro
         return line
     }
 
-    func navigationViewController(_ navigationViewController: NavigationViewController, didArriveAt destination: MGLAnnotation) {
-        print("User arrived at \(destination)")
+    func navigationViewController(_ navigationViewController: NavigationViewController, didArriveAt destination: Waypoint) {
+        print("User arrived at \(destination.name ?? "waypoint")")
     }
 }

MapboxCoreNavigation/RouteController.swift

@@ -150,7 +150,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 {
             // Don't advance nor check progress if the user has arrived at their destination
             suspendLocationUpdates()
             NotificationCenter.default.post(name: RouteControllerProgressDidChange, object: self, userInfo: [
@@ -257,7 +258,9 @@ extension RouteController: CLLocationManagerDelegate {
         }
 
         if routeProgress.currentLegProgress.alertUserLevel != newlyCalculatedAlertLevel {
+
             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)
@@ -266,6 +269,12 @@ extension RouteController: CLLocationManagerDelegate {
                 RouteControllerAlertLevelDidChangeNotificationRouteProgressKey: routeProgress,
                 RouteControllerAlertLevelDidChangeNotificationDistanceToEndOfManeuverKey: userDistance
                 ])
+
+            if routeProgress.currentLegProgress.alertUserLevel == .arrive,
+                routeProgress.remainingWaypoints.count > 1 {
+                routeProgress.legIndex += 1
+                routeProgress.currentLegProgress.alertUserLevel = .depart
+            }
         }
     }
 
@@ -285,7 +294,6 @@ extension RouteController: CLLocationManagerDelegate {
         routeTask?.cancel()
 
         let options = routeProgress.route.routeOptions
-
         options.waypoints = [Waypoint(coordinate: location.coordinate)] + routeProgress.remainingWaypoints
 
         if let firstWaypoint = options.waypoints.first, location.course >= 0 {

MapboxCoreNavigation/RouteProgress.swift

@@ -63,7 +63,6 @@ open class RouteProgress: NSObject {
         }
     }
 
-
     /**
      If waypoints are provided in the `Route`, this will contain which leg the user is on.
      */
@@ -108,7 +107,6 @@ open class RouteProgress: NSObject {
     }
 
     public var currentLegProgress: RouteLegProgress!
-
 
     public init(route: Route, legIndex: Int = 0) {
         self.route = route

MapboxNavigation.xcodeproj/project.pbxproj

@@ -31,7 +31,6 @@
 		351BEC061E5BCC6C006FE110 /* ManeuverDirection.swift in Sources */ = {isa = PBXBuildFile; fileRef = 351BEC041E5BCC6C006FE110 /* ManeuverDirection.swift */; };
 		351BEC0D1E5BCC72006FE110 /* Bundle.swift in Sources */ = {isa = PBXBuildFile; fileRef = 351BEC081E5BCC72006FE110 /* Bundle.swift */; };
 		351BEC0E1E5BCC72006FE110 /* DashedLineView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 351BEC091E5BCC72006FE110 /* DashedLineView.swift */; };
-		351BEC0F1E5BCC72006FE110 /* Directions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 351BEC0A1E5BCC72006FE110 /* Directions.swift */; };
 		351BEC101E5BCC72006FE110 /* DistanceFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 351BEC0B1E5BCC72006FE110 /* DistanceFormatter.swift */; };
 		351BEC291E5BD530006FE110 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 351BEC281E5BD530006FE110 /* Assets.xcassets */; };
 		351BEC2B1E5BD538006FE110 /* Shields.plist in Resources */ = {isa = PBXBuildFile; fileRef = 351BEC2A1E5BD538006FE110 /* Shields.plist */; };
@@ -267,7 +266,6 @@
 		351BEC041E5BCC6C006FE110 /* ManeuverDirection.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ManeuverDirection.swift; sourceTree = "<group>"; };
 		351BEC081E5BCC72006FE110 /* Bundle.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Bundle.swift; sourceTree = "<group>"; };
 		351BEC091E5BCC72006FE110 /* DashedLineView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DashedLineView.swift; sourceTree = "<group>"; };
-		351BEC0A1E5BCC72006FE110 /* Directions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Directions.swift; sourceTree = "<group>"; };
 		351BEC0B1E5BCC72006FE110 /* DistanceFormatter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DistanceFormatter.swift; sourceTree = "<group>"; };
 		351BEC281E5BD530006FE110 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Resources/Assets.xcassets; sourceTree = "<group>"; };
 		351BEC2A1E5BD538006FE110 /* Shields.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Shields.plist; path = Resources/Shields.plist; sourceTree = "<group>"; };
@@ -584,7 +582,6 @@
 			children = (
 				C5000A921EC25C6E00563EA9 /* Abbreviations.swift */,
 				351BEC081E5BCC72006FE110 /* Bundle.swift */,
-				351BEC0A1E5BCC72006FE110 /* Directions.swift */,
 				C55CEB271EB7E4240065D7D9 /* Locale.swift */,
 				351BEC041E5BCC6C006FE110 /* ManeuverDirection.swift */,
 				351BEBDF1E5BCC63006FE110 /* MGLMapView.swift */,
@@ -1098,7 +1095,6 @@
 				C5000A931EC25C6E00563EA9 /* Abbreviations.swift in Sources */,
 				35C9973F1E732C1B00544D1C /* RouteVoiceController.swift in Sources */,
 				351BEBFC1E5BCC63006FE110 /* NavigationViewController.swift in Sources */,
-				351BEC0F1E5BCC72006FE110 /* Directions.swift in Sources */,
 				35C997411E732C5400544D1C /* RouteStepFormatter.swift in Sources */,
 				351BEBFB1E5BCC63006FE110 /* RouteTableViewHeaderView.swift in Sources */,
 				35EC316D1EA64057004280F5 /* SimulatedRoute.swift in Sources */,