PySide6.QtPositioning.QGeoPath¶

class QGeoPath¶

The QGeoPath class defines a geographic path. More…

Synopsis¶

Properties¶

pathᅟ - This property holds the list of coordinates for the geo path
widthᅟ - The width of the path in meters

Methods¶

def __init__()
def addCoordinate()
def clearPath()
def containsCoordinate()
def coordinateAt()
def insertCoordinate()
def length()
def path()
def removeCoordinate()
def replaceCoordinate()
def setPath()
def setVariantPath()
def setWidth()
def size()
def translate()
def translated()
def variantPath()
def width()

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¶

The path is defined by an ordered list of QGeoCoordinate objects.

Each two adjacent elements in the path are intended to be connected together by the shortest line segment of constant bearing passing through both elements. This type of connection can cross the dateline in the longitudinal direction, but never crosses the poles.

This is relevant for the calculation of the bounding box returned by boundingGeoRectangle() for this shape, which will have the latitude of the top left corner set to the maximum latitude in the path point set. Similarly, the latitude of the bottom right corner will be the minimum latitude in the path point set.

This class is a Q_GADGET. It can be directly used from C++ and QML .

A QGeoPath is both invalid and empty if it contains no coordinate.

Note

A default constructed QGeoPath is both invalid and empty as it does not contain any coordinates.

Note

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

property pathᅟ: list of QVariant¶

This property holds This property holds the list of coordinates for the geo path..

Note

The coordinates cannot be processed in place. To change the value of this property, retrieve the complete list of coordinates, process them, and assign the new value to the property.

Access functions:

variantPath()
setVariantPath()

property widthᅟ: float¶

This property holds the width of the path in meters..

Access functions:

width()
setWidth()

__init__()¶

Constructs a new, empty geo path.

__init__(other)

Parameters:: other – QGeoPath

Constructs a new geo path from the contents of other.

__init__(other)

Parameters:: other – QGeoShape

Constructs a new geo path from the contents of other.

__init__(path[, width=0.0])

Parameters:

path – .list of QGeoCoordinate
width – float

Constructs a new geo path from a list of coordinates (path and width).

addCoordinate(coordinate)¶

Parameters:: coordinate – QGeoCoordinate

Appends coordinate to the path.

clearPath()¶

Clears the path.

containsCoordinate(coordinate)¶

Parameters:: coordinate – QGeoCoordinate
Return type:: bool

Returns true if the path contains coordinate as one of the elements.

coordinateAt(index)¶

Parameters:: index – int
Return type:: QGeoCoordinate

Returns the coordinate at index .

insertCoordinate(index, coordinate)¶

Parameters:

index – int
coordinate – QGeoCoordinate

Inserts coordinate at the specified index.

length([indexFrom=0[, indexTo=-1]])¶

Parameters:

indexFrom – int
indexTo – int

Return type:

float

Returns the length of the path, in meters, from the element indexFrom to the element indexTo. The length is intended to be the sum of the shortest distances for each pair of adjacent points.

If indexTo is -1 (the default value), the length will be including the distance between last coordinate and the first (closed loop). To retrieve the length for the path, use 0 for indexFrom and size() - 1 for indexTo.

path()¶

Return type:: .list of QGeoCoordinate

Returns all the elements of the path.

See also

setPath()

removeCoordinate(coordinate)¶

Parameters:: coordinate – QGeoCoordinate

Removes the last occurrence of coordinate from the path.

removeCoordinate(index)

Parameters:: index – int

Removes element at position index from the path.

replaceCoordinate(index, coordinate)¶

Parameters:

index – int
coordinate – QGeoCoordinate

Replaces the path element at the specified index with coordinate.

setPath(path)¶

Parameters:: path – .list of QGeoCoordinate

Sets all the elements of the path.

See also

path()

setVariantPath(path)¶

Parameters:: path – .list of QVariant

Setter of property pathᅟ .

setWidth(width)¶

Parameters:: width – float