QGeoRectangle

The QGeoRectangle class defines a rectangular geographic area. More

Inheritance diagram of PySide6.QtPositioning.QGeoRectangle

Synopsis

Functions

Detailed Description

The rectangle is defined in terms of a QGeoCoordinate which specifies the top left coordinate of the rectangle and a QGeoCoordinate which specifies the bottom right coordinate of the rectangle.

A geo rectangle is considered invalid if the top left or bottom right coordinates are invalid or if the top left coordinate is south of the bottom right coordinate.

Geo rectangles can never cross the poles.

Several methods behave as though the geo rectangle is defined in terms of a center coordinate, the width of the geo rectangle in degrees and the height of the geo rectangle in degrees.

If the height or center of a geo rectangle is adjusted such that it would cross one of the poles the height is modified such that the geo rectangle touches but does not cross the pole and that the center coordinate is still in the center of the geo rectangle.

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

class PySide6.QtPositioning.QGeoRectangle

PySide6.QtPositioning.QGeoRectangle(center, degreesWidth, degreesHeight)

PySide6.QtPositioning.QGeoRectangle(topLeft, bottomRight)

PySide6.QtPositioning.QGeoRectangle(other)

PySide6.QtPositioning.QGeoRectangle(other)

PySide6.QtPositioning.QGeoRectangle(coordinates)

Parameters

Constructs a new, invalid geo rectangle.

Constructs a new geo rectangle centered at center with a width in degrees of degreesWidth and a height in degrees of degreesHeight.

If degreesHeight would take the geo rectangle beyond one of the poles, the height of the geo rectangle will be truncated such that the geo rectangle only extends up to the pole. The center of the geo rectangle will be unchanged, and the height will be adjusted such that the center point is at the center of the truncated geo rectangle.

Constructs a new geo rectangle with a top left coordinate topLeft and a bottom right coordinate bottomRight.

PySide6.QtPositioning.QGeoRectangle.bottomLeft()
Return type

PySide6.QtPositioning.QGeoCoordinate

Returns the bottom left coordinate of this geo rectangle.

See also

setBottomLeft()

PySide6.QtPositioning.QGeoRectangle.bottomRight()
Return type

PySide6.QtPositioning.QGeoCoordinate

Returns the bottom right coordinate of this geo rectangle.

See also

setBottomRight()

PySide6.QtPositioning.QGeoRectangle.contains(rectangle)
Parameters

rectanglePySide6.QtPositioning.QGeoRectangle

Return type

bool

Returns whether the geo rectangle rectangle is contained within this geo rectangle.

PySide6.QtPositioning.QGeoRectangle.extendRectangle(coordinate)
Parameters

coordinatePySide6.QtPositioning.QGeoCoordinate

Extends the geo rectangle to also cover the coordinate coordinate

PySide6.QtPositioning.QGeoRectangle.height()
Return type

double

Returns the height of this geo rectangle in degrees.

The return value is undefined if this geo rectangle is invalid.

See also

setHeight()

PySide6.QtPositioning.QGeoRectangle.intersects(rectangle)
Parameters

rectanglePySide6.QtPositioning.QGeoRectangle

Return type

bool

Returns whether the geo rectangle rectangle intersects this geo rectangle.

If the top or bottom edges of both geo rectangles are at one of the poles the geo rectangles are considered to be intersecting, since the longitude is irrelevant when the edges are at the pole.

PySide6.QtPositioning.QGeoRectangle.__or__(rectangle)
Parameters

rectanglePySide6.QtPositioning.QGeoRectangle

Return type

PySide6.QtPositioning.QGeoRectangle

PySide6.QtPositioning.QGeoRectangle.__ior__(rectangle)
Parameters

rectanglePySide6.QtPositioning.QGeoRectangle

Return type

PySide6.QtPositioning.QGeoRectangle

Returns the smallest geo rectangle which contains both this geo rectangle and rectangle.

If the centers of the two geo rectangles are separated by exactly 180.0 degrees then the width is set to 360.0 degrees with the leftmost longitude set to -180.0 degrees and the rightmost longitude set to 180.0 degrees. This is done to ensure that the result is independent of the order of the operands.

PySide6.QtPositioning.QGeoRectangle.setBottomLeft(bottomLeft)
Parameters

bottomLeftPySide6.QtPositioning.QGeoCoordinate

Sets the bottom left coordinate of this geo rectangle to bottomLeft.

See also

bottomLeft()

PySide6.QtPositioning.QGeoRectangle.setBottomRight(bottomRight)
Parameters

bottomRightPySide6.QtPositioning.QGeoCoordinate

Sets the bottom right coordinate of this geo rectangle to bottomRight.

See also

bottomRight()

PySide6.QtPositioning.QGeoRectangle.setCenter(center)
Parameters

centerPySide6.QtPositioning.QGeoCoordinate

Sets the center of this geo rectangle to center.

If this causes the geo rectangle to cross on of the poles the height of the geo rectangle will be truncated such that the geo rectangle only extends up to the pole. The center of the geo rectangle will be unchanged, and the height will be adjusted such that the center point is at the center of the truncated geo rectangle.

See also

center()

PySide6.QtPositioning.QGeoRectangle.setHeight(degreesHeight)
Parameters

degreesHeightdouble

Sets the height of this geo rectangle in degrees to degreesHeight.

See also

height()

PySide6.QtPositioning.QGeoRectangle.setTopLeft(topLeft)
Parameters

topLeftPySide6.QtPositioning.QGeoCoordinate

Sets the top left coordinate of this geo rectangle to topLeft.

See also

topLeft()

PySide6.QtPositioning.QGeoRectangle.setTopRight(topRight)
Parameters

topRightPySide6.QtPositioning.QGeoCoordinate

Sets the top right coordinate of this geo rectangle to topRight.

See also

topRight()

PySide6.QtPositioning.QGeoRectangle.setWidth(degreesWidth)
Parameters

degreesWidthdouble

Sets the width of this geo rectangle in degrees to degreesWidth.

See also

width()

PySide6.QtPositioning.QGeoRectangle.topLeft()
Return type

PySide6.QtPositioning.QGeoCoordinate

Returns the top left coordinate of this geo rectangle.

See also

setTopLeft()

PySide6.QtPositioning.QGeoRectangle.topRight()
Return type

PySide6.QtPositioning.QGeoCoordinate

Returns the top right coordinate of this geo rectangle.

See also

setTopRight()

PySide6.QtPositioning.QGeoRectangle.translate(degreesLatitude, degreesLongitude)
Parameters
  • degreesLatitudedouble

  • degreesLongitudedouble

Translates this geo rectangle by degreesLatitude northwards and degreesLongitude eastwards.

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

If the translation would have caused the geo rectangle to cross a pole the geo rectangle will be translated until the top or bottom edge of the geo rectangle touches the pole but not further.

PySide6.QtPositioning.QGeoRectangle.translated(degreesLatitude, degreesLongitude)
Parameters
  • degreesLatitudedouble

  • degreesLongitudedouble

Return type

PySide6.QtPositioning.QGeoRectangle

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

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

See also

translate()

PySide6.QtPositioning.QGeoRectangle.united(rectangle)
Parameters

rectanglePySide6.QtPositioning.QGeoRectangle

Return type

PySide6.QtPositioning.QGeoRectangle

Returns the smallest geo rectangle which contains both this geo rectangle and rectangle.

If the centers of the two geo rectangles are separated by exactly 180.0 degrees then the width is set to 360.0 degrees with the leftmost longitude set to -180.0 degrees and the rightmost longitude set to 180.0 degrees. This is done to ensure that the result is independent of the order of the operands.

PySide6.QtPositioning.QGeoRectangle.width()
Return type

double

Returns the width of this geo rectangle in degrees.

The return value is undefined if this geo rectangle is invalid.

See also

setWidth()