Navigation | Mobile SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro
CityLens
Account

Navigation

Turn-by-turn navigation

You can add a turn-by-turn navigation to your app using the ready-to-use interface components (INavigationView) and the NavigationManager class.

To do that, add a My location marker to the map and create a navigation layer using INavigationViewFactory and NavigationManager.

// Create a map object.
guard let mapFactory = try? sdk.makeMapFactory(options: .default) else {
    return
}

// Add the map view to the view hierarchy.
let mapView = mapFactory.mapView
mapView.translatesAutoresizingMaskIntoConstraints = false
containerView.addSubview(mapView)
NSLayoutConstraint.activate([
    mapView.leftAnchor.constraint(equalTo: containerView.leftAnchor),
    mapView.rightAnchor.constraint(equalTo: containerView.rightAnchor),
    mapView.topAnchor.constraint(equalTo: containerView.topAnchor),
    mapView.bottomAnchor.constraint(equalTo: containerView.bottomAnchor)
])

// Add the current location marker to the map.
let locationSource = MyLocationMapObjectSource(
    context: sdk.context,
    directionBehaviour: .followSatelliteHeading,
    controller: createSmoothMyLocationController()
)
let map = mapFactory.map
map.addSource(source: locationSource)

// Create a NavigationManager object.
let navigationManager = NavigationManager(platformContext: sdk.context)

// Attach the map to the NavigationManager.
navigationManager.mapManager.addMap(map: map)

// Create a NavigationViewFactory object.
let navigationViewFactory = sdk.makeNavigationViewFactory()

// Create a navigation view and add it to the view hierarchy above the map.
let navigationView = navigationViewFactory.makeNavigationView(
    map: map,
    navigationManager: navigationManager
)
navigationView.translatesAutoresizingMaskIntoConstraints = false
containerView.addSubview(navigationView)
NSLayoutConstraint.activate([
    navigationView.leftAnchor.constraint(equalTo: containerView.leftAnchor),
    navigationView.rightAnchor.constraint(equalTo: containerView.rightAnchor),
    navigationView.topAnchor.constraint(equalTo: containerView.topAnchor),
    navigationView.bottomAnchor.constraint(equalTo: containerView.bottomAnchor)
])

// Add an event handler for the close button.
navigationView.closeButtonCallback = { [weak navigationManager] in
    navigationManager?.stop()
}

You can start navigation in one of three modes: free-drive, turn-by-turn, and the simulated navigation mode.

Additional navigation settings can be changed using the properties of the NavigationManager object.

Free-drive mode

In free-drive mode, no route will be displayed on the map, but the user will still be informed about speed limits, traffic cameras, incidents, and road closures.

To start navigation in this mode, call the start() method without arguments.

navigationManager.start()

Turn-by-turn mode

In turn-by-turn mode, a route will be displayed on the map and the user will receive navigation instructions as they move along the route.

To start navigation in this mode, call the start() method and specify a RouteBuildOptions object - arrival coordinates and route settings.

let routeBuildOptions = RouteBuildOptions(
    finishPoint: RouteSearchPoint(
        coordinates: GeoPoint(
            latitude: 55.752425,
            longitude: 37.613983
        )
    ),
    routeSearchOptions: routeSearchOptions
)

navigationManager.start(routeBuildOptions)

Additionally, when calling the start() method, you can specify a TrafficRoute object - a complete route object for navigation. In this case, NavigationManager will use the specified route instead of building a new one.

// Building a route.
self.routeSearchCancellable = routesFuture.sink { routes in
    guard let route = routes.first else { return }

    // Route settings.
    let routeBuildOptions = RouteBuildOptions(
        finishPoint: finishPoint,
        routeSearchOptions: routeSearchOptions
    )
    // Start navigation.
    navigationManager.start(
        routeBuildOptions: routeBuildOptions,
        trafficRoute: route
    )
} failure: { error in
    print("Couldn't build the route: \\(error)")
}

Simulated navigation

In this mode, NavigationManager will not track the current location of the device. Instead, it will simulate a movement along the specified route.

This mode is useful for debugging.

To use this mode, call the startSimulation() method and specify a RouteBuildOptions object (route settings) and a TrafficRoute object (the route itself).

You can change the speed of the simulated movement using the SimulationSettings.speed property (specified in meters per second).

navigationManager.simulationSettings.speed = 30 / 3.6
navigationManager.startSimulation(
    routeBuildOptions: routeBuildOptions,
    trafficRoute: route
)

To stop the simulation, call the stop() method.

navigationManager.stop()

Indoor navigation

  

The SDK provides the ability to build routes within certain buildings for which there are floor plans. For example, you can build a route to a specific store in a mall, make a complex route between several points, etc.

This type of navigation is included in the Full SDK, but has a number of limitations:

  • Can only be activated in pedestrian navigation mode
  • Due to the way modern positioning systems work, the ability to determine the position inside buildings is severely limited. When the system determines that the device has entered the limits of the building, the geopositioning tracking and its display will be disabled, leaving the constructed route and recommendations for the passage. We are working to overcome these challenges and hope to provide a reliable way to determine the location inside buildings in the future.

Creating a route

Creating a route follows the principles described in Turn-by-turn mode with a few important additions. Let's take an example:

// RouteBuildOptions object is also required
let routeBuildOptions = RouteBuildOptions(
    finishPoint: RouteSearchPoint(
        coordinates: GeoPoint(latitude: 55.752425, longitude: 37.613983),
        objectId: ..., // // You can get it from DgisMapObject
        levelId : ..., // You can get it from DirectoryObject or RenderedObjectInfo
    ),
    // routeSearchOptions must be of type PedestrianRouteSearchOptions
    routeSearchOptions: PedestrianRouteSearchOptions()
)

As you can see, the objectId and levelId parameters are mandatory when creating a route endpoint RouteSearchPoint

Displaying

If you use a standard set of navigation UI controllers by creating a standard INavigationViewControlsFactory as recommended in beginning of section, this feature is already available and does not require any pre-configuration.

When using your own controllers in the UI, you can use the standard SDK features to detect when entering the indoor navigation mode, namely subscribing to [indoorChannel](/en/ios/sdk/reference/7.0/IndoorDetector#nav-lvl1--var indoorChannel). This channel can be obtained from [NavigationManager](/en/ios/sdk/reference/7.0/NavigationManager#nav-lvl1--var indoorDetector)