1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qdeclarativegeomaneuver_p.h"
QT_BEGIN_NAMESPACE
/*!
\qmltype RouteManeuver
\instantiates QDeclarativeGeoManeuver
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-routing
\since QtLocation 5.5
\brief The RouteManeuver type represents the information relevant to the
point at which two RouteSegments meet.
RouteSegment instances can be thought of as edges on a routing
graph, with RouteManeuver instances as optional labels attached to the
vertices of the graph.
The most interesting information held in a RouteManeuver instance is
normally the textual navigation to provide and the position at which to
provide it, accessible by \l instructionText and \l position respectively.
\section1 Example
The following QML snippet demonstrates how to print information about a
route maneuver:
\snippet declarative/routing.qml QtQuick import
\snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/routing.qml RouteManeuver
*/
QDeclarativeGeoManeuver::QDeclarativeGeoManeuver(QObject *parent)
: QObject(parent)
{
}
QDeclarativeGeoManeuver::QDeclarativeGeoManeuver(const QGeoManeuver &maneuver, QObject *parent)
: QObject(parent),
maneuver_(maneuver)
{
}
QDeclarativeGeoManeuver::~QDeclarativeGeoManeuver() {}
/*!
\qmlproperty bool RouteManeuver::valid
This read-only property holds whether this maneuver is valid or not.
Invalid maneuvers are used when there is no information
that needs to be attached to the endpoint of a QGeoRouteSegment instance.
*/
bool QDeclarativeGeoManeuver::valid() const
{
return maneuver_.isValid();
}
/*!
\qmlproperty coordinate RouteManeuver::position
This read-only property holds where the \l instructionText should be displayed.
*/
QGeoCoordinate QDeclarativeGeoManeuver::position() const
{
return maneuver_.position();
}
/*!
\qmlproperty string RouteManeuver::instructionText
This read-only property holds textual navigation instruction.
*/
QString QDeclarativeGeoManeuver::instructionText() const
{
return maneuver_.instructionText();
}
/*!
\qmlproperty enumeration RouteManeuver::direction
Describes the change in direction associated with the instruction text
that is associated with a RouteManeuver.
\list
\li RouteManeuver.NoDirection - There is no direction associated with the instruction text
\li RouteManeuver.DirectionForward - The instruction indicates that the direction of travel does not need to change
\li RouteManeuver.DirectionBearRight - The instruction indicates that the direction of travel should bear to the right
\li RouteManeuver.DirectionLightRight - The instruction indicates that a light turn to the right is required
\li RouteManeuver.DirectionRight - The instruction indicates that a turn to the right is required
\li RouteManeuver.DirectionHardRight - The instruction indicates that a hard turn to the right is required
\li RouteManeuver.DirectionUTurnRight - The instruction indicates that a u-turn to the right is required
\li RouteManeuver.DirectionUTurnLeft - The instruction indicates that a u-turn to the left is required
\li RouteManeuver.DirectionHardLeft - The instruction indicates that a hard turn to the left is required
\li RouteManeuver.DirectionLeft - The instruction indicates that a turn to the left is required
\li RouteManeuver.DirectionLightLeft - The instruction indicates that a light turn to the left is required
\li RouteManeuver.DirectionBearLeft - The instruction indicates that the direction of travel should bear to the left
\endlist
*/
QDeclarativeGeoManeuver::Direction QDeclarativeGeoManeuver::direction() const
{
return QDeclarativeGeoManeuver::Direction(maneuver_.direction());
}
/*!
\qmlproperty int RouteManeuver::timeToNextInstruction
This read-only property holds the estimated time it will take to travel
from the point at which the associated instruction was issued and the
point that the next instruction should be issued, in seconds.
*/
int QDeclarativeGeoManeuver::timeToNextInstruction() const
{
return maneuver_.timeToNextInstruction();
}
/*!
\qmlproperty real RouteManeuver::distanceToNextInstruction
This read-only property holds the distance, in meters, between the point at which
the associated instruction was issued and the point that the next instruction should
be issued.
*/
qreal QDeclarativeGeoManeuver::distanceToNextInstruction() const
{
return maneuver_.distanceToNextInstruction();
}
/*!
\qmlproperty coordinate RouteManeuver::waypoint
This property holds the waypoint associated with this maneuver.
All maneuvers do not have a waypoint associated with them, this
can be checked with \l waypointValid.
*/
QGeoCoordinate QDeclarativeGeoManeuver::waypoint() const
{
return maneuver_.waypoint();
}
/*!
\qmlproperty Object RouteManeuver::extendedAttributes
This property holds the extended attributes of the maneuver and is a map.
These attributes are plugin specific, and can be empty.
Consult the \l {Qt Location#Plugin References and Parameters}{plugin documentation}
for what attributes are supported and how they should be used.
Note, due to limitations of the QQmlPropertyMap, it is not possible
to declaratively specify the attributes in QML, assignment of attributes keys
and values can only be accomplished by JavaScript.
\since QtLocation 5.11
*/
QQmlPropertyMap *QDeclarativeGeoManeuver::extendedAttributes() const
{
if (!m_extendedAttributes) {
QDeclarativeGeoManeuver *self = const_cast<QDeclarativeGeoManeuver *>(this);
self->m_extendedAttributes = new QQmlPropertyMap(self);
// Fill it
const QStringList keys = maneuver_.extendedAttributes().keys();
for (const QString &key: keys) {
self->m_extendedAttributes->insert(key,
maneuver_.extendedAttributes().value(key));
}
}
return m_extendedAttributes;
}
/*!
\qmlproperty bool RouteManeuver::waypointValid
This read-only property holds whether this \l waypoint, associated with this
maneuver, is valid or not.
*/
bool QDeclarativeGeoManeuver::waypointValid() const
{
return maneuver_.waypoint().isValid();
}
QT_END_NAMESPACE
|
