Enroute Flight Navigation
A navigation app for VFR pilots
GeoMapProvider.h
1/***************************************************************************
2 * Copyright (C) 2019-2024 by Stefan Kebekus *
3 * stefan.kebekus@gmail.com *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 3 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20
21#pragma once
22
23#include <QCache>
24#include <QFuture>
25#include <QGeoRectangle>
26#include <QImage>
27#include <QProperty>
28#include <QQmlEngine>
29#include <QStandardPaths>
30#include <QTemporaryFile>
31#include <QTimer>
32
33#include "Airspace.h"
34#include "GlobalObject.h"
35#include "TileServer.h"
36#include "Waypoint.h"
37#include "fileFormats/MBTILES.h"
38
39using namespace Qt::Literals::StringLiterals;
40
41
42namespace GeoMaps
43{
44
63
65{
66 Q_OBJECT
67 QML_ELEMENT
68 QML_SINGLETON
69
70public:
77 explicit GeoMapProvider(QObject *parent = nullptr);
78
79 // No default constructor, important for QML singleton
80 explicit GeoMapProvider() = delete;
81
82 // deferred initialization
83 void deferredInitialization() override;
84
85 // factory function for QML singleton
86 static GeoMaps::GeoMapProvider* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
87 {
89 }
90
92 ~GeoMapProvider() override = default;
93
94
95
96 //
97 // Properties
98 //
99
104 Q_PROPERTY(QList<GeoMaps::Airspace> airspaces READ airspaces BINDABLE bindableAirspaces)
105
106
111
117 Q_PROPERTY(QString copyrightNotice READ copyrightNotice CONSTANT)
118
129
135 Q_PROPERTY(QByteArray geoJSON READ geoJSON BINDABLE bindableGeoJSON)
136
143 Q_PROPERTY(QString serverUrl READ serverUrl NOTIFY serverUrlChanged)
144
154 Q_PROPERTY(QString styleFileURL READ styleFileURL NOTIFY styleFileURLChanged)
155
157 Q_PROPERTY(QList<QSharedPointer<FileFormats::MBTILES>> terrainMapTiles READ terrainMapTiles NOTIFY terrainMapTilesChanged)
158
164 Q_PROPERTY(QList<GeoMaps::Waypoint> waypoints READ waypoints NOTIFY waypointsChanged)
165
166
167
168 //
169 // Getter Methods
170 //
171
176 [[nodiscard]] QList<GeoMaps::Airspace> airspaces() const {return m_airspaces.value();}
177
182 [[nodiscard]] QBindable<QList<GeoMaps::Airspace>> bindableAirspaces() {return &m_airspaces;}
183
188 [[nodiscard]] QStringList availableRasterMaps() const
189 {
190 return m_availableRasterMaps.value();
191 }
192
197 [[nodiscard]] QBindable<QStringList> bindableAvailableRasterMaps() const
198 {
199 return &m_availableRasterMaps;
200 }
201
206 [[nodiscard]] static QString copyrightNotice();
207
212 [[nodiscard]] QString currentRasterMap() const {return m_currentRasterMap.value();}
213
218 [[nodiscard]] QBindable<QString> bindableCurrentRasterMap() const {return &m_currentRasterMap;}
219
224 [[nodiscard]] QByteArray geoJSON() const {return m_combinedGeoJSON.value();}
225
230 [[nodiscard]] QBindable<QByteArray> bindableGeoJSON() {return &m_combinedGeoJSON;}
231
236 [[nodiscard]] QString serverUrl() {return m_tileServer.serverUrl();}
237
242 [[nodiscard]] QString styleFileURL();
243
248 [[nodiscard]] QList<QSharedPointer<FileFormats::MBTILES>> terrainMapTiles() const
249 {
250 return m_terrainMapTiles;
251 }
252
257 [[nodiscard]] QList<Waypoint> waypoints();
258
259
260
261 //
262 // Setter Methods
263 //
264
269 void setCurrentRasterMap(const QString& mapName);
270
271
272
273 //
274 // Methods
275 //
276
285 [[nodiscard]] Q_INVOKABLE QVariantList airspacesAtPosition(const QGeoCoordinate &position);
286
299 [[nodiscard]] Q_INVOKABLE GeoMaps::Waypoint closestWaypoint(QGeoCoordinate position, const QGeoCoordinate &distPosition);
300
308 [[nodiscard]] Q_INVOKABLE static GeoMaps::Waypoint createWaypoint()
309 {
310 return {};
311 }
312
320 [[nodiscard]] Q_INVOKABLE Units::Distance terrainElevationAMSL(const QGeoCoordinate& coordinate);
321
326 [[nodiscard]] Q_INVOKABLE static QByteArray emptyGeoJSON();
327
336 [[nodiscard]] Q_INVOKABLE QVector<GeoMaps::Waypoint> filteredWaypoints(const QString& filter);
337
344 [[nodiscard]] Q_INVOKABLE Waypoint findByID(const QString& icaoID);
345
356 [[nodiscard]] Q_INVOKABLE QList<GeoMaps::Waypoint> nearbyWaypoints(const QGeoCoordinate& position, const QString& type);
357
358
359signals:
362
365
368
371
374
375private:
376 Q_DISABLE_COPY_MOVE(GeoMapProvider)
377
378 // This slot is called every time the the set of aviation maps qchanges. It
379 // fills the aviation data cache.
380 void onAviationMapsChanged();
381
382 // This slot is called every time the the set of MBTile files changes. It
383 // sets up the tile server to and generates a new style file.
384 void onMBTILESChanged();
385
386 // Interal function that does most of the work for aviationMapsChanged()
387 // emits geoJSONChanged() when done. This function is meant to be run in a
388 // separate thread.
389 struct aviationDataCacheResult {
390 QList<Waypoint> waypoints;
391 QList<Airspace> airspaces;
392 QByteArray combinedGeoJSON;
393 };
394 aviationDataCacheResult fillAviationDataCache(QStringList JSONFileNames, Units::Distance airspaceAltitudeLimit, bool hideGlidingSectors);
395
396 // Caches used to speed up the method simplifySpecialChars
397 QRegularExpression specialChars{QStringLiteral("[^a-zA-Z0-9]")};
398 QHash<QString, QString> simplifySpecialChars_cache;
399
400 // This is the path under which map tiles are available on the _tileServer.
401 // This is set to a random number that changes every time the set of MBTile
402 // files changes
403 QString _currentBaseMapPath;
404 QString _currentTerrainMapPath;
405
406 // Tile Server
407 TileServer m_tileServer;
408
409 // Temporary file that holds the current style file
410 QPointer<QTemporaryFile> m_styleFile;
411
412 //
413 // Aviation Data Cache
414 //
415 QFuture<GeoMaps::GeoMapProvider::aviationDataCacheResult> _aviationDataCacheFuture; // Future; indicates if fillAviationDataCache() is currently running
416 QTimer _aviationDataCacheTimer; // Timer used to start another run of fillAviationDataCache()
417
418 //
419 // MBTILES
420 //
421 QList<QSharedPointer<FileFormats::MBTILES>> m_baseMapVectorTiles;
422 QProperty<QList<QSharedPointer<FileFormats::MBTILES>>> m_baseMapRasterTiles;
423 QList<QSharedPointer<FileFormats::MBTILES>> m_terrainMapTiles;
424
425 QProperty<QStringList> m_availableRasterMaps;
426 QStringList computeAvailableRasterMaps();
427
428 QProperty<QString> m_currentRasterMap {u"non-empty place holder"_s};
429 QPropertyNotifier m_currentRasterMapNotifier; // Used to save the currentRasterMap
430
431 Q_OBJECT_BINDABLE_PROPERTY(GeoMaps::GeoMapProvider, QByteArray, m_combinedGeoJSON, &GeoMaps::GeoMapProvider::geoJSONChanged)
432 QList<Waypoint> _waypoints_; // Cache: Waypoints
433 QProperty<QList<Airspace>> m_airspaces; // Cache: Airspaces
434
435 // TerrainImageCache
436 QCache<qint64,QImage> terrainTileCache {6}; // Hold 6 tiles, roughly 1.2MB
437
438 // GeoJSON file
439 QString geoJSONCache {QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) + u"/aviationData.json"_s};
440};
441
442} // namespace GeoMaps
A very simple class that describes an airspace.
Definition Airspace.h:33
Provides geographic information.
QBindable< QString > bindableCurrentRasterMap() const
Getter function for the property with the same name.
QList< Waypoint > waypoints()
Getter function for the property with the same name.
Q_INVOKABLE QList< GeoMaps::Waypoint > nearbyWaypoints(const QGeoCoordinate &position, const QString &type)
void terrainMapTilesChanged()
Notification signal for the property with the same name.
QBindable< QList< GeoMaps::Airspace > > bindableAirspaces()
Getter function for the property with the same name.
QBindable< QByteArray > bindableGeoJSON()
Getter function for the property with the same name.
QList< QSharedPointer< FileFormats::MBTILES > > terrainMapTiles() const
Getter function for the property with the same name.
QBindable< QStringList > bindableAvailableRasterMaps() const
Getter function for the property with the same name.
QString serverUrl()
Getter function for the property with the same name.
QStringList availableRasterMaps
Available Raster Maps.
Q_INVOKABLE Waypoint findByID(const QString &icaoID)
QString currentRasterMap
Current Raster Map.
QString currentRasterMap() const
Getter function for the property with the same name.
static Q_INVOKABLE GeoMaps::Waypoint createWaypoint()
Create invalid waypoint.
~GeoMapProvider() override=default
Destructor.
Q_INVOKABLE QVariantList airspacesAtPosition(const QGeoCoordinate &position)
List of airspaces at a given position.
Q_INVOKABLE QVector< GeoMaps::Waypoint > filteredWaypoints(const QString &filter)
Waypoints containing a given substring.
static Q_INVOKABLE QByteArray emptyGeoJSON()
Create empty GeoJSON document.
QByteArray geoJSON
Union of all aviation maps in GeoJSON format.
void styleFileURLChanged()
Notification signal for the property with the same name.
Q_INVOKABLE Units::Distance terrainElevationAMSL(const QGeoCoordinate &coordinate)
Elevation of terrain at a given coordinate, above sea level.
QString serverUrl
URL under which this server is presently reachable.
GeoMapProvider(QObject *parent=nullptr)
Creates a new GeoMap provider.
void geoJSONChanged()
Notification signal for the property with the same name.
QString styleFileURL()
Getter function for the property with the same name.
QString copyrightNotice
Copyright notice for the map.
QList< GeoMaps::Airspace > airspaces
Available Airspaces.
QByteArray geoJSON() const
Getter function for the property with the same name.
QList< GeoMaps::Waypoint > waypoints
Waypoints.
void serverUrlChanged()
Notification signal for the property with the same name.
QStringList availableRasterMaps() const
Getter function for the property with the same name.
void deferredInitialization() override
Non-constructor initialization.
void waypointsChanged()
Notification signal for the property with the same name.
QString styleFileURL
URL where a style file for the base map can be retrieved.
void setCurrentRasterMap(const QString &mapName)
Setter function for the property with the same name.
QListQSharedPointer< FileFormats::MBTILES > terrainMapTiles
List of terrain map MBTILES.
Q_INVOKABLE GeoMaps::Waypoint closestWaypoint(QGeoCoordinate position, const QGeoCoordinate &distPosition)
Find closest waypoint to a given position.
static QString copyrightNotice()
Getter function for the property with the same name.
Waypoint, such as an airfield, a navaid station or a reporting point.
Definition Waypoint.h:41
static Q_INVOKABLE GeoMaps::GeoMapProvider * geoMapProvider()
Pointer to appplication-wide static GeoMaps::GeoMapProvider instance.
GlobalObject(QObject *parent=nullptr)
Standard constructor.
Convenience class for distance computations.
Definition Distance.h:35