Navigation

SDK allows you to implement the following navigation scenarios:

• Start the navigator in various modes (free-drive, turn-by-turn, and simulated navigation), including indoor navigation mode.
• Configure the navigator to work with your custom geolocation source.
• Suggest alternative routes to a user along the way.
• Get dynamic route data during navigation.

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

To do that, first add a NavigationView and a DefaultNavigationControls to your MapView.

<ru.dgis.sdk.map.MapView
    android:id="@+id/mapView"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    >
    <ru.dgis.sdk.navigation.NavigationView
        android:id="@+id/navigationView"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        >
        <ru.dgis.sdk.navigation.DefaultNavigationControls
            android:layout_width="match_parent"
            android:layout_height="match_parent"/>
    </ru.dgis.sdk.navigation.NavigationView>
</ru.dgis.sdk.map.MapView>

Then, add a My location marker to the map and create a NavigationManager object.

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    sdkContext = DGis.initialize(applicationContext, apiKeys)

    // Register the geolocation source
    locationProvider = ManagerLocationSource(applicationContext)
    registerPlatformLocationSource(sdkContext, locationProvider)

    setContentView(R.layout.activity_navigation)

    findViewById<MapView>(R.id.mapView).apply { mapView ->
        lifecycle.addObserver(mapView)

        mapView.getMapAsync { map ->
            // Add a marker for the current location
            map.addSource(
                MyLocationMapObjectSource(
                    sdkContext,
                    MyLocationDirectionBehaviour.FOLLOW_SATELLITE_HEADING,
                    createSmoothMyLocationController()
                )
            )
        }
    }

    // Create a NavigationManager object
    navigationManager = NavigationManager(sdkContext)

    findViewById<NavigationView>(R.id.navigationView).apply {
        // Attach the created NavigationManager object to the NavigationView
        navigationManager = this@NavigationActivity.navigationManager
    }

    // Start navigation in a free-drive mode
    navigationManager.start()
}

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.

val routeBuildOptions = RouteBuildOptions(
    finishPoint = RouteSearchPoint(
        coordinates = GeoPoint(latitude = 55.752425, longitude = 37.613983)
    ),
    routeSearchOptions = CarRouteSearchOptions(
        avoidTollRoads = true,
        avoidUnpavedRoads = false,
        avoidFerry = false,
        routeSearchType = RouteSearchType.JAM
    )
)

navigationManager.start(routeBuildOptions)

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

navigationManager.start(routeBuildOptions, trafficRoute)

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, trafficRoute)

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

navigationManager.stop()

Custom geolocation source

You can use your own geolocation source within the SDK. To do this, first implement the LocationSource interface.

public class CustomLocationSource: LocationSource {
    override fun activate(listener: LocationChangeListener?) {
        // Geolocation source has been activated
    }

    override fun deactivate() {
        // Geolocation source has been deactivated
    }

    override fun setDesiredAccuracy(accuracy: DesiredAccuracy?) {
        // Change of required accuracy level has been requested
    }
}

Then, register the created source in the SDK using the registerPlatformLocationSource() function.

val customSource = CustomLocationSource()
registerPlatformLocationSource(sdkContext, customSource)

The entry point of the interface is the activate() function. When the SDK requires a geolocation, it will call this function passing a LocationChangeListener object. After that, to report the current geolocation, you need to pass an array of Location objects (ordered from oldest to newest) to the onLocationChanged() method.

val location = Location(...)
val newLocations = arrayOf(location)
listener.onLocationChanged(newLocations)

To notify of a change in source availability, use the onAvailabilityChanged() method.

Optionally, you can add additional logic to handle different levels of geolocation accuracy. The required accuracy is passed to the setDesiredAccuracy() function as a DesiredAccuracy object.

When the geolocation source is no longer needed, the SDK will call the deactivate() function.

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. When creating a route endpoint RouteSearchPoint, you must specify the objectId and levelId parameters.

// RouteBuildOptions object is also required
val 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()
)

Displaying a route

If you use the standard set of NavigationView and DefaultNavigationControls, as recommended in beginning of section, this feature is already available and does not require preconfiguration.

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. This channel can be obtained from [NavigationManager](/en/android/sdk/reference/stable/ru.dgis.sdk.navigation.NavigationManager#nav-lvl1--val indoorDetector)

Alternative routes

While driving along a car route, the navigator regularly searches for other ways to reach the destination point. For alternative routes search, all specified route parameters and intermediate points (except for already visited ones) are taken into account.

An alternative route is displayed on the map when a corresponding intersection is approaching, but the user still has enough time to make a decision.

The alternative route is shown on the map as a line with a bubble indicating the difference in travel time: how much time the user saves or loses if they switch to the alternative route. To switch to this route, the user can tap the route line on the screen or simply turn onto the alternative route at the intersection. If the user continues driving along the main route at the intersection, the alternative route disappears from the map.

"Better Route"

Among the alternative routes, a special type called the "better route" may be highlighted if a route meets the following criteria:

• The expected travel duration on the "better route" must be significantly shorter than the remaining part of the main route. The default difference is 5 minutes.
• The "better route" must be significantly different from the main route in geometry (in the roads it passes). By default, the difference in the length of differing route segments is 500 meters.

If a "better route" is found among the detected alternative routes, an additional UI control is displayed on the map. By tapping this element, the user can either switch to the "better route" or explicitly decline it. This element disappears from the screen after a certain time (30 seconds by default), but the route line continues to be displayed on the map until the user passes the intersection.

At any given time, only one route can be suggested to the user as the "better route". The search for a new "better route" begins after the user explicitly declines the previous one (by tapping the UI control) or after passing the intersection where the "better route" was available.

Parameters of alternative routes search

To change the parameters for searching for alternative routes, use the AlternativeRoutesProviderSettings property of the NavigationManager object:

navigationManager.alternativeRoutesProviderSettings.alternativeRoutesEnabled = true

To switch navigation to an alternative route, use AlternativeRouteSelector:

navigationManager.alternativeRouteSelector.selectAlternativeRoute(route)

Dynamic route information

During navigation, you can receive dynamic route information through the uiModel property in NavigationManager and display it in the navigator UI. The Model class provides the following parameters:

• navigator state (state and stateChannel)
• current geolocation used by the navigator (location and locationChannel)
• flag indicating if current geolocation is being used for navigation (locationAvailable and locationAvailableChannel)
• route information with maneuvers (route and routeChannel)
• road events and traffic data on the route (dynamicRouteInfo and dynamicRouteInfoChannel)
• current user position on the route (routePosition and routePositionChannel)
• flag indicating if the speed limit is exceeded (exceedingMaxSpeedLimit and exceedingMaxSpeedLimitChannel)
• flag indicating if a "better route" is found (betterRoute and betterRouteChannel)
• time to the end of the route (duration)
• flag indicating if the free roam mode is used (isFreeRoam)

The route information in Model changes dynamically relative to the user current position on the route. To get the current position, subscribe to the routePositionChannel and then use this value to obtain other route data. See more about working with channels in the Data channels section.

For example, you can get the following information:

• Time (duration) from the current point to the end of the route:

  // Channel for getting a position on the route
  val positionChannel = navigationManager.uiModel.routePositionChannel
  
  val positionSubscription = positionChannel.connect {
      // Time to the end of the route in seconds
      val duration = navigationManager.uiModel.duration
      ...
  }
  
  

• Road events and traffic jam data (dynamicRouteInfo). Road events data is stored in the RoadEventRouteAttribute and you can get an element from it by a position on the route.

  For example, to get the next nearest road event on the route:

  // Channel for getting a position on the route
  val positionChannel = navigationManager.uiModel.routePositionChannel
  
  val positionSubscription = positionChannel.connect { routePosition ->
      // Get the nearest road event relative to the current position
      val dynamicInfo = navigationManager.uiModel.dynamicRouteInfo
      val nearestEvent = routePosition?.let { dynamicInfo.roadEvents.findNearForward(it) }
      ...
  }
  
  

• Current navigator state. You can get it by subscribing to the stateChannel channel or separately (state):

  // Get navigator state outside of the channel
  val currentState = navigationManager.uiModel.state
  

  // Channel for getting navigator state
  val stateChannel = navigationManager.uiModel.stateChannel
  
  val stateSubscription = stateChannel.connect {
      ...
  }
  

  Navigator can be in one of the following states:

  • DISABLED - inactive (initial state).
  • NAVIGATION - in the turn-by-turn navigation mode.
  • ROUTE_SEARCH - searching for a new route.
  • FINISHED - completed navigation on the route (the finish point is reached).