Play a KML tour

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// [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]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

// sample headers
#include "PlayAKmlTour.h"

// ArcGIS Maps SDK headers
#include "ArcGISTiledElevationSource.h"
#include "ElevationSourceListModel.h"
#include "Error.h"
#include "KmlContainer.h"
#include "KmlDataset.h"
#include "KmlLayer.h"
#include "KmlNodeListModel.h"
#include "KmlTour.h"
#include "KmlTourController.h"
#include "LayerListModel.h"
#include "MapTypes.h"
#include "Scene.h"
#include "SceneQuickView.h"
#include "Surface.h"

// Qt headers
#include <QStandardPaths>
#include <QtCore/qglobal.h>

using namespace Esri::ArcGISRuntime;

// helper method to get cross platform data path
namespace
{
  QString defaultDataPath()
  {
    QString dataPath;

  #ifdef Q_OS_IOS
    dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
  #else
    dataPath = QStandardPaths::writableLocation(QStandardPaths::HomeLocation);
  #endif

    return dataPath;
  }
} // namespace

PlayAKmlTour::PlayAKmlTour(QObject* parent /* = nullptr */):
  QObject(parent),
  m_scene(new Scene(BasemapStyle::ArcGISImageryStandard, this)),
  m_dataPath(defaultDataPath() + "/ArcGIS/Runtime/Data")
{
  // create a new elevation source from Terrain3D REST service
  ArcGISTiledElevationSource* elevationSource = new ArcGISTiledElevationSource(
        QUrl("https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"), this);

  // add the elevation source to the scene to display elevation
  m_scene->baseSurface()->elevationSources()->append(elevationSource);

  m_kmlDataset = new KmlDataset(QUrl::fromLocalFile(m_dataPath + "/kml/Esri_tour.kmz"), this);
  m_kmlLayer = new KmlLayer(m_kmlDataset, this);

  connect(m_kmlLayer, &KmlLayer::doneLoading, this, [this](const Error& e)
  {
    if (!e.isEmpty())
    {
      qDebug() << e.message();
      return;
    }

    m_scene->operationalLayers()->append(m_kmlLayer);

    m_kmlTour = findFirstKMLTour(m_kmlDataset->rootNodes());
    m_kmlTourController = new KmlTourController(this);

    if (m_kmlTour)
    {
      connect(m_kmlTour, &KmlTour::tourStatusChanged, this, [this](KmlTourStatus tourStatus)
      {
        switch (tourStatus) {
          case KmlTourStatus::Completed:
          case KmlTourStatus::Initialized:
            m_playButtonEnabled = true;
            m_pauseButtonEnabled = false;
            m_resetButtonEnabled = true;
            break;
          case KmlTourStatus::Playing:
            m_playButtonEnabled = false;
            m_pauseButtonEnabled = true;
            m_resetButtonEnabled = true;
            break;
          case KmlTourStatus::Paused:
            m_playButtonEnabled = true;
            m_pauseButtonEnabled = false;
            m_resetButtonEnabled = true;
            break;
          case KmlTourStatus::Initializing:
          case KmlTourStatus::NotInitialized:
            break;
        }

        emit playButtonEnabledChanged();
        emit pauseButtonEnabledChanged();
        emit resetButtonEnabledChanged();
      });

      m_kmlTourController->setTour(m_kmlTour);
    }
  });

  m_kmlLayer->load();
}

PlayAKmlTour::~PlayAKmlTour() = default;

void PlayAKmlTour::init()
{
  // Register classes for QML
  qmlRegisterType<SceneQuickView>("Esri.Samples", 1, 0, "SceneView");
  qmlRegisterType<PlayAKmlTour>("Esri.Samples", 1, 0, "PlayAKmlTourSample");
}

SceneQuickView* PlayAKmlTour::sceneView() const
{
  return m_sceneView;
}

// Set the view (created in QML)
void PlayAKmlTour::setSceneView(SceneQuickView* sceneView)
{
  if (!sceneView || sceneView == m_sceneView)
    return;

  m_sceneView = sceneView;
  m_sceneView->setArcGISScene(m_scene);

  emit sceneViewChanged();
}

void PlayAKmlTour::playKmlTour()
{
  m_kmlTourController->play();
}
void PlayAKmlTour::pauseKmlTour()
{
  m_kmlTourController->pause();
}
void PlayAKmlTour::resetKmlTour()
{
  m_kmlTourController->reset();
}

KmlTour* PlayAKmlTour::findFirstKMLTour(const QList<KmlNode*>& nodes)
{
  for (KmlNode* node : nodes)
  {
    if (node->kmlNodeType() == KmlNodeType::KmlTour)
      return dynamic_cast<KmlTour*>(node);
    else if ((node->kmlNodeType() == KmlNodeType::KmlDocument) || (node->kmlNodeType() == KmlNodeType::KmlFolder))
      return findFirstKMLTourFromListModel(*dynamic_cast<KmlContainer*>(node)->childNodesListModel());
  }
  return nullptr;
}

KmlTour* PlayAKmlTour::findFirstKMLTourFromListModel(const KmlNodeListModel& nodes)
{
  for (KmlNode* node : nodes)
  {
    if (node->kmlNodeType() == KmlNodeType::KmlTour)
      return dynamic_cast<KmlTour*>(node);
    else if ((node->kmlNodeType() == KmlNodeType::KmlDocument) || (node->kmlNodeType() == KmlNodeType::KmlFolder))
      return findFirstKMLTourFromListModel(*dynamic_cast<KmlContainer*>(node)->childNodesListModel());
  }
  return nullptr;
}