Play a KML tour

View inQMLC++
View on GitHub
Sample viewer app

Play tours in KML files.

screenshot

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

PlayAKmlTour.qmlPlayAKmlTour.cppPlayAKmlTour.h
                                                                                  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// [WriteFile Name=PlayAKmlTour, Category=Layers]
// [Legal]
// Copyright 2019 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

import QtQuick 2.6
import QtQuick.Controls 2.12
import QtQuick.Layouts 1.12
import Esri.Samples 1.0

Item {

    SceneView {
        id: view
        anchors.fill: parent
    }

    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: playAKmlTourSampleModel.playButtonEnabled
                onClicked: playAKmlTourSampleModel.playKmlTour();
            }

            Button {
                id: pauseButton
                text: qsTr("Pause")
                Layout.margins: 2
                enabled: playAKmlTourSampleModel.pauseButtonEnabled
                onClicked: playAKmlTourSampleModel.pauseKmlTour();
            }

            Button {
                id: resetButton
                text: qsTr("Reset")
                Layout.margins: 2
                enabled: playAKmlTourSampleModel.resetButtonEnabled
                onClicked: playAKmlTourSampleModel.resetKmlTour();
            }
        }
    }

    // Declare the C++ instance which creates the scene etc. and supply the view
    PlayAKmlTourSample {
        id: playAKmlTourSampleModel
        sceneView: view
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.