1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtLocation module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL3$
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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
28 ** Software Foundation and appearing in the file LICENSE.GPL included in
29 ** the packaging of this file. Please review the following information to
30 ** ensure the GNU General Public License version 2.0 requirements will be
31 ** met: http://www.gnu.org/licenses/gpl-2.0.html.
32 **
33 ** $QT_END_LICENSE$
34 **
35 ****************************************************************************/
36 
37 #ifndef QDECLARATIVEGEOROUTE_H
38 #define QDECLARATIVEGEOROUTE_H
39 
40 //
41 //  W A R N I N G
42 //  -------------
43 //
44 // This file is not part of the Qt API.  It exists purely as an
45 // implementation detail.  This header file may change from version to
46 // version without notice, or even be removed.
47 //
48 // We mean it.
49 //
50 
51 #include <QtLocation/private/qlocationglobal_p.h>
52 #include <QtLocation/private/qdeclarativegeoroutesegment_p.h>
53 
54 #include <QtCore/QObject>
55 #include <QtQml/QQmlListProperty>
56 #include <QtLocation/QGeoRoute>
57 
58 QT_BEGIN_NAMESPACE
59 class QDeclarativeGeoRouteQuery;
60 
61 class Q_LOCATION_PRIVATE_EXPORT QDeclarativeGeoRoute : public QObject
62 {
63     Q_OBJECT
64 
65     Q_PROPERTY(QGeoRectangle bounds READ bounds CONSTANT)
66     Q_PROPERTY(int travelTime READ travelTime CONSTANT)
67     Q_PROPERTY(qreal distance READ distance CONSTANT)
68     Q_PROPERTY(QJSValue path READ path WRITE setPath NOTIFY pathChanged)
69     Q_PROPERTY(QQmlListProperty<QDeclarativeGeoRouteSegment> segments READ segments CONSTANT)
70     Q_PROPERTY(QDeclarativeGeoRouteQuery *routeQuery READ routeQuery REVISION 11)
71     Q_PROPERTY(QList<QObject *> legs READ legs CONSTANT REVISION 12)
72     Q_PROPERTY(QObject *extendedAttributes READ extendedAttributes CONSTANT REVISION 13)
73 
74 public:
75     explicit QDeclarativeGeoRoute(QObject *parent = 0);
76     QDeclarativeGeoRoute(const QGeoRoute &route, QObject *parent = 0);
77     ~QDeclarativeGeoRoute();
78 
79     QGeoRectangle bounds() const;
80     int travelTime() const;
81     qreal distance() const;
82 
83     QJSValue path() const;
84     void setPath(const QJSValue &value);
85 
86     QQmlListProperty<QDeclarativeGeoRouteSegment> segments();
87 
88     void appendSegment(QDeclarativeGeoRouteSegment *segment);
89     void clearSegments();
90 
91     int segmentsCount() const;
92     const QGeoRoute &route() const;
93     QDeclarativeGeoRouteQuery *routeQuery();
94     QList<QObject *> legs();
95     QQmlPropertyMap *extendedAttributes() const;
96 
97     Q_INVOKABLE bool equals(QDeclarativeGeoRoute *other) const;
98 
99 Q_SIGNALS:
100     void pathChanged();
101 
102 private:
103     static void segments_append(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop, QDeclarativeGeoRouteSegment *segment);
104     static int segments_count(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop);
105     static QDeclarativeGeoRouteSegment *segments_at(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop, int index);
106     static void segments_clear(QQmlListProperty<QDeclarativeGeoRouteSegment> *prop);
107 
108     void initSegments(unsigned int lastIndex = ~0U);
109     QList<QGeoCoordinate> routePath();
110 
111     QGeoRoute route_;
112     QDeclarativeGeoRouteQuery *routeQuery_ = nullptr;
113     QList<QDeclarativeGeoRouteSegment *> segments_;
114     QList<QObject *> legs_;
115     bool segmentsDirty_ = true;
116     QQmlPropertyMap *m_extendedAttributes = nullptr;
117 
118     friend class QDeclarativeRouteMapItem;
119 };
120 
121 class Q_LOCATION_PRIVATE_EXPORT QDeclarativeGeoRouteLeg : public QDeclarativeGeoRoute
122 {
123     Q_OBJECT
124 
125     Q_PROPERTY(int legIndex READ legIndex CONSTANT)
126     Q_PROPERTY(QObject * overallRoute READ overallRoute CONSTANT)
127 
128 public:
129     explicit QDeclarativeGeoRouteLeg(QObject *parent = nullptr);
130     QDeclarativeGeoRouteLeg(const QGeoRouteLeg &routeLeg, QObject *parent = nullptr);
131     ~QDeclarativeGeoRouteLeg() override;
132 
133     int legIndex() const;
134     QObject *overallRoute() const;
135 
136 private:
137     QGeoRouteLeg m_routeLeg;
138 };
139 
140 QT_END_NAMESPACE
141 
142 #endif
143