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 QGEOSHAPE_H
41 #define QGEOSHAPE_H
42 
43 #include <QtCore/QSharedDataPointer>
44 #include <QtPositioning/QGeoCoordinate>
45 
46 QT_BEGIN_NAMESPACE
47 
48 class QDebug;
49 class QGeoShapePrivate;
50 class QGeoRectangle;
51 
52 class Q_POSITIONING_EXPORT QGeoShape
53 {
54     Q_GADGET
55     Q_PROPERTY(ShapeType type READ type)
56     Q_PROPERTY(bool isValid READ isValid)
57     Q_PROPERTY(bool isEmpty READ isEmpty)
58     Q_ENUMS(ShapeType)
59 
60 public:
61     QGeoShape();
62     QGeoShape(const QGeoShape &other);
63     ~QGeoShape();
64 
65     enum ShapeType {
66         UnknownType,
67         RectangleType,
68         CircleType,
69         PathType,
70         PolygonType
71     };
72 
73     ShapeType type() const;
74 
75     bool isValid() const;
76     bool isEmpty() const;
77     Q_INVOKABLE bool contains(const QGeoCoordinate &coordinate) const;
78     Q_INVOKABLE QGeoRectangle boundingGeoRectangle() const;
79     Q_INVOKABLE QGeoCoordinate center() const;
80 
81     Q_INVOKABLE void extendShape(const QGeoCoordinate &coordinate);
82 
83     bool operator==(const QGeoShape &other) const;
84     bool operator!=(const QGeoShape &other) const;
85 
86     QGeoShape &operator=(const QGeoShape &other);
87 
88     Q_INVOKABLE QString toString() const;
89 protected:
90     QGeoShape(QGeoShapePrivate *d);
91 
92     QSharedDataPointer<QGeoShapePrivate> d_ptr;
93 
94 private:
95     inline QGeoShapePrivate *d_func();
96     inline const QGeoShapePrivate *d_func() const;
97 };
98 
99 Q_DECLARE_TYPEINFO(QGeoShape, Q_MOVABLE_TYPE);
100 
101 #ifndef QT_NO_DEBUG_STREAM
102 Q_POSITIONING_EXPORT QDebug operator<<(QDebug, const QGeoShape &);
103 #endif
104 
105 #ifndef QT_NO_DATASTREAM
106 Q_POSITIONING_EXPORT QDataStream &operator<<(QDataStream &stream, const QGeoShape &shape);
107 Q_POSITIONING_EXPORT QDataStream &operator>>(QDataStream &stream, QGeoShape &shape);
108 #endif
109 
110 QT_END_NAMESPACE
111 
112 Q_DECLARE_METATYPE(QGeoShape)
113 
114 #endif
115