Add a 3D map to your app

This page walks through an example of how to add a basic 3D map to an Android app using the Maps 3D SDK for Android. The instructions on this page assume that you have already completed the steps in the Setup page and have the following:

• A Google Cloud project with the Maps 3D SDK for Android enabled
• An API key configured to use with the Maps 3D SDK for Android
• An Android Studio project set up to use with the Maps 3D SDK for Android

For more information about these prerequisites, see Setup.

Part 1: Update Layout File (activity_main.xml) to add the Map3DView component

The Map3DView component is the view that renders the 3D map within the app. The following steps add the component and configure the initial state of the map, including the camera position and related attributes:

1. Open your main activity's layout file, which is usually located at app/src/main/res/layout/activity_main.xml.

2. In the root ConstraintLayout (or your root layout element), add the map3d XML namespace:

   xmlns:map3d="http://schemas.android.com/apk/res-auto"
   

3. Delete the default <TextView> that displays "Hello World!".

4. Add the Map3DView component to your layout. You can customize the camera position and other attributes:

   <?xml version="1.0" encoding="utf-8"?>
   <androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:app="http://schemas.android.com/apk/res-auto"
     xmlns:map3d="http://schemas.android.com/apk/res-auto" xmlns:tools="http://schemas.android.com/tools"
     android:id="@+id/main"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     tools:context=".MainActivity">
   
     <com.google.android.gms.maps3d.Map3DView
       android:id="@+id/map3dView"
       android:layout_width="match_parent"
       android:layout_height="match_parent"
       map3d:mode="hybrid"
       map3d:centerLat="38.544012"
       map3d:centerLng="-107.670428"
       map3d:centerAlt="2427.6"
       map3d:heading="310"
       map3d:tilt="63"
       map3d:range="8266"
       map3d:roll="0"
       map3d:minAltitude="0"
       map3d:maxAltitude="1000000"
       map3d:minHeading="0"
       map3d:maxHeading="360"
       map3d:minTilt="0"
       map3d:maxTilt="90"
       app:layout_constraintBottom_toBottomOf="parent"
       app:layout_constraintEnd_toEndOf="parent"
       app:layout_constraintStart_toStartOf="parent"
       app:layout_constraintTop_toTopOf="parent" />
   </androidx.constraintlayout.widget.ConstraintLayout>
   

Part 2: Update MainActivity.kt

The following steps initialize the Map3DView component added to the activity_main.xml file in Part 1 and manage component lifecycle events:

1. Open your MainActivity.kt file, which is usually located at app/src/main/java/com/example/yourpackagename/MainActivity.kt.

2. Add the necessary imports for the Maps 3D SDK for Android:

   import com.google.android.gms.maps3d.GoogleMap3D
   import com.google.android.gms.maps3d.Map3DView
   import com.google.android.gms.maps3d.OnMap3DViewReadyCallback
   

3. Modify the MainActivity class to implement OnMap3DViewReadyCallback:

   class MainActivity : AppCompatActivity(), OnMap3DViewReadyCallback {
   

4. Declare variables for Map3DView and GoogleMap3D:

   private lateinit var map3DView: Map3DView
   private var googleMap3D: GoogleMap3D? = null
   

5. In the onCreate method, after setContentView(...) and the ViewCompat.setOnApplyWindowInsetsListener block, initialize the map3DView, call its onCreate lifecycle method, and request the map asynchronously:

   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       enableEdgeToEdge()
       setContentView(R.layout.activity_main)
       ViewCompat.setOnApplyWindowInsetsListener(findViewById(R.id.main)) { v, insets ->
           val systemBars = insets.getInsets(WindowInsetsCompat.Type.systemBars())
           v.setPadding(systemBars.left, systemBars.top, systemBars.right, systemBars.bottom)
           insets
       }
   
       map3DView = findViewById(R.id.map3dView)
       map3DView.onCreate(savedInstanceState)
       map3DView.getMap3DViewAsync(this)
   }
   

6. Override the onMap3DViewReady method. This callback is triggered when the map is ready to be used:

   override fun onMap3DViewReady(googleMap3D: GoogleMap3D) {
       // Interact with the googleMap3D object here
       this.googleMap3D = googleMap3D
       // You can now make calls to the googleMap3D object, e.g.,
       // googleMap3D.cameraController.flyTo(camera { ... })
   }
   

7. Forward lifecycle events from your Activity to the Map3DView by adding the following overrides to the MainActivity:

   override fun onStart() {
       super.onStart()
       map3DView.onStart()
   }
   
   override fun onResume() {
       super.onResume()
       map3DView.onResume()
   }
   
   override fun onPause() {
       map3DView.onPause()
       super.onPause()
   }
   
   override fun onStop() {
       map3DView.onStop()
       super.onStop()
   }
   
   override fun onDestroy() {
       map3DView.onDestroy()
       super.onDestroy()
   }
   
   override fun onSaveInstanceState(outState: Bundle) {
       super.onSaveInstanceState(outState)
       map3DView.onSaveInstanceState(outState)
   }
   
   override fun onLowMemory() {
       super.onLowMemory()
       map3DView.onLowMemory()
   }
   

Part 3: Sync Gradle and Run

Now that you've updated your app's layout and activity, you can build and run the app to see the 3D map view.

1. To sync your project with Gradle, select File > Sync Project with Gradle Files.

2. To build and run your app on an emulator or a physical device, select Run > Run.

If everything is configured correctly, you should see a 3D map displayed in your app, centered near the coordinates specified in your activity_main.xml.

Next steps

Now that you've added a basic 3D map to your app, you can explore more advanced features of the Maps 3D SDK for Android, such as camera path animations, 3D markers, or polygons.