Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGIS Runtime SDK for Qt

Play a KML tour

Sample Viewer View Sample on GitHub

Play tours in KML files.

Use case

KML, the file format used by Google Earth, supports creating tours, which can control the viewpoint of the scene, hide and show content, and play audio. Tours allow you to easily share tours of geographic locations, which can be augmented with rich multimedia. Runtime allows you to consume these tours using a simple API.

How to use the sample

The sample will load the KMZ file automatically. When a tour is found, the Play button will be enabled. Use Play and Pause to control the tour. When you're ready to show the tour, use the reset button to return the tour to the unplayed state.

How it works

  1. Load the KML dataset and add it to a layer.
  2. Create the KML tour controller. Wire up the buttons to the play(), pause(), and reset() methods.
  3. Use a method to explore the tree of KML content and find the first KML tour. Once a tour is found, provide it to the KML tour controller.
  4. Enable the buttons to allow the user to play, pause, and reset the tour.

Relevant API

  • KmlTourController
  • KmlTourController.tour
  • KmlTourController.play()
  • KmlTourController.pause()
  • KmlTourController.reset()
  • KmlTour
  • KmlTour.tourStatus
  • KmlTour.tourStatusChanged

Offline data

Read more about how to set up the sample's offline data here.

Link Local Location
Esri tour KMZ <userhome>/ArcGIS/Runtime/Data/kml/Esri_tour.kmz

About the data

This sample uses a custom tour created by a member of the ArcGIS Runtime SDK samples team. When you play the tour, you'll see a narrated journey through some of Esri's offices.

Additional information

See Google's documentation for information about authoring KML tours.

Tags

animation, interactive, KML, narration, pause, play, story, tour

Sample Code

import QtQuick 2.6
import QtQuick.Controls 2.12
import QtQuick.Layouts 1.12
import Esri.ArcGISRuntime 100.9
import Esri.ArcGISExtras 1.1

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    readonly property url dataPath: System.userHomePath +  "/ArcGIS/Runtime/Data"

    SceneView {
        id: sceneView
        anchors.fill: parent

        Scene {
            id: scene
            BasemapImagery {}

            Surface {
                ArcGISTiledElevationSource {
                    url: "http://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"
                }
            }

            KmlLayer {
               dataset: KmlDataset {
                   id: kmlDataset
                   url: dataPath + "/kml/Esri_tour.kmz"
               }
               onLoadStatusChanged: {
                   if (loadStatus !== Enums.LoadStatusLoaded)
                       return;

                   const kmlTour = findFirstKMLTour(kmlDataset.rootNodes)

                   if (kmlTour !== null) {
                       kmlTour.tourStatusChanged.connect(()=> {
                           switch(kmlTour.tourStatus) {
                           case Enums.KmlTourStatusCompleted:
                           case Enums.KmlTourStatusInitialized:
                               playButton.enabled = true;
                               pauseButton.enabled = false;
                               resetButton.enabled = true;
                               break;
                           case Enums.KmlTourStatusPaused:
                               playButton.enabled = true;
                               pauseButton.enabled = false;
                               resetButton.enabled = true;
                               break;
                           case Enums.KmlTourStatusPlaying:
                               playButton.enabled = false;
                               pauseButton.enabled = true;
                               resetButton.enabled = true;
                               break;
                           case Enums.KmlTourStatusInitializing:
                           case Enums.KmlTourStatusNotInitialized:
                               break;
                           }
                       });
                       kmlTourController.tour = kmlTour;
                   }
               }
            }

            KmlTourController {
                id: kmlTourController
            }
        }

        Rectangle {
            id: buttonBackground
            anchors {
                left: parent.left
                top: parent.top
                margins: 3
            }
            width: childrenRect.width
            height: childrenRect.height
            color: "#000000"
            opacity: .75
            radius: 5

            // catch mouse signals from propagating to parent
            MouseArea {
                anchors.fill: parent
                onClicked: mouse.accepted = true
                onWheel: wheel.accepted = true
            }

            RowLayout {
                spacing: 0
                Button {
                    id: playButton
                    text: qsTr("Play")
                    Layout.margins: 2
                    enabled: false
                    onClicked: kmlTourController.play();
                }

                Button {
                    id: pauseButton
                    text: qsTr("Pause")
                    Layout.margins: 2
                    enabled: false
                    onClicked: kmlTourController.pause();
                }

                Button {
                    id: resetButton
                    text: qsTr("Reset")
                    Layout.margins: 2
                    enabled: false
                    onClicked: kmlTourController.reset();
                }
            }
        }
    }

    function findFirstKMLTour(nodes) {
        for (let i = 0; i < nodes.length; i++) {
            const node = nodes[i];
            if (node.kmlNodeType === Enums.KmlNodeTypeKmlTour)
                return node;
            else if ((node.kmlNodeType === Enums.KmlNodeTypeKmlFolder) || (node.kmlNodeType === Enums.KmlNodeTypeKmlDocument))
                return findFirstKMLTourFromListModel(node.childNodesListModel);
        }
        return null;
    }

    function findFirstKMLTourFromListModel(nodes) {
        for (let i = 0; i < nodes.count; ++i) {
            const node = nodes.get(i);
            if (node.kmlNodeType === Enums.KmlNodeTypeKmlTour)
                return node;
            else if ((node.kmlNodeType === Enums.KmlNodeTypeKmlFolder) || (node.kmlNodeType === Enums.KmlNodeTypeKmlDocument))
                return findFirstKMLTourFromListModel(node.childNodesListModel);
        }
        return null;
    }
}