QGeoManeuver Class▲
-
Header: QGeoManeuver
-
qmake: QT += location
-
Group: QGeoManeuver is part of QtLocation-routing
I. Detailed Description▲
QGeoRouteSegment instances can be thought of as edges on a routing graph, with QGeoManeuver instances as optional labels attached to the vertices of the graph.
The most interesting information help in a QGeoManeuver instance is normally the textual navigation to provide and the position at which to provide it, accessible by instructionText() and position() respectively.
It is also possible to determine if a routing waypoint has been passed by checking if waypoint() returns a valid QGeoCoordinate.
II. Member Type Documentation▲
II-1. enum QGeoManeuver::InstructionDirection▲
Describes the change in direction associated with the instruction text that is associated with a QGeoManaeuver.
|
Constant |
Value |
Description |
|---|---|---|
|
QGeoManeuver::NoDirection |
0 |
There is no direction associated with the instruction text. |
|
QGeoManeuver::DirectionForward |
1 |
The instruction indicates that the direction of travel does not need to change. |
|
QGeoManeuver::DirectionBearRight |
2 |
The instruction indicates that the direction of travel should bear to the right. |
|
QGeoManeuver::DirectionLightRight |
3 |
The instruction indicates that a light turn to the right is required. |
|
QGeoManeuver::DirectionRight |
4 |
The instruction indicates that a turn to the right is required. |
|
QGeoManeuver::DirectionHardRight |
5 |
The instruction indicates that a hard turn to the right is required. |
|
QGeoManeuver::DirectionUTurnRight |
6 |
The instruction indicates that a u-turn to the right is required. |
|
QGeoManeuver::DirectionUTurnLeft |
7 |
The instruction indicates that a u-turn to the left is required. |
|
QGeoManeuver::DirectionHardLeft |
8 |
The instruction indicates that a hard turn to the left is required. |
|
QGeoManeuver::DirectionLeft |
9 |
The instruction indicates that a turn to the left is required. |
|
QGeoManeuver::DirectionLightLeft |
10 |
The instruction indicates that a light turn to the left is required. |
|
QGeoManeuver::DirectionBearLeft |
11 |
The instruction indicates that the direction of travel should bear to the left. |
III. Property Documentation▲
III-1. [read-only] direction : const InstructionDirection▲
This property holds the direction associated with the associated instruction.
Access functions:
-
direction() const
III-2. [read-only] distanceToNextInstruction : const qreal▲
This property holds the distance, in meters, between the point at which this instruction was issued, and the point at which the next instruction should be issued.
Access functions:
-
distanceToNextInstruction() const
III-3. [read-only, since QtLocation 5.11] extendedAttributes : const QVariantMap▲
This property holds the extended attributes associated with this maneuver.
This property was introduced in QtLocation 5.11.
Access functions:
-
QVariantMap extendedAttributes() const
III-4. [read-only] instructionText : const QString▲
This property holds the textual navigation instructions.
Access functions:
-
instructionText() const
III-5. [read-only] position : const QGeoCoordinate▲
This property holds the position where instructionText should be displayed.
Access functions:
-
position() const
III-6. [read-only] timeToNextInstruction : const int▲
This property holds the estimated time, in seconds, that it will take to travel from the point at which the associated instruction was issued to the point at which the next instruction should be issued.
Access functions:
-
int timeToNextInstruction() const
III-7. [read-only] valid : const bool▲
This 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.
Access functions:
-
bool isValid() const
III-8. [read-only] waypoint : const QGeoCoordinate▲
This property holds the waypoint associated with this maneuver.
If there is not waypoint associated with this maneuver, then this property holds an invalid QGeoCoordinate.
Access functions:
-
waypoint() const
IV. Member Function Documentation▲
IV-1. QGeoManeuver::QGeoManeuver()▲
Constructs a invalid maneuver object.
The maneuver will remain invalid until one of setPosition(), setInstructionText(), setDirection(), setTimeToNextInstruction(), setDistanceToNextInstruction() or setWaypoint() is called.
IV-2. QGeoManeuver::QGeoManeuver(const QGeoManeuver &other)▲
Constructs a maneuver object from the contents of other.
IV-3. QGeoManeuver::~QGeoManeuver()▲
Destroys this maneuver object.
IV-4. QGeoManeuver &QGeoManeuver::operator=(const QGeoManeuver &other)▲
Assigns other to this maneuver object and then returns a reference to this maneuver object.