QGeoRectangle¶
The QGeoRectangle
class defines a rectangular geographic area. More…
Synopsis¶
Functions¶
def
__ior__
(rectangle)def
__or__
(rectangle)def
bottomLeft
()def
bottomRight
()def
contains
(rectangle)def
extendRectangle
(coordinate)def
height
()def
intersects
(rectangle)def
setBottomLeft
(bottomLeft)def
setBottomRight
(bottomRight)def
setCenter
(center)def
setHeight
(degreesHeight)def
setTopLeft
(topLeft)def
setTopRight
(topRight)def
setWidth
(degreesWidth)def
topLeft
()def
topRight
()def
translate
(degreesLatitude, degreesLongitude)def
translated
(degreesLatitude, degreesLongitude)def
united
(rectangle)def
width
()
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
degreesWidth –
double
degreesHeight –
double
topLeft –
PySide6.QtPositioning.QGeoCoordinate
coordinates –
center –
PySide6.QtPositioning.QGeoCoordinate
bottomRight –
PySide6.QtPositioning.QGeoCoordinate
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
This property holds This property holds the bottom left coorindate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.bottomRight()¶
- Return type
This property holds This property holds the bottom right coordinate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.contains(rectangle)¶
- Parameters
rectangle –
PySide6.QtPositioning.QGeoRectangle
- Return type
bool
Returns whether the geo rectangle rectangle
is contained within this geo rectangle.
- PySide6.QtPositioning.QGeoRectangle.extendRectangle(coordinate)¶
- Parameters
coordinate –
PySide6.QtPositioning.QGeoCoordinate
Extends the geo rectangle to also cover the coordinate coordinate
- PySide6.QtPositioning.QGeoRectangle.height()¶
- Return type
double
This property holds This property holds the height of this geo rectangle in degrees..
The property value is undefined if this geo rectangle is invalid.
If the new height is less than 0.0 or if this geo rectangle is invalid, the property is not changed. To set up the values of an invalid geo rectangle based on the center, width, and height, you should use setCenter()
first to make the geo rectangle valid.
If the change in height would cause the geo rectangle to cross a pole, the height is adjusted such that the geo rectangle only touches the pole.
This change is done such that the center coordinate is still at the center of the geo rectangle, which may result in a geo rectangle with a smaller height than expected.
180.0 is the height used only if the new height is greater or equal than 180.
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.intersects(rectangle)¶
- Parameters
rectangle –
PySide6.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
rectangle –
PySide6.QtPositioning.QGeoRectangle
- Return type
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.__ior__(rectangle)¶
- Parameters
rectangle –
PySide6.QtPositioning.QGeoRectangle
- Return type
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
bottomLeft –
PySide6.QtPositioning.QGeoCoordinate
This property holds This property holds the bottom left coorindate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.setBottomRight(bottomRight)¶
- Parameters
bottomRight –
PySide6.QtPositioning.QGeoCoordinate
This property holds This property holds the bottom right coordinate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.setCenter(center)¶
- Parameters
center –
PySide6.QtPositioning.QGeoCoordinate
This property holds This property holds the center of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
See also
- PySide6.QtPositioning.QGeoRectangle.setHeight(degreesHeight)¶
- Parameters
degreesHeight –
double
This property holds This property holds the height of this geo rectangle in degrees..
The property value is undefined if this geo rectangle is invalid.
If the new height is less than 0.0 or if this geo rectangle is invalid, the property is not changed. To set up the values of an invalid geo rectangle based on the center, width, and height, you should use setCenter()
first to make the geo rectangle valid.
If the change in height would cause the geo rectangle to cross a pole, the height is adjusted such that the geo rectangle only touches the pole.
This change is done such that the center coordinate is still at the center of the geo rectangle, which may result in a geo rectangle with a smaller height than expected.
180.0 is the height used only if the new height is greater or equal than 180.
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.setTopLeft(topLeft)¶
- Parameters
topLeft –
PySide6.QtPositioning.QGeoCoordinate
This property holds This property holds the top left coordinate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.setTopRight(topRight)¶
- Parameters
topRight –
PySide6.QtPositioning.QGeoCoordinate
This property holds This property holds the top right coordinate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.setWidth(degreesWidth)¶
- Parameters
degreesWidth –
double
This property holds This property holds the width of this geo rectangle in degrees..
The property value is undefined if this geo rectangle is invalid.
If the new width is less than 0.0 or if this geo rectangle is invalid, this function does nothing. To set up the values of an invalid geo rectangle based on the center, width, and height, you should use setCenter()
first to make the geo rectangle valid.
360.0 is the width used only if the new width is equal or greater than 360. In such cases the leftmost longitude of the geo rectangle is set to -180.0 degrees and the rightmost longitude of the geo rectangle is set to 180.0 degrees.
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.topLeft()¶
- Return type
This property holds This property holds the top left coordinate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.topRight()¶
- Return type
This property holds This property holds the top right coordinate of this geo rectangle..
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
- PySide6.QtPositioning.QGeoRectangle.translate(degreesLatitude, degreesLongitude)¶
- Parameters
degreesLatitude –
double
degreesLongitude –
double
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
degreesLatitude –
double
degreesLongitude –
double
- Return type
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
- PySide6.QtPositioning.QGeoRectangle.united(rectangle)¶
- Parameters
rectangle –
PySide6.QtPositioning.QGeoRectangle
- Return type
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
This property holds This property holds the width of this geo rectangle in degrees..
The property value is undefined if this geo rectangle is invalid.
If the new width is less than 0.0 or if this geo rectangle is invalid, this function does nothing. To set up the values of an invalid geo rectangle based on the center, width, and height, you should use setCenter()
first to make the geo rectangle valid.
360.0 is the width used only if the new width is equal or greater than 360. In such cases the leftmost longitude of the geo rectangle is set to -180.0 degrees and the rightmost longitude of the geo rectangle is set to 180.0 degrees.
While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.
© 2021 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.