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 QGEORECTANGLE_H
41 #define QGEORECTANGLE_H
42 
43 #include <QtPositioning/QGeoShape>
44 
45 QT_BEGIN_NAMESPACE
46 
47 class QGeoRectanglePrivate;
48 
49 class Q_POSITIONING_EXPORT QGeoRectangle : public QGeoShape
50 {
51     Q_GADGET
52     Q_PROPERTY(QGeoCoordinate bottomLeft READ bottomLeft WRITE setBottomLeft)
53     Q_PROPERTY(QGeoCoordinate bottomRight READ bottomRight WRITE setBottomRight)
54     Q_PROPERTY(QGeoCoordinate topLeft READ topLeft WRITE setTopLeft)
55     Q_PROPERTY(QGeoCoordinate topRight READ topRight WRITE setTopRight)
56     Q_PROPERTY(QGeoCoordinate center READ center WRITE setCenter)
57     Q_PROPERTY(double height READ height WRITE setHeight)
58     Q_PROPERTY(double width READ width WRITE setWidth)
59 
60 public:
61     QGeoRectangle();
62     QGeoRectangle(const QGeoCoordinate &center, double degreesWidth, double degreesHeight);
63     QGeoRectangle(const QGeoCoordinate &topLeft, const QGeoCoordinate &bottomRight);
64     QGeoRectangle(const QList<QGeoCoordinate> &coordinates);
65     QGeoRectangle(const QGeoRectangle &other);
66     QGeoRectangle(const QGeoShape &other);
67 
68     ~QGeoRectangle();
69 
70     QGeoRectangle &operator=(const QGeoRectangle &other);
71 
72     using QGeoShape::operator==;
73     bool operator==(const QGeoRectangle &other) const;
74 
75     using QGeoShape::operator!=;
76     bool operator!=(const QGeoRectangle &other) const;
77 
78     void setTopLeft(const QGeoCoordinate &topLeft);
79     QGeoCoordinate topLeft() const;
80 
81     void setTopRight(const QGeoCoordinate &topRight);
82     QGeoCoordinate topRight() const;
83 
84     void setBottomLeft(const QGeoCoordinate &bottomLeft);
85     QGeoCoordinate bottomLeft() const;
86 
87     void setBottomRight(const QGeoCoordinate &bottomRight);
88     QGeoCoordinate bottomRight() const;
89 
90     void setCenter(const QGeoCoordinate &center);
91     QGeoCoordinate center() const;
92 
93     void setWidth(double degreesWidth);
94     double width() const;
95 
96     void setHeight(double degreesHeight);
97     double height() const;
98 
99     using QGeoShape::contains;
100     bool contains(const QGeoRectangle &rectangle) const;
101     Q_INVOKABLE bool intersects(const QGeoRectangle &rectangle) const;
102 
103     Q_INVOKABLE void translate(double degreesLatitude, double degreesLongitude);
104     Q_INVOKABLE QGeoRectangle translated(double degreesLatitude, double degreesLongitude) const;
105     Q_INVOKABLE void extendRectangle(const QGeoCoordinate &coordinate);
106 
107     Q_INVOKABLE QGeoRectangle united(const QGeoRectangle &rectangle) const;
108     QGeoRectangle operator|(const QGeoRectangle &rectangle) const;
109     QGeoRectangle &operator|=(const QGeoRectangle &rectangle);
110 
111     Q_INVOKABLE QString toString() const;
112 
113 private:
114     inline QGeoRectanglePrivate *d_func();
115     inline const QGeoRectanglePrivate *d_func() const;
116 };
117 
118 Q_DECLARE_TYPEINFO(QGeoRectangle, Q_MOVABLE_TYPE);
119 
120 inline QGeoRectangle QGeoRectangle::operator|(const QGeoRectangle &rectangle) const
121 {
122     return united(rectangle);
123 }
124 
125 QT_END_NAMESPACE
126 
127 Q_DECLARE_METATYPE(QGeoRectangle)
128 
129 #endif
130