QGCMapPolygon.h 6.35 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8 9 10 11 12 13 14 15
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

#ifndef QGCMapPolygon_H
#define QGCMapPolygon_H

#include <QObject>
#include <QGeoCoordinate>
#include <QVariantList>
16
#include <QPolygon>
17

18 19 20 21
#include "QmlObjectListModel.h"

/// The QGCMapPolygon class provides a polygon which can be displayed on a map using a map visuals control.
/// It maintains a representation of the polygon on QVariantList and QmlObjectListModel format.
22 23 24 25 26
class QGCMapPolygon : public QObject
{
    Q_OBJECT

public:
27 28
    QGCMapPolygon(QObject* parent = nullptr);
    QGCMapPolygon(const QGCMapPolygon& other, QObject* parent = nullptr);
29

30 31 32 33 34 35 36 37 38
    const QGCMapPolygon& operator=(const QGCMapPolygon& other);

    Q_PROPERTY(int                  count       READ count                                  NOTIFY countChanged)
    Q_PROPERTY(QVariantList         path        READ path                                   NOTIFY pathChanged)
    Q_PROPERTY(QmlObjectListModel*  pathModel   READ qmlPathModel                           CONSTANT)
    Q_PROPERTY(bool                 dirty       READ dirty          WRITE setDirty          NOTIFY dirtyChanged)
    Q_PROPERTY(QGeoCoordinate       center      READ center         WRITE setCenter         NOTIFY centerChanged)
    Q_PROPERTY(bool                 centerDrag  READ centerDrag     WRITE setCenterDrag     NOTIFY centerDragChanged)
    Q_PROPERTY(bool                 interactive READ interactive    WRITE setInteractive    NOTIFY interactiveChanged)
DonLakeFlyer's avatar
DonLakeFlyer committed
39 40
    Q_PROPERTY(bool                 isValid     READ isValid                                NOTIFY isValidChanged)
    Q_PROPERTY(bool                 empty       READ empty                                  NOTIFY isEmptyChanged)
41

42
    Q_INVOKABLE void clear(void);
43 44
    Q_INVOKABLE void appendVertex(const QGeoCoordinate& coordinate);
    Q_INVOKABLE void removeVertex(int vertexIndex);
45
    Q_INVOKABLE void appendVertices(const QList<QGeoCoordinate>& coordinates);
46 47 48 49

    /// Adjust the value for the specified coordinate
    ///     @param vertexIndex Polygon point index to modify (0-based)
    ///     @param coordinate New coordinate for point
50 51 52 53
    Q_INVOKABLE void adjustVertex(int vertexIndex, const QGeoCoordinate coordinate);

    /// Splits the segment comprised of vertextIndex -> vertexIndex + 1
    Q_INVOKABLE void splitPolygonSegment(int vertexIndex);
54

55 56
    /// Returns true if the specified coordinate is within the polygon
    Q_INVOKABLE bool containsCoordinate(const QGeoCoordinate& coordinate) const;
57

58 59 60
    /// Offsets the current polygon edges by the specified distance in meters
    Q_INVOKABLE void offset(double distance);

61
    /// Loads a polygon from a KML/SH{ file
DonLakeFlyer's avatar
DonLakeFlyer committed
62
    /// @return true: success
63
    Q_INVOKABLE bool loadKMLOrSHPFile(const QString& file);
DonLakeFlyer's avatar
DonLakeFlyer committed
64

65 66
    /// Returns the path in a list of QGeoCoordinate's format
    QList<QGeoCoordinate> coordinateList(void) const;
67

68
    /// Returns the QGeoCoordinate for the vertex specified
69
    Q_INVOKABLE QGeoCoordinate vertexCoordinate(int vertex) const;
70

71 72 73
    /// Adjust polygon winding order to be clockwise (if needed)
    Q_INVOKABLE void verifyClockwiseWinding(void);

Don Gagne's avatar
Don Gagne committed
74 75 76
    Q_INVOKABLE void beginReset (void);
    Q_INVOKABLE void endReset   (void);

77 78 79 80 81 82 83 84 85 86 87
    /// Saves the polygon to the json object.
    ///     @param json Json object to save to
    void saveToJson(QJsonObject& json);

    /// Load a polygon from json
    ///     @param json Json object to load from
    ///     @param required true: no polygon in object will generate error
    ///     @param errorString Error string if return is false
    /// @return true: success, false: failure (errorString set)
    bool loadFromJson(const QJsonObject& json, bool required, QString& errorString);

88
    /// Convert polygon to NED and return (D is ignored)
89 90 91 92
    QList<QPointF> nedPolygon(void) const;

    /// Returns the area of the polygon in meters squared
    double area(void) const;
93

94 95
    // Property methods

DonLakeFlyer's avatar
DonLakeFlyer committed
96 97 98 99 100
    int             count       (void) const { return _polygonPath.count(); }
    bool            dirty       (void) const { return _dirty; }
    void            setDirty    (bool dirty);
    QGeoCoordinate  center      (void) const { return _center; }
    bool            centerDrag  (void) const { return _centerDrag; }
101
    bool            interactive (void) const { return _interactive; }
Don Gagne's avatar
Don Gagne committed
102 103
    bool            isValid     (void) const { return _polygonModel.count() >= 3; }
    bool            empty       (void) const { return _polygonModel.count() == 0; }
104 105 106 107

    QVariantList        path        (void) const { return _polygonPath; }
    QmlObjectListModel* qmlPathModel(void) { return &_polygonModel; }
    QmlObjectListModel& pathModel   (void) { return _polygonModel; }
108

DonLakeFlyer's avatar
DonLakeFlyer committed
109 110 111 112
    void setPath        (const QList<QGeoCoordinate>& path);
    void setPath        (const QVariantList& path);
    void setCenter      (QGeoCoordinate newCenter);
    void setCenterDrag  (bool centerDrag);
113
    void setInteractive (bool interactive);
114 115

    static const char* jsonPolygonKey;
116

117
signals:
DonLakeFlyer's avatar
DonLakeFlyer committed
118 119 120 121 122 123
    void countChanged       (int count);
    void pathChanged        (void);
    void dirtyChanged       (bool dirty);
    void cleared            (void);
    void centerChanged      (QGeoCoordinate center);
    void centerDragChanged  (bool centerDrag);
124
    void interactiveChanged (bool interactive);
DonLakeFlyer's avatar
DonLakeFlyer committed
125 126
    bool isValidChanged     (void);
    bool isEmptyChanged     (void);
127

128 129 130
private slots:
    void _polygonModelCountChanged(int count);
    void _polygonModelDirtyChanged(bool dirty);
131
    void _updateCenter(void);
132

133
private:
Don Gagne's avatar
Don Gagne committed
134 135 136 137 138 139
    void            _init                   (void);
    QPolygonF       _toPolygonF             (void) const;
    QGeoCoordinate  _coordFromPointF        (const QPointF& point) const;
    QPointF         _pointFFromCoord        (const QGeoCoordinate& coordinate) const;
    void            _beginResetIfNotActive  (void);
    void            _endResetIfNotActive    (void);
140

141 142 143
    QVariantList        _polygonPath;
    QmlObjectListModel  _polygonModel;
    bool                _dirty;
144
    QGeoCoordinate      _center;
DonLakeFlyer's avatar
DonLakeFlyer committed
145
    bool                _centerDrag;
146
    bool                _ignoreCenterUpdates;
147
    bool                _interactive;
Don Gagne's avatar
Don Gagne committed
148
    bool                _resetActive;
149 150 151
};

#endif