TerrainQuery.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QObject>
#include <QtCore/QPointer>
#include <QtCore/QQueue>
#include <QtCore/QVariant>
#include <QtPositioning/QGeoCoordinate>
 
#include "TerrainPathHeightInfo.h"
#include "TerrainQueryInterface.h"
 
class QTimer;
 
// IMPORTANT NOTE: The terrain query objects below must continue to live until the the terrain system signals data back through them.
// Because of that it makes object lifetime tricky. Normally you would use autoDelete = true such they delete themselves when they
// complete. The case for using autoDelete=false is where the query has not been "newed" as a standalone object.
//
// Another typical use case is to query some terrain data and while you are waiting for it to come back the underlying reason
// for that query changes and you end up needed to query again for a new set of data. In this case you are no longer interested
// in the results of the previous query. The way to do that is to disconnect the data received signal on the old stale query
// when you create the new query.
 
/*===========================================================================*/
 
class TerrainAtCoordinateQuery;
 
class TerrainAtCoordinateBatchManager : public QObject
{
    Q_OBJECT
 
public:
    explicit TerrainAtCoordinateBatchManager(QObject *parent = nullptr);
    ~TerrainAtCoordinateBatchManager();
 
    static TerrainAtCoordinateBatchManager *instance();
 
    void addQuery(TerrainAtCoordinateQuery *terrainAtCoordinateQuery, const QList<QGeoCoordinate> &coordinates);
 
    void setTerrainQueryInterface(TerrainQueryInterface *terrainQuery);
 
private slots:
    void _sendNextBatch();
    void _coordinateHeights(bool success, const QList<double> &heights);
 
private:
    struct QueuedRequestInfo_t {
        QPointer<TerrainAtCoordinateQuery> terrainAtCoordinateQuery;
        QList<QGeoCoordinate> coordinates;
    };
 
    struct SentRequestInfo_t {
        QPointer<TerrainAtCoordinateQuery> terrainAtCoordinateQuery;
        qsizetype cCoord;
    };
 
    void _batchFailed();
    QString _stateToString(TerrainQuery::State state);
 
    QQueue<QueuedRequestInfo_t> _requestQueue;
    QList<SentRequestInfo_t> _sentRequests;
    TerrainQuery::State _state = TerrainQuery::State::Idle;
    QTimer *_batchTimer = nullptr;
    TerrainQueryInterface *_terrainQuery = nullptr;
    static constexpr int _batchTimeout = 500;
};
 
/*===========================================================================*/
 
class TerrainAtCoordinateQuery : public QObject
{
    Q_OBJECT
 
public:
    explicit TerrainAtCoordinateQuery(bool autoDelete, QObject *parent = nullptr);
    ~TerrainAtCoordinateQuery();
 
    void requestData(const QList<QGeoCoordinate> &coordinates);
 
    static bool getAltitudesForCoordinates(const QList<QGeoCoordinate> &coordinates, QList<double> &altitudes, bool &error);
 
    void signalTerrainData(bool success, const QList<double> &heights);
 
signals:
    void terrainDataReceived(bool success, const QList<double> &heights);
 
private:
    bool _autoDelete = false;
};
 
/*===========================================================================*/
 
class TerrainPathQuery : public QObject
{
    Q_OBJECT
 
public:
    explicit TerrainPathQuery(bool autoDelete, QObject *parent = nullptr);
    ~TerrainPathQuery();
 
    void requestData(const QGeoCoordinate &fromCoord, const QGeoCoordinate &toCoord);
 
    using PathHeightInfo_t = TerrainPathHeightInfo;
 
signals:
    void terrainDataReceived(bool success, const TerrainPathQuery::PathHeightInfo_t &pathHeightInfo);
 
private slots:
    void _pathHeights(bool success, double distanceBetween, double finalDistanceBetween, const QList<double> &heights);
 
private:
    bool _autoDelete = false;
    TerrainQueryInterface *_terrainQuery = nullptr;
};
 
/*===========================================================================*/
 
class TerrainAreaQuery : public QObject
{
    Q_OBJECT
 
public:
    explicit TerrainAreaQuery(bool autoDelete, QObject *parent = nullptr);
    ~TerrainAreaQuery();
 
    void requestData(const QGeoCoordinate &swCoord, const QGeoCoordinate &neCoord);
 
    struct CarpetHeightInfo_t {
        double minHeight;
        double maxHeight;
        QList<QList<double>> carpet;
    };
 
signals:
    void terrainDataReceived(bool success, const TerrainAreaQuery::CarpetHeightInfo_t &carpetHeightInfo);
 
private slots:
    void _carpetHeights(bool success, double minHeight, double maxHeight, const QList<QList<double>> &carpet);
 
private:
    bool _autoDelete = false;
    TerrainQueryInterface *_terrainQuery = nullptr;
};
Q_DECLARE_METATYPE(TerrainAreaQuery::CarpetHeightInfo_t)
 
/*===========================================================================*/
 
class TerrainPolyPathQuery : public QObject
{
    Q_OBJECT
 
public:
    explicit TerrainPolyPathQuery(bool autoDelete, QObject *parent = nullptr);
    ~TerrainPolyPathQuery();
 
    void requestData(const QVariantList &polyPath);
    void requestData(const QList<QGeoCoordinate> &polyPath);
 
signals:
    void terrainDataReceived(bool success, const QList<TerrainPathQuery::PathHeightInfo_t> &rgPathHeightInfo);
 
private slots:
    void _terrainDataReceived(bool success, const TerrainPathQuery::PathHeightInfo_t &pathHeightInfo);
 
private:
    bool _autoDelete = false;
    int _curIndex = 0;
    QList<QGeoCoordinate> _rgCoords;
    QList<TerrainPathQuery::PathHeightInfo_t> _rgPathHeightInfo;
    TerrainPathQuery *_pathQuery = nullptr;
};