Generate offline map with local basemap

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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
// [WriteFile Name=GenerateOfflineMapLocalBasemap, Category=Maps]
// [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 "GenerateOfflineMapLocalBasemap.h"

// ArcGIS Maps SDK headers
#include "Envelope.h"
#include "Error.h"
#include "GenerateOfflineMapJob.h"
#include "GenerateOfflineMapParameters.h"
#include "GenerateOfflineMapResult.h"
#include "GeometryEngine.h"
#include "Layer.h"
#include "Map.h"
#include "MapQuickView.h"
#include "OfflineMapTask.h"
#include "Point.h"
#include "PortalItem.h"
#include "SpatialReference.h"
#include "TaskTypes.h"

// Qt headers
#include <QFuture>
#include <QStandardPaths>
#include <QTemporaryDir>
#include <QUuid>
#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

const QString GenerateOfflineMapLocalBasemap::s_webMapId = QStringLiteral("acc027394bc84c2fb04d1ed317aac674");

GenerateOfflineMapLocalBasemap::GenerateOfflineMapLocalBasemap(QQuickItem* parent /* = nullptr */):
  QQuickItem(parent)
{
}

void GenerateOfflineMapLocalBasemap::init()
{
  // Register the map view for QML
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<GenerateOfflineMapLocalBasemap>("Esri.Samples", 1, 0, "GenerateOfflineMapLocalBasemapSample");
}

void GenerateOfflineMapLocalBasemap::componentComplete()
{
  QQuickItem::componentComplete();

  // find QML MapView component
  m_mapView = findChild<MapQuickView*>("mapView");

  // Create a Portal Item for use by the Map and OfflineMapTask
  m_portalItem = new PortalItem(webMapId(), this);

  // Create a map from the Portal Item
  m_map = new Map(m_portalItem, this);

  // Update property once map is done loading
  connect(m_map, &Map::doneLoading, this, [this](const Error& e)
  {
    if (!e.isEmpty())
      return;

    m_mapLoaded = true;
    emit mapLoadedChanged();
  });

  // Set map to map view
  m_mapView->setMap(m_map);

  // Create the OfflineMapTask with the online map
  m_offlineMapTask = new OfflineMapTask(m_map, this);

  // connect to the error signal
  connect(m_offlineMapTask, &OfflineMapTask::errorOccurred, this, [](const Error& e)
  {
    if (e.isEmpty())
      return;

    qDebug() << e.message() << e.additionalMessage();
  });
}

void GenerateOfflineMapLocalBasemap::generateMapByExtent(double xCorner1, double yCorner1, double xCorner2, double yCorner2)
{
  // create an envelope from the QML rectangle corners
  const Point corner1 = m_mapView->screenToLocation(xCorner1, yCorner1);
  const Point corner2 = m_mapView->screenToLocation(xCorner2, yCorner2);
  const Envelope extent = Envelope(corner1, corner2);
  const Envelope mapExtent = geometry_cast<Envelope>(GeometryEngine::project(extent, SpatialReference::webMercator()));
  const QString tempPath = m_tempDir.path() + "/OfflineMap.mmpk";
  const QString dataPath = defaultDataPath() + "/ArcGIS/Runtime/Data/tpkx";

  // generate parameters
  m_offlineMapTask->createDefaultGenerateOfflineMapParametersAsync(mapExtent).then(this,
  [this, tempPath, dataPath](GenerateOfflineMapParameters params)
  {
    // update default parameters to specify use of local basemap
    // this will prevent new tiles from being generated on the server
    // and will reduce generation and download time
    if (m_useLocalBasemap)
    {
      params.setReferenceBasemapDirectory(dataPath);
      // A default reference basemap filename can be specified by the source portal item's advanced offline options.
      params.setReferenceBasemapFilename("naperville_imagery.tpkx");
    }

    // Take the map offline once the parameters are generated
    GenerateOfflineMapJob* generateJob = m_offlineMapTask->generateOfflineMap(params, tempPath);

    // check if there is a valid job
    if (generateJob)
    {
      // connect to the job's status changed signal
      connect(generateJob, &GenerateOfflineMapJob::statusChanged, this, [this, generateJob](JobStatus jobStatus)
      {
        // connect to the job's status changed signal to know once it is done
        switch (jobStatus) {
          case JobStatus::Failed:
            emit updateStatus("Generate failed");
            emit hideWindow(5000, false);
            break;
          case JobStatus::NotStarted:
            emit updateStatus("Job not started");
            break;
          case JobStatus::Paused:
            emit updateStatus("Job paused");
            break;
          case JobStatus::Started:
            emit updateStatus("In progress");
            break;
          case JobStatus::Succeeded:
            // show any layer errors
            if (generateJob->result()->hasErrors())
            {
              QString layerErrors = "";
              const QMap<Layer*, Error>& layerErrorsMap = generateJob->result()->layerErrors();
              for (auto it = layerErrorsMap.cbegin(); it != layerErrorsMap.cend(); ++it)
              {
                layerErrors += it.key()->name() + ": " + it.value().message() + "\n";
              }
              emit showLayerErrors(layerErrors);
            }

            // show the map
            emit updateStatus("Complete");
            emit hideWindow(1500, true);
            m_mapView->setMap(generateJob->result()->offlineMap(this));
            break;
          default:
            break;
        }
      });

      // connect to progress changed signal
      connect(generateJob, &GenerateOfflineMapJob::progressChanged, this, [this, generateJob]()
      {
        emit updateProgress(generateJob->progress());
      });

      // connect to the error signal
      connect(generateJob, &GenerateOfflineMapJob::errorOccurred, this, [](const Error& e)
      {
        if (e.isEmpty())
          return;

        qDebug() << e.message() << e.additionalMessage();
      });

      // start the generate job
      generateJob->start();
    }
    else
    {
      emit updateStatus("Export failed");
      emit hideWindow(5000, false);
    }
  });
}