| 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 QGEOCOORDINATE_H |
| 41 | #define QGEOCOORDINATE_H |
| 42 | |
| 43 | #include <QtCore/QMetaType> |
| 44 | #include <QtCore/QString> |
| 45 | #include <QtCore/QSharedDataPointer> |
| 46 | #include <QtPositioning/qpositioningglobal.h> |
| 47 | |
| 48 | QT_BEGIN_NAMESPACE |
| 49 | |
| 50 | class QDebug; |
| 51 | class QDataStream; |
| 52 | |
| 53 | class QGeoCoordinatePrivate; |
| 54 | class Q_POSITIONING_EXPORT QGeoCoordinate |
| 55 | { |
| 56 | Q_GADGET |
| 57 | Q_ENUMS(CoordinateFormat) |
| 58 | |
| 59 | Q_PROPERTY(double latitude READ latitude WRITE setLatitude) |
| 60 | Q_PROPERTY(double longitude READ longitude WRITE setLongitude) |
| 61 | Q_PROPERTY(double altitude READ altitude WRITE setAltitude) |
| 62 | Q_PROPERTY(bool isValid READ isValid) |
| 63 | |
| 64 | public: |
| 65 | |
| 66 | enum CoordinateType { |
| 67 | InvalidCoordinate, |
| 68 | Coordinate2D, |
| 69 | Coordinate3D |
| 70 | }; |
| 71 | |
| 72 | enum CoordinateFormat { |
| 73 | Degrees, |
| 74 | DegreesWithHemisphere, |
| 75 | DegreesMinutes, |
| 76 | DegreesMinutesWithHemisphere, |
| 77 | DegreesMinutesSeconds, |
| 78 | DegreesMinutesSecondsWithHemisphere |
| 79 | }; |
| 80 | |
| 81 | QGeoCoordinate(); |
| 82 | QGeoCoordinate(double latitude, double longitude); |
| 83 | QGeoCoordinate(double latitude, double longitude, double altitude); |
| 84 | QGeoCoordinate(const QGeoCoordinate &other); |
| 85 | ~QGeoCoordinate(); |
| 86 | |
| 87 | QGeoCoordinate &operator=(const QGeoCoordinate &other); |
| 88 | |
| 89 | bool operator==(const QGeoCoordinate &other) const; |
| 90 | inline bool operator!=(const QGeoCoordinate &other) const { |
| 91 | return !operator==(other); |
| 92 | } |
| 93 | |
| 94 | bool isValid() const; |
| 95 | CoordinateType type() const; |
| 96 | |
| 97 | void setLatitude(double latitude); |
| 98 | double latitude() const; |
| 99 | |
| 100 | void setLongitude(double longitude); |
| 101 | double longitude() const; |
| 102 | |
| 103 | void setAltitude(double altitude); |
| 104 | double altitude() const; |
| 105 | |
| 106 | Q_INVOKABLE qreal distanceTo(const QGeoCoordinate &other) const; |
| 107 | Q_INVOKABLE qreal azimuthTo(const QGeoCoordinate &other) const; |
| 108 | |
| 109 | Q_INVOKABLE QGeoCoordinate atDistanceAndAzimuth(qreal distance, qreal azimuth, qreal distanceUp = 0.0) const; |
| 110 | |
| 111 | Q_INVOKABLE QString toString(CoordinateFormat format = DegreesMinutesSecondsWithHemisphere) const; |
| 112 | |
| 113 | private: |
| 114 | QGeoCoordinate(QGeoCoordinatePrivate &dd); |
| 115 | QSharedDataPointer<QGeoCoordinatePrivate> d; |
| 116 | friend class QGeoCoordinatePrivate; |
| 117 | friend class QQuickGeoCoordinateAnimation; |
| 118 | }; |
| 119 | |
| 120 | Q_DECLARE_TYPEINFO(QGeoCoordinate, Q_MOVABLE_TYPE); |
| 121 | |
| 122 | #ifndef QT_NO_DEBUG_STREAM |
| 123 | Q_POSITIONING_EXPORT QDebug operator<<(QDebug, const QGeoCoordinate &); |
| 124 | #endif |
| 125 | |
| 126 | Q_POSITIONING_EXPORT uint qHash(const QGeoCoordinate &coordinate, uint seed = 0); |
| 127 | |
| 128 | #ifndef QT_NO_DATASTREAM |
| 129 | Q_POSITIONING_EXPORT QDataStream &operator<<(QDataStream &stream, const QGeoCoordinate &coordinate); |
| 130 | Q_POSITIONING_EXPORT QDataStream &operator>>(QDataStream &stream, QGeoCoordinate &coordinate); |
| 131 | #endif |
| 132 | |
| 133 | QT_END_NAMESPACE |
| 134 | |
| 135 | Q_DECLARE_METATYPE(QGeoCoordinate) |
| 136 | |
| 137 | #endif |
| 138 | |