Route generation

The routes used in the Navigation SDK are generated by the Mapbox Directions API. When you install the Navigation SDK, it also includes MapboxDirections.swift, which provides a convenient way to access the Mapbox Directions API in iOS applications.

To generate a route, you'll create a new Route object using MapboxDirections.swift. In most cases, you'll also use the NavigationRouteOptions class (a subclass of MapboxDirections.swift's RouteOptions class) to set a few options. You can specify any of the same options you could using the RouteOptions class found in MapboxDirections.swift, but the defaults in NavigationRouteOptions are better suited to how the Navigation SDK uses the resulting route.

Below are examples of how you can use specific options to generate routes for a few scenarios.

Request a route in a specific direction

With the Navigation SDK, you can consider the direction a user’s device is facing and request a route starting in a specific direction. To receive a route in a specific direction (for example, the direction a user is traveling or the direction a device is facing), pass in the user’s location heading value. This property corresponds to the angles in the bearings query parameter in the Mapbox Directions and Map Matching APIs.

Waypoint: In the adjacent diagram, the blue dot with white stroke is the device location. Imagine this is the first (origin) Waypoint in a Directions API request.

Heading: The Waypoint.heading can be used to influence the direction in which a route leg should begin. The heading value is the angle clockwise from true north between 0 and 359. For example, when the heading value is 0, the heading direction is due north. In the adjacent diagram, the pink arrow is the direction that the device is the heading (which is due west or 270°). Read about Waypoint.heading in more detail.

Heading accuracy: The Waypoint.headingAccuracy is the range of degrees by which a route can deviate from the Waypoint.heading angle and still be recommended. The semi-transparent blue area illustrates headingAccuracy. In this example headingAccuracy is 90° (45° in either direction from the heading angle). Read about Waypoint.headingAccuracy in more detail.

Default heading

The default value for heading is −1°, which means that the heading will not be taken into account when calculating a route.

Consider the direction a device is facing

To request a route that starts in the direction that the device is facing, set Waypoint.heading to use CLHeading.trueHeading. This may be appropriate when requesting a route with the user's location as the origin before the user has started moving or for walking directions.

You can also set a Waypoint.headingAccuracy to specify the range of degrees by which a route can deviate from the Waypoint.heading angle. Though Waypoint.headingAccuracy and CLHeading.headingAccuracy have similar names, it is not appropriate to pass in the current CLHeading.headingAccuracy. CLHeading.headingAccuracy tends to result in too-strict route requests.

This can also be applied to any waypoint including the origin and any stops along the route.

let userWaypoint = Waypoint(location: mapView?.userLocation!.location, heading: CLHeading.trueHeading, headingAccuracy: 90)

Consider the direction a user is already traveling

If you need to request a route that's continuing along the path that the user is traveling, set the Waypoint.heading to use CLLocation.course. This may be appropriate for driving directions. Consider that the phone may be in a center cup holder, facing the driver rather than the rear-view mirror, as the car moves in a forward direction. You can also set a custom Waypoint.headingAccuracy.

This can be applied to any waypoint including the origin, stops along the route, and the destination.

let userWaypoint = Waypoint(location: mapView?.userLocation!.location, heading: CLLocation.course, headingAccuracy: 90)

Specify a side of the road to approach

By default, routes generated will approach waypoints on either side of road. You can override the default by setting Waypoint.allowsArrivingOnOppositeSide to false. This will require that the route has the driver approach the waypoint on the same side of the road the waypoint is on. allowsArrivingOnOppositeSide corresponds to the approaches query parameter in the Mapbox Directions and Map Matching APIs.

let userWaypoint = Waypoint(location: mapView?.userLocation!.location, allowsArrivingOnOppositeSide: false)

Include multiple stops

The Mapbox Directions API requires at least two waypoints to generate a route. If your route involves several pick-up and drop-off points, you can add up to 25 coordinates (including the origin and destination) using the driving profile or three coordinates using the driving-traffic profile. These coordinates are treated as stops in between the origin and destination in the order that you add them — the first waypoint is the origin and the second waypoint is the first stop:

let waypointOne = Waypoint(coordinate: CLLocationCoordinate2DMake(37.77766, -122.43199))
let waypointTwo = Waypoint(coordinate: CLLocationCoordinate2DMake(37.77609, -122.43292))
let waypointThree = Waypoint(coordinate: CLLocationCoordinate2DMake(37.77536, -122.43494))

let options = NavigationRouteOptions(waypoints: [waypointOne, waypointTwo, waypointThree])

Directions.shared.calculate(options) { (waypoints, routes, error) in
    guard let route = routes?.first, error == nil else {
        print(error!.localizedDescription)
        return
    }

    let navigationService = MapboxNavigationService(route: route, simulating: simulationIsEnabled ? .onPoorGPS)
    let navigationOptions = NavigationOptions(navigationService: navigationService)
    let navigationViewController = NavigationViewController(for: route, options: navigationOptions)
    navigationViewController.delegate = self

    self.present(navigationViewController, animated: true, completion: nil)
}

Silent waypoints

The Waypoint.separatesLegs property determines if a waypoint will be treated as a stop between legs or influence the route without specifically mentioning it in maneuver instructions.

By default Waypoint.separatesLegs is equal to true meaning the waypoint will appear in the resulting routes as a waypoint separating two legs, along with corresponding guidance instructions.

If you want to make sure that the route you request passes through the waypoint without specifically mentioning it, set Waypoint.separatesLegs equal to false.

Optimized routes

If you want to generate a route that will arrive at the waypoints in the fastest order (not necessarily in a specific order), see the Optimization API documentation.

More about route generation

  • Localization: Customize the language and units of measurement returned for both text and voice instructions or use the language preferences set on the device.
  • Offline routing: Provide routing functionality from the Navigation SDK in non-connected environments.
Was this page helpful?