PySide6.QtLocation.QGeoRoute¶

class QGeoRoute¶

The QGeoRoute class represents a route between two points. More…

Synopsis¶

Properties¶

boundsᅟ - The bounding box which encompasses the entire route
distanceᅟ - The distance covered by this route, in meters
extendedAttributesᅟ - The extended attributes associated with this route
legIndexᅟ - The leg index of this route
overallRouteᅟ - The route that contains this route leg
pathᅟ - The geometric shape of the route
routeIdᅟ - The identifier of this route
routeLegsᅟ - The route legs for a multi-waypoint route
segmentsᅟ - The list of QGeoRouteSegment objects of this route
segmentsCountᅟ - The number of segments in the route
travelTimeᅟ - The estimated amount of time it will take to traverse this route, in seconds

Methods¶

def __init__()
def bounds()
def distance()
def extendedAttributes()
def firstRouteSegment()
def legIndex()
def __ne__()
def __eq__()
def overallRoute()
def path()
def request()
def routeId()
def routeLegs()
def segments()
def segmentsCount()
def setBounds()
def setDistance()
def setExtendedAttributes()
def setFirstRouteSegment()
def setLegIndex()
def setOverallRoute()
def setPath()
def setRequest()
def setRouteId()
def setRouteLegs()
def setTravelMode()
def setTravelTime()
def swap()
def travelMode()
def travelTime()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

A QGeoRoute object contains high level information about a route, such as the length the route, the estimated travel time for the route, and enough information to render a basic image of the route on a map.

The QGeoRoute object also contains a list of QGeoRouteSegment objecs which describe subsections of the route in greater detail.

Routing information is normally requested using calculateRoute() , which returns a QGeoRouteReply instance. If the operation is completed successfully the routing information can be accessed with routes()

See also

QGeoRoutingManager

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property boundsᅟ: QGeoRectangle¶

This property holds the bounding box which encompasses the entire route.

Access functions:

bounds()

property distanceᅟ: float¶

This property holds the distance covered by this route, in meters.

Access functions:

distance()

property extendedAttributesᅟ: Dictionary with keys of type .QString and values of type QVariant.¶

This property holds the extended attributes associated with this route.

Access functions:

extendedAttributes()

property legIndexᅟ: int¶

This property holds the leg index of this route.

The index of the leg inside the containing routeLegs list can be used to find the next legs.

Access functions:

legIndex()

property overallRouteᅟ: QGeoRoute¶

This property holds the route that contains this route leg.

This this route is not a leg within an overall route, then this property holds an empty route.

Access functions:

overallRoute()

property pathᅟ: list of QGeoCoordinate¶

This property holds the geometric shape of the route.

The coordinates should be listed in the order in which they would be traversed by someone traveling along this segment of the route.

Access functions:

path()
setPath()

property routeIdᅟ: str¶

This property holds the identifier of this route.

Service providers which support the updating of routes commonly assign identifiers to routes. If this route came from such a service provider, then changing the identifier will probably cause route updates to stop working.

Access functions:

routeId()

property routeLegsᅟ: list of QGeoRoute¶

This property holds the route legs for a multi-waypoint route.

Access functions:

routeLegs()

property segmentsᅟ: list of QGeoRouteSegment¶

This property holds the list of QGeoRouteSegment objects of this route.

Access functions:

segments()

property segmentsCountᅟ: int¶

This property holds the number of segments in the route.

Access functions:

segmentsCount()

property travelTimeᅟ: int¶

This property holds the estimated amount of time it will take to traverse this route, in seconds.

Access functions:

travelTime()

__init__()¶

Constructs a route object.

__init__(other)

Parameters:: other – QGeoRoute

Constructs a route object from the contents of other.

bounds()¶

Return type:: QGeoRectangle

Getter of property boundsᅟ .

distance()¶

Return type:: float

Getter of property distanceᅟ .

extendedAttributes()¶

Return type:: Dictionary with keys of type .QString and values of type QVariant.

Getter of property extendedAttributesᅟ .

firstRouteSegment()¶

Return type:: QGeoRouteSegment

Returns the first route segment in the route.

Will return an invalid route segment if there are no route segments associated with the route.

The remaining route segments can be accessed sequentially with nextRouteSegment .

See also

setFirstRouteSegment()

legIndex()¶

Return type:: int

Getter of property legIndexᅟ .

__ne__(rhs)¶

Parameters:: rhs – QGeoRoute
Return type:: bool

Returns whether the routes lhs and rhs are not equal.

__eq__(rhs)¶

Parameters:: rhs – QGeoRoute
Return type:: bool

Returns whether the routes lhs and rhs are equal.

overallRoute()¶

Return type:: QGeoRoute

Getter of property overallRouteᅟ .

path()¶

Return type:: .list of QGeoCoordinate