Fly To Route Instruction

In this guide you will learn how to render an interactive map, and fly to a specific instruction along a computed route rendered on the map.

Setup

First, get an API key token, see the Getting Started guide.

Download the Maps & Navigation SDK for Android archive file

Download the FlyToRouteInstruction project archive file or clone the project with Git

See the Configure Android Example guide.

Run the example

In Android Studio, from the File menu, select Sync Project with Gradle Files

An android device should be connected via USB cable.

Press SHIFT+F10 to compile, install and run the example on the android device.

This example flies to a specific instruction along a computed route rendered on the map.

Displays an interactive map which is fully 3D, supporting pan, pinch-zoom, rotate and tilt.

How it works

You can open the MainActivity.kt file to see how to fly to a specific instruction along a computed route on the map.

// Kotlin code
val calculateRoute =
{
    SdkCall.execute
    {
        if (!isMapReady) return@execute
        val waypoints = arrayListOf(
            Landmark("London", Coordinates(51.5073204, -0.1276475)),
            Landmark("Paris", Coordinates(48.8566932, 2.3514616))
        )
        routingService.calculateRoute(waypoints)
    }
}

Coordinates are defined using a Landmark for the departure and another for the destination, then the routingService instance calculates the route using calculateRoute.

private fun flyToInstruction(routeInstruction: RouteInstruction)
{
     val animation = Animation()
     animation.setType(EAnimation.AnimationLinear)
     // Center the map on a specific route instruction using the provided animation.
     mainMapView?.centerOnRouteInstruction(routeInstruction, -1, Xy(), animation)
}

The centerOnRouteInstruction(routeInstruction, -1, Xy(), animation) function is used to fly to a specific instruction along the computed route.

routingService.onCompleted = onCompleted@{ routes, reason, _ ->
    progressBar.visibility = View.GONE
    when (val gemError = SdkError.fromInt(reason))
    {
        SdkError.NoError ->
        {
            // No error encountered, we can handle the results.
            SdkCall.execute
            {
                // Get the main route from the ones that were found.
                val mainRoute: Route? = if (routes.size > 0)
                {
                    routes[0]
                } else {
                    null
                }
                // Get the first route instruction from the main route.
                val routeInstruction =
                    mainRoute?.getSegments()?.get(0)?.getInstructions()?.get(0)

                if (routeInstruction == null)
                {
                    postOnMain
                    {
                        Toast.makeText(
                            this@MainActivity,
                            "No route instructions found!",
                            Toast.LENGTH_SHORT
                        )
                            .show()
                    }
                    return@execute
                }
                // Add the main route to the map so it can be displayed.
                mainMapView?.preferences()?.routes()?.add(mainRoute, true)
                flyToInstruction(routeInstruction)
            }
        }

The selected route instruction is index 0

mainRoute?.getSegments()?.get(0)?.getInstructions()?.get(0)

(the first instruction) from the route at index 0,

routes[0] (the first route) from the resulting list of routes between the departure and destination points.

Android Examples

Maps SDK for Android Examples can be downloaded or cloned with Git