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 QGEOPATH_H
41 #define QGEOPATH_H
42 
43 #include <QtPositioning/QGeoShape>
44 #include <QtCore/QVariantList>
45 
46 QT_BEGIN_NAMESPACE
47 
48 class QGeoCoordinate;
49 class QGeoPathPrivate;
50 
51 class Q_POSITIONING_EXPORT QGeoPath : public QGeoShape
52 {
53     Q_GADGET
54     Q_PROPERTY(QVariantList path READ variantPath WRITE setVariantPath)
55     Q_PROPERTY(qreal width READ width WRITE setWidth)
56 
57 public:
58     QGeoPath();
59     QGeoPath(const QList<QGeoCoordinate> &path, const qreal &width = 0.0);
60     QGeoPath(const QGeoPath &other);
61     QGeoPath(const QGeoShape &other);
62 
63     ~QGeoPath();
64 
65     QGeoPath &operator=(const QGeoPath &other);
66 
67     using QGeoShape::operator==;
68     bool operator==(const QGeoPath &other) const;
69 
70     using QGeoShape::operator!=;
71     bool operator!=(const QGeoPath &other) const;
72 
73     void setPath(const QList<QGeoCoordinate> &path);
74     const QList<QGeoCoordinate> &path() const;
75     void clearPath();
76     void setVariantPath(const QVariantList &path);
77     QVariantList variantPath() const;
78 
79     void setWidth(const qreal &width);
80     qreal width() const;
81 
82     Q_INVOKABLE void translate(double degreesLatitude, double degreesLongitude);
83     Q_INVOKABLE QGeoPath translated(double degreesLatitude, double degreesLongitude) const;
84     Q_INVOKABLE double length(int indexFrom = 0, int indexTo = -1) const;
85     Q_INVOKABLE int size() const;
86     Q_INVOKABLE void addCoordinate(const QGeoCoordinate &coordinate);
87     Q_INVOKABLE void insertCoordinate(int index, const QGeoCoordinate &coordinate);
88     Q_INVOKABLE void replaceCoordinate(int index, const QGeoCoordinate &coordinate);
89     Q_INVOKABLE QGeoCoordinate coordinateAt(int index) const;
90     Q_INVOKABLE bool containsCoordinate(const QGeoCoordinate &coordinate) const;
91     Q_INVOKABLE void removeCoordinate(const QGeoCoordinate &coordinate);
92     Q_INVOKABLE void removeCoordinate(int index);
93 
94     Q_INVOKABLE QString toString() const;
95 
96 private:
97     inline QGeoPathPrivate *d_func();
98     inline const QGeoPathPrivate *d_func() const;
99 };
100 
101 Q_DECLARE_TYPEINFO(QGeoPath, Q_MOVABLE_TYPE);
102 
103 QT_END_NAMESPACE
104 
105 Q_DECLARE_METATYPE(QGeoPath)
106 
107 #endif // QGEOPATH_H
108