Fly To Area

In this guide you will learn how to render an interactive map, search for a destination, and fly to the destination area.

Setup

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

Download the Maps & Navigation SDK for Android archive file

Download the FlyToArea 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.

The example searches for the specified destination and flies to it.

If the destination has a perimeter, it is shown 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 and edit the search text as shown in the code block below, and run the app again to fly to a different area.

private val searchService = SearchService(
     onStarted = {
         progressBar.visibility = View.VISIBLE
         showStatusMessage("Search service has started!")
     },
     onCompleted = { results, errorCode, _ ->
         progressBar.visibility = View.GONE
         showStatusMessage("Search service completed with error code: $errorCode")
         when (errorCode)
         {
             GemError.NoError ->
             {
                 if (results.isNotEmpty())
                 {
                     showStatusMessage("Fly to area started")
                     val landmark = results[0]
                     flyTo(landmark)
                     showStatusMessage("Fly to area completed")
                 }
                 else
                 {
                     // The search completed without errors, but there were no results found.
                     showStatusMessage("The search completed without errors, but there were no results found.")
                 }
             }
             GemError.Cancel ->
             {
                 // The search action was canceled.
             }
             else ->
             {
                 // There was a problem at computing the search operation.
                 showDialog("Search service error: ${GemError.getMessage(errorCode)}")
             }
         }
     }
)

In the class MainActivity : AppCompatActivity(), a search service

val searchService = SearchService() is instantiated, to search for a landmark to fly to.

The search service implements the onStarted and onCompleted callbacks. When the search completes, if the result list is not empty, then the first item in the result list (at index 0) is taken and the camera flies to the location of that result:

val landmark = results[0]

flyTo(landmark)

private fun flyTo(landmark: Landmark) = SdkCall.execute {
     landmark.geographicArea?.let { area ->
         gemSurfaceView.mapView?.let { mainMapView ->
             // Define highlight settings for displaying the area contour on map.
             val settings = HighlightRenderSettings(EHighlightOptions.ShowContour)
             // Center the map on a specific area using the provided animation.
             mainMapView.centerOnArea(area)
             // Highlights a specific area on the map using the provided settings.
             mainMapView.activateHighlightLandmarks(landmark, settings)
         }
     }
}

After the search completes and the result list is not empty, the camera flies to the first target. The flyTo() function is implemented using mainMapView.centerOnArea(area)

Note that the contour of the target area is also rendered on the map: val settings = HighlightRenderSettings(EHighlightOptions.ShowContour)

override fun onCreate(savedInstanceState: Bundle?)
{
     super.onCreate(savedInstanceState)
     setContentView(R.layout.activity_main)
     progressBar = findViewById(R.id.progressBar)
     gemSurfaceView = findViewById(R.id.gem_surface)
     statusText = findViewById(R.id.status_text)
     SdkSettings.onMapDataReady = onMapDataReady@{ isReady ->
         if (!isReady) return@onMapDataReady
         // Defines an action that should be done after the world map is ready.
         SdkCall.execute {
             val text = "Statue of Liberty New York"
             val coordinates = Coordinates(40.68925476, -74.04456329)
             searchService.searchByFilter(text, coordinates)
         }
     }
     SdkSettings.onApiTokenRejected = {
         showDialog("TOKEN REJECTED")
     }
     if (!Util.isInternetConnected(this))
     {
         showDialog("You must be connected to internet!")
     }
}

MainActivity overrides the onCreate() function which checks that internet access is available, and then does a search for a hardcoded target:

val text = "Statue of Liberty New York"

val coordinates = Coordinates(0.0, 0.0)

searchService.searchByFilter(text, coordinates)

Note that the coordinates of the target are not required for the search and can be set to zero. When the search completes, it triggers the onCompleted callback of the search service shown above.

Android Examples

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