1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtPositioning module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QGEOPOLYGON_H
41#define QGEOPOLYGON_H
42
43#include <QtPositioning/QGeoShape>
44#include <QtCore/QVariantList>
45
46QT_BEGIN_NAMESPACE
47
48class QGeoCoordinate;
49class QGeoPolygonPrivate;
50
51class Q_POSITIONING_EXPORT QGeoPolygon : public QGeoShape
52{
53 Q_GADGET
54 Q_PROPERTY(QVariantList perimeter READ perimeter WRITE setPerimeter REVISION 12)
55
56public:
57 QGeoPolygon();
58 QGeoPolygon(const QList<QGeoCoordinate> &path);
59 QGeoPolygon(const QGeoPolygon &other);
60 QGeoPolygon(const QGeoShape &other);
61
62 ~QGeoPolygon();
63
64 QGeoPolygon &operator=(const QGeoPolygon &other);
65
66 using QGeoShape::operator==;
67 bool operator==(const QGeoPolygon &other) const;
68
69 using QGeoShape::operator!=;
70 bool operator!=(const QGeoPolygon &other) const;
71
72 void setPath(const QList<QGeoCoordinate> &path); // ### Qt6: rename into setPerimeter
73 const QList<QGeoCoordinate> &path() const;
74
75 Q_INVOKABLE void addHole(const QVariant &holePath);
76 void addHole(const QList<QGeoCoordinate> &holePath);
77 Q_INVOKABLE const QVariantList hole(int index) const;
78 const QList<QGeoCoordinate> holePath(int index) const;
79 Q_INVOKABLE void removeHole(int index);
80 Q_INVOKABLE int holesCount() const;
81 Q_INVOKABLE void translate(double degreesLatitude, double degreesLongitude);
82 Q_INVOKABLE QGeoPolygon translated(double degreesLatitude, double degreesLongitude) const;
83 Q_INVOKABLE double length(int indexFrom = 0, int indexTo = -1) const;
84 Q_INVOKABLE int size() const;
85 Q_INVOKABLE void addCoordinate(const QGeoCoordinate &coordinate);
86 Q_INVOKABLE void insertCoordinate(int index, const QGeoCoordinate &coordinate);
87 Q_INVOKABLE void replaceCoordinate(int index, const QGeoCoordinate &coordinate);
88 Q_INVOKABLE QGeoCoordinate coordinateAt(int index) const;
89 Q_INVOKABLE bool containsCoordinate(const QGeoCoordinate &coordinate) const;
90 Q_INVOKABLE void removeCoordinate(const QGeoCoordinate &coordinate);
91 Q_INVOKABLE void removeCoordinate(int index);
92
93 Q_INVOKABLE QString toString() const;
94
95protected:
96 void setPerimeter(const QVariantList &path);
97 QVariantList perimeter() const;
98
99private:
100 inline QGeoPolygonPrivate *d_func();
101 inline const QGeoPolygonPrivate *d_func() const;
102};
103
104Q_DECLARE_TYPEINFO(QGeoPolygon, Q_MOVABLE_TYPE);
105
106QT_END_NAMESPACE
107
108Q_DECLARE_METATYPE(QGeoPolygon)
109
110#endif // QGEOPOLYGON_H
111

source code of qtlocation/src/positioning/qgeopolygon.h