QGCMapPolygon.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QObject>
#include <QtPositioning/QGeoCoordinate>
#include <QtCore/QVariantList>
#include <QtGui/QPolygonF>
#include <QtXml/QDomElement>
 
#include "QmlObjectListModel.h"
 
class KMLDomDocument;
 
class QGCMapPolygon : public QObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("")
public:
    QGCMapPolygon(QObject* parent = nullptr);
    QGCMapPolygon(const QGCMapPolygon& other, QObject* parent = nullptr);
 
    ~QGCMapPolygon() override;
 
    const QGCMapPolygon& operator=(const QGCMapPolygon& other);
 
    Q_PROPERTY(int                  count           READ count                                  NOTIFY countChanged)
    Q_PROPERTY(QVariantList         path            READ path                                   NOTIFY pathChanged)
    Q_PROPERTY(double               area            READ area                                   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)
    Q_PROPERTY(bool                 isValid         READ isValid                                NOTIFY isValidChanged)
    Q_PROPERTY(bool                 empty           READ empty                                  NOTIFY isEmptyChanged)
    Q_PROPERTY(bool                 traceMode       READ traceMode      WRITE setTraceMode      NOTIFY traceModeChanged)
    Q_PROPERTY(bool                 showAltColor    READ showAltColor   WRITE setShowAltColor   NOTIFY showAltColorChanged)
    Q_PROPERTY(int                  selectedVertex  READ selectedVertex WRITE selectVertex      NOTIFY selectedVertexChanged)
 
    Q_INVOKABLE void clear(void);
    Q_INVOKABLE void appendVertex(const QGeoCoordinate& coordinate);
    Q_INVOKABLE void removeVertex(int vertexIndex);
    Q_INVOKABLE void appendVertices(const QVariantList& varCoords);
 
    void appendVertices(const QList<QGeoCoordinate>& coordinates);
 
    Q_INVOKABLE void adjustVertex(int vertexIndex, const QGeoCoordinate coordinate);
 
    Q_INVOKABLE void splitPolygonSegment(int vertexIndex);
 
    Q_INVOKABLE bool containsCoordinate(const QGeoCoordinate& coordinate) const;
 
    Q_INVOKABLE void offset(double distance);
 
    Q_INVOKABLE bool loadKMLOrSHPFile(const QString& file);
 
    QList<QGeoCoordinate> coordinateList(void) const;
 
    Q_INVOKABLE QGeoCoordinate vertexCoordinate(int vertex) const;
 
    Q_INVOKABLE void verifyClockwiseWinding(void);
 
    Q_INVOKABLE void beginReset (void);
    Q_INVOKABLE void endReset   (void);
 
    void saveToJson(QJsonObject& json);
 
    bool loadFromJson(const QJsonObject& json, bool required, QString& errorString);
 
    QList<QPointF> nedPolygon(void) const;
 
    double area(void) const;
 
    QDomElement kmlPolygonElement(KMLDomDocument& domDocument);
 
    // Property methods
 
    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; }
    bool            interactive (void) const { return _interactive; }
    bool            isValid     (void) const { return _polygonModel.count() >= 3; }
    bool            empty       (void) const { return _polygonModel.count() == 0; }
    bool            traceMode   (void) const { return _traceMode; }
    bool            showAltColor(void) const { return _showAltColor; }
    int             selectedVertex()   const { return _selectedVertexIndex; }
 
    QVariantList        path        (void) const { return _polygonPath; }
    QmlObjectListModel* qmlPathModel(void) { return &_polygonModel; }
    QmlObjectListModel& pathModel   (void) { return _polygonModel; }
 
    void setPath        (const QList<QGeoCoordinate>& path);
    void setPath        (const QVariantList& path);
    void setCenter      (QGeoCoordinate newCenter);
    void setCenterDrag  (bool centerDrag);
    void setInteractive (bool interactive);
    void setTraceMode   (bool traceMode);
    void setShowAltColor(bool showAltColor);
    void selectVertex   (int index);
 
    static constexpr const char* jsonPolygonKey = "polygon";
 
signals:
    void countChanged       (int count);
    void pathChanged        (void);
    void dirtyChanged       (bool dirty);
    void cleared            (void);
    void centerChanged      (QGeoCoordinate center);
    void centerDragChanged  (bool centerDrag);
    void interactiveChanged (bool interactive);
    bool isValidChanged     (void);
    bool isEmptyChanged     (void);
    void traceModeChanged   (bool traceMode);
    void showAltColorChanged(bool showAltColor);
    void selectedVertexChanged(int index);
 
private slots:
    void _polygonModelCountChanged(int count);
    void _polygonModelDirtyChanged(bool dirty);
    void _updateCenter(void);
 
private:
    void            _init                   (void);
    QPolygonF       _toPolygonF             (void) const;
    QGeoCoordinate  _coordFromPointF        (const QPointF& point) const;
    QPointF         _pointFFromCoord        (const QGeoCoordinate& coordinate) const;
 
    QVariantList        _polygonPath;
    QmlObjectListModel  _polygonModel;
    bool                _dirty =                false;
    QGeoCoordinate      _center;
    bool                _centerDrag =           false;
    bool                _ignoreCenterUpdates =  false;
    bool                _interactive =          false;
    bool                _traceMode =            false;
    bool                _showAltColor =         false;
    int                 _selectedVertexIndex =  -1;
    bool                _deferredPathChanged =  false;
};