QGeoPath Class

The QGeoPath class defines a geographic path. More...

Header:	#include <QGeoPath>
CMake:	find_package(Qt6 COMPONENTS Positioning REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Positioning)
qmake:	QT += positioning
Since:	Qt 5.9
Inherits:	QGeoShape

• List of all members, including inherited members

Properties

• path : const QVariantList
• width : qreal

Public Functions

	QGeoPath(const QGeoShape &other)
	QGeoPath(const QGeoPath &other)
	QGeoPath(const QList<QGeoCoordinate> &path, const qreal &width = 0.0)
	QGeoPath()
QGeoPath &	operator=(const QGeoPath &other)
	~QGeoPath()
void	addCoordinate(const QGeoCoordinate &coordinate)
void	clearPath()
bool	containsCoordinate(const QGeoCoordinate &coordinate) const
QGeoCoordinate	coordinateAt(qsizetype index) const
void	insertCoordinate(qsizetype index, const QGeoCoordinate &coordinate)
double	length(qsizetype indexFrom = 0, qsizetype indexTo = -1) const
const QList<QGeoCoordinate> &	path() const
void	removeCoordinate(const QGeoCoordinate &coordinate)
void	removeCoordinate(qsizetype index)
void	replaceCoordinate(qsizetype index, const QGeoCoordinate &coordinate)
void	setPath(const QList<QGeoCoordinate> &path)
void	setWidth(const qreal &width)
qsizetype	size() const
QString	toString() const
void	translate(double degreesLatitude, double degreesLongitude)
QGeoPath	translated(double degreesLatitude, double degreesLongitude) const
qreal	width() const

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 QGeoShape::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.

Member Function Documentation

QGeoPath::QGeoPath(const QGeoShape &other)

Constructs a new geo path from the contents of other.

QGeoPath::QGeoPath(const QGeoPath &other)

Constructs a new geo path from the contents of other.

QGeoPath::QGeoPath(const QList<QGeoCoordinate> &path, const qreal &width = 0.0)

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

QGeoPath::QGeoPath()

Constructs a new, empty geo path.

QGeoPath &QGeoPath::operator=(const QGeoPath &other)

Assigns other to this geo path and returns a reference to this geo path.

QGeoPath::~QGeoPath()

Destroys this path.

[invokable] void QGeoPath::addCoordinate(const QGeoCoordinate &coordinate)

Appends coordinate to the path.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[since 5.12] void QGeoPath::clearPath()

Clears the path.

This function was introduced in Qt 5.12.

[invokable] bool QGeoPath::containsCoordinate(const QGeoCoordinate &coordinate) const

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

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] QGeoCoordinate QGeoPath::coordinateAt(qsizetype index) const

Returns the coordinate at index .

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QGeoPath::insertCoordinate(qsizetype index, const QGeoCoordinate &coordinate)

Inserts coordinate at the specified index.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] double QGeoPath::length(qsizetype indexFrom = 0, qsizetype indexTo = -1) const

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 QGeoPath::size() - 1 for indexTo.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

const QList<QGeoCoordinate> &QGeoPath::path() const

Returns all the elements of the path.

See also setPath().

[invokable] void QGeoPath::removeCoordinate(const QGeoCoordinate &coordinate)

Removes the last occurrence of coordinate from the path.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QGeoPath::removeCoordinate(qsizetype index)

Removes element at position index from the path.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QGeoPath::replaceCoordinate(qsizetype index, const QGeoCoordinate &coordinate)

Replaces the path element at the specified index with coordinate.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

void QGeoPath::setPath(const QList<QGeoCoordinate> &path)

Sets all the elements of the path.

See also path().

[invokable, since 5.10] qsizetype QGeoPath::size() const

Returns the number of elements in the path.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

This function was introduced in Qt 5.10.

[invokable] QString QGeoPath::toString() const

Returns the geo path properties as a string.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] void QGeoPath::translate(double degreesLatitude, double degreesLongitude)

Translates this geo path by degreesLatitude northwards and degreesLongitude eastwards.

Negative values of degreesLatitude and degreesLongitude correspond to southward and westward translation respectively.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

[invokable] QGeoPath QGeoPath::translated(double degreesLatitude, double degreesLongitude) const

Returns a copy of this geo path translated by degreesLatitude northwards and degreesLongitude eastwards.

Negative values of degreesLatitude and degreesLongitude correspond to southward and westward translation respectively.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

See also translate().

qreal QGeoPath::width() const

Returns the width of the path, in meters. This information is used in the contains method. The default value is 0.

Note: Getter function for property width.

See also setWidth().