Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qgeoroute.h
Go to the documentation of this file.
1// Copyright (C) 2015 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QGEOROUTE_H
5#define QGEOROUTE_H
6
7#include <QtLocation/QGeoRouteRequest>
8
9#include <QtCore/QObject>
10#include <QtCore/QExplicitlySharedDataPointer>
11#include <QtCore/QList>
12
13#include "QtQml/qqml.h"
14
15QT_BEGIN_NAMESPACE
16
17class QGeoCoordinate;
18class QGeoRectangle;
19class QGeoRouteSegment;
20
21class QGeoRoutePrivate;
22QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QGeoRoutePrivate, Q_LOCATION_EXPORT)
23class Q_LOCATION_EXPORT QGeoRoute
24{
25 Q_GADGET
26 QML_VALUE_TYPE(route)
27 QML_STRUCTURED_VALUE
28
29 Q_PROPERTY(QString routeId READ routeId CONSTANT)
30 Q_PROPERTY(QGeoRectangle bounds READ bounds CONSTANT)
31 Q_PROPERTY(int travelTime READ travelTime CONSTANT)
32 Q_PROPERTY(qreal distance READ distance CONSTANT)
33 Q_PROPERTY(QList<QGeoCoordinate> path READ path WRITE setPath)
34 Q_PROPERTY(QList<QGeoRoute> routeLegs READ routeLegs CONSTANT)
35 Q_PROPERTY(QVariantMap extendedAttributes READ extendedAttributes CONSTANT)
36 Q_PROPERTY(int legIndex READ legIndex CONSTANT)
37 Q_PROPERTY(QGeoRoute overallRoute READ overallRoute CONSTANT)
38 Q_PROPERTY(qsizetype segmentsCount READ segmentsCount CONSTANT)
39 Q_PROPERTY(QList<QGeoRouteSegment> segments READ segments CONSTANT)
40
41public:
42 QGeoRoute();
43 QGeoRoute(const QGeoRoute &other) noexcept;
44 QGeoRoute(QGeoRoute &&other) noexcept = default;
45 ~QGeoRoute();
46
47 QGeoRoute &operator=(const QGeoRoute &other) noexcept;
48 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP(QGeoRoute)
49
50 void swap(QGeoRoute &other) noexcept { d_ptr.swap(other.d_ptr); }
51
52 friend inline bool operator==(const QGeoRoute &lhs, const QGeoRoute &rhs) noexcept
53 { return lhs.isEqual(rhs); }
54 friend inline bool operator!=(const QGeoRoute &lhs, const QGeoRoute &rhs) noexcept
55 { return !lhs.isEqual(rhs); }
56
57 void setRouteId(const QString &id);
58 QString routeId() const;
59
60 void setRequest(const QGeoRouteRequest &request);
61 QGeoRouteRequest request() const;
62
63 void setBounds(const QGeoRectangle &bounds);
64 QGeoRectangle bounds() const;
65
66 void setFirstRouteSegment(const QGeoRouteSegment &routeSegment);
67 QGeoRouteSegment firstRouteSegment() const;
68 qsizetype segmentsCount() const;
69 QList<QGeoRouteSegment> segments() const;
70
71 void setTravelTime(int secs);
72 int travelTime() const;
73
74 void setDistance(qreal distance);
75 qreal distance() const;
76
77 void setTravelMode(QGeoRouteRequest::TravelMode mode);
78 QGeoRouteRequest::TravelMode travelMode() const;
79
80 void setPath(const QList<QGeoCoordinate> &path);
81 QList<QGeoCoordinate> path() const;
82
83 void setRouteLegs(const QList<QGeoRoute> &legs);
84 QList<QGeoRoute> routeLegs() const;
85
86 void setExtendedAttributes(const QVariantMap &extendedAttributes);
87 QVariantMap extendedAttributes() const;
88
89 void setLegIndex(int idx);
90 int legIndex() const;
91
92 void setOverallRoute(const QGeoRoute &route);
93 QGeoRoute overallRoute() const;
94
95protected:
96 QExplicitlySharedDataPointer<QGeoRoutePrivate> &d();
97 const QExplicitlySharedDataPointer<QGeoRoutePrivate> &const_d() const;
98
99private:
100 QExplicitlySharedDataPointer<QGeoRoutePrivate> d_ptr;
101 bool isEqual(const QGeoRoute &other) const noexcept;
102
103 friend class QDeclarativeGeoRoute;
104 friend class QGeoRoutePrivate;
105};
106
107QT_END_NAMESPACE
108
109#endif
QGeoRoute
\inmodule QtLocation
Definition qgeoroute.h:24