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 QGEOMANEUVER_H
38 #define QGEOMANEUVER_H
39 
40 #include <QtCore/qshareddata.h>
41 #include <QtLocation/qlocationglobal.h>
42 #include <QtCore/qvariant.h>
43 
44 QT_BEGIN_NAMESPACE
45 
46 class QString;
47 
48 class QGeoCoordinate;
49 class QGeoManeuverPrivate;
50 
51 class Q_LOCATION_EXPORT QGeoManeuver
52 {
53 
54 public:
55     enum InstructionDirection {
56         NoDirection,
57         DirectionForward,
58         DirectionBearRight,
59         DirectionLightRight,
60         DirectionRight,
61         DirectionHardRight,
62         DirectionUTurnRight,
63         DirectionUTurnLeft,
64         DirectionHardLeft,
65         DirectionLeft,
66         DirectionLightLeft,
67         DirectionBearLeft
68     };
69 
70     QGeoManeuver();
71     QGeoManeuver(const QGeoManeuver &other);
72     ~QGeoManeuver();
73 
74     QGeoManeuver &operator= (const QGeoManeuver &other);
75 
76     bool operator== (const QGeoManeuver &other) const;
77     bool operator!= (const QGeoManeuver &other) const;
78 
79     bool isValid() const;
80 
81     void setPosition(const QGeoCoordinate &position);
82     QGeoCoordinate position() const;
83 
84     void setInstructionText(const QString &instructionText);
85     QString instructionText() const;
86 
87     void setDirection(InstructionDirection direction);
88     InstructionDirection direction() const;
89 
90     void setTimeToNextInstruction(int secs);
91     int timeToNextInstruction() const;
92 
93     void setDistanceToNextInstruction(qreal distance);
94     qreal distanceToNextInstruction() const;
95 
96     void setWaypoint(const QGeoCoordinate &coordinate);
97     QGeoCoordinate waypoint() const;
98 
99     void setExtendedAttributes(const QVariantMap &extendedAttributes);
100     QVariantMap extendedAttributes() const;
101 
102 protected:
103     QGeoManeuver(const QSharedDataPointer<QGeoManeuverPrivate> &dd);
104 
105 private:
106     QSharedDataPointer<QGeoManeuverPrivate> d_ptr;
107 };
108 
109 QT_END_NAMESPACE
110 
111 #endif
112