QGeoPolygon Class

The QGeoPolygon class defines a geographic polygon. More...

Header: #include <QGeoPolygon>
qmake: QT += positioning
Since: Qt 5.10
Inherits: QGeoShape

Public Functions

QGeoPolygon()
QGeoPolygon(const QList<QGeoCoordinate> &path)
QGeoPolygon(const QGeoPolygon &other)
QGeoPolygon(const QGeoShape &other)
~QGeoPolygon()
void addCoordinate(const QGeoCoordinate &coordinate)
bool containsCoordinate(const QGeoCoordinate &coordinate) const
QGeoCoordinate coordinateAt(int index) const
void insertCoordinate(int index, const QGeoCoordinate &coordinate)
double length(int indexFrom = 0, int indexTo = -1) const
const QList<QGeoCoordinate> &path() const
void removeCoordinate(const QGeoCoordinate &coordinate)
void removeCoordinate(int index)
void replaceCoordinate(int index, const QGeoCoordinate &coordinate)
void setPath(const QList<QGeoCoordinate> &path)
int size() const
QString toString() const
void translate(double degreesLatitude, double degreesLongitude)
QGeoPolygon translated(double degreesLatitude, double degreesLongitude) const
bool operator!=(const QGeoPolygon &other) const
QGeoPolygon &operator=(const QGeoPolygon &other)
bool operator==(const QGeoPolygon &other) const
  • 10 public functions inherited from QGeoShape

Additional Inherited Members

Detailed Description

The QGeoPolygon class defines a geographic polygon.

The polygon is defined by an ordered list of QGeoCoordinates representing its perimeter.

Each two adjacent elements in this list 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 date line 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.

Member Function Documentation

QGeoPolygon::QGeoPolygon()

Constructs a new, empty geo path.

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

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

QGeoPolygon::QGeoPolygon(const QGeoPolygon &other)

Constructs a new geo path from the contents of other.

QGeoPolygon::QGeoPolygon(const QGeoShape &other)

Constructs a new geo path from the contents of other.

QGeoPolygon::~QGeoPolygon()

Destroys this path.

void QGeoPolygon::addCoordinate(const QGeoCoordinate &coordinate)

Appends coordinate to the polygon.

bool QGeoPolygon::containsCoordinate(const QGeoCoordinate &coordinate) const

Returns true if the polygon's perimeter contains coordinate as one of the elements.

QGeoCoordinate QGeoPolygon::coordinateAt(int index) const

Returns the coordinate at index .

void QGeoPolygon::insertCoordinate(int index, const QGeoCoordinate &coordinate)

Inserts coordinate at the specified index.

double QGeoPolygon::length(int indexFrom = 0, int indexTo = -1) const

Returns the length of the polygon's perimeter, 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.

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

Returns all the elements. Equivalent to QGeoShape::center(). The center coordinate, in case of a QGeoPolygon, is the center of its bounding box.

See also setPath().

void QGeoPolygon::removeCoordinate(const QGeoCoordinate &coordinate)

Removes the last occurrence of coordinate from the polygon.

void QGeoPolygon::removeCoordinate(int index)

Removes element at position index from the polygon.

void QGeoPolygon::replaceCoordinate(int index, const QGeoCoordinate &coordinate)

Replaces the path element at the specified index with coordinate.

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

See also path().

int QGeoPolygon::size() const

Returns the number of elements in the polygon.

This function was introduced in Qt 5.10.

QString QGeoPolygon::toString() const

Returns the geo path properties as a string.

void QGeoPolygon::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.

QGeoPolygon QGeoPolygon::translated(double degreesLatitude, double degreesLongitude) const

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

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

See also translate().

bool QGeoPolygon::operator!=(const QGeoPolygon &other) const

Returns whether this geo path is not equal to other.

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

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

bool QGeoPolygon::operator==(const QGeoPolygon &other) const

Returns whether this geo path is equal to other.

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.