QGeoCoordinate

The QGeoCoordinate class defines a geographical position on the surface of the Earth. More…

Inheritance diagram of PySide6.QtPositioning.QGeoCoordinate

Synopsis

Functions

Detailed Description

A QGeoCoordinate is defined by latitude, longitude, and optionally, altitude.

Use type() to determine whether a coordinate is a 2D coordinate (has latitude and longitude only) or 3D coordinate (has latitude, longitude and altitude). Use distanceTo() and azimuthTo() to calculate the distance and bearing between coordinates.

The coordinate values should be specified using the WGS84 datum. For more information on geographical terms see this article on coordinates and another on geodetic systems including WGS84.

Azimuth in this context is equivalent to a compass bearing based on true north.

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

class PySide6.QtPositioning.QGeoCoordinate

PySide6.QtPositioning.QGeoCoordinate(other)

PySide6.QtPositioning.QGeoCoordinate(latitude, longitude)

PySide6.QtPositioning.QGeoCoordinate(latitude, longitude, altitude)

Parameters

Constructs a coordinate. The coordinate will be invalid until setLatitude() and setLongitude() have been called.

Constructs a coordinate with the given latitude and longitude.

If the latitude is not between -90 to 90 inclusive, or the longitude is not between -180 to 180 inclusive, none of the values are set and the type() will be InvalidCoordinate .

See also

isValid()

Constructs a coordinate with the given latitude, longitude and altitude.

If the latitude is not between -90 to 90 inclusive, or the longitude is not between -180 to 180 inclusive, none of the values are set and the type() will be InvalidCoordinate .

Note that altitude specifies the meters above sea level.

See also

isValid()

PySide6.QtPositioning.QGeoCoordinate.CoordinateType

Defines the types of a coordinate.

Constant

Description

QGeoCoordinate.InvalidCoordinate

An invalid coordinate. A coordinate is invalid if its latitude or longitude values are invalid.

QGeoCoordinate.Coordinate2D

A coordinate with valid latitude and longitude values.

QGeoCoordinate.Coordinate3D

A coordinate with valid latitude and longitude values, and also an altitude value.
PySide6.QtPositioning.QGeoCoordinate.CoordinateFormat

Defines the possible formatting options for toString() .

Constant

Description

QGeoCoordinate.Degrees

Returns a string representation of the coordinates in decimal degrees format.

QGeoCoordinate.DegreesWithHemisphere

Returns a string representation of the coordinates in decimal degrees format, using ‘N’, ‘S’, ‘E’ or ‘W’ to indicate the hemispheres of the coordinates.

QGeoCoordinate.DegreesMinutes

Returns a string representation of the coordinates in degrees-minutes format.

QGeoCoordinate.DegreesMinutesWithHemisphere

Returns a string representation of the coordinates in degrees-minutes format, using ‘N’, ‘S’, ‘E’ or ‘W’ to indicate the hemispheres of the coordinates.

QGeoCoordinate.DegreesMinutesSeconds

Returns a string representation of the coordinates in degrees-minutes-seconds format.

QGeoCoordinate.DegreesMinutesSecondsWithHemisphere

Returns a string representation of the coordinates in degrees-minutes-seconds format, using ‘N’, ‘S’, ‘E’ or ‘W’ to indicate the hemispheres of the coordinates.

See also

toString()

PySide6.QtPositioning.QGeoCoordinate.altitude()
Return type

double

This property holds This property holds the altitude in meters above sea level..

The property is undefined ( qQNaN() ) if the altitude has not been set.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.atDistanceAndAzimuth(distance, azimuth[, distanceUp=0.0])
Parameters

  • distance – float

  • azimuth – float

  • distanceUp – float

Return type

PySide6.QtPositioning.QGeoCoordinate

Returns the coordinate that is reached by traveling distance meters from the current coordinate at azimuth (or bearing) along a great-circle. There is an assumption that the Earth is spherical for the purpose of this calculation.

The altitude will have distanceUp added to it.

Returns an invalid coordinate if this coordinate is invalid.

PySide6.QtPositioning.QGeoCoordinate.azimuthTo(other)
Parameters

other – PySide6.QtPositioning.QGeoCoordinate

Return type

float

Returns the azimuth (or bearing) in degrees from this coordinate to the coordinate specified by other. Altitude is not used in the calculation.

The bearing returned is the bearing from the origin to other along the great-circle between the two coordinates. There is an assumption that the Earth is spherical for the purpose of this calculation.

Returns 0 if the type of this coordinate or the type of other is InvalidCoordinate .

PySide6.QtPositioning.QGeoCoordinate.distanceTo(other)
Parameters

other – PySide6.QtPositioning.QGeoCoordinate

Return type

float

Returns the distance (in meters) from this coordinate to the coordinate specified by other. Altitude is not used in the calculation.

This calculation returns the great-circle distance between the two coordinates, with an assumption that the Earth is spherical for the purpose of this calculation.

Returns 0 if the type of this coordinate or the type of other is InvalidCoordinate .

PySide6.QtPositioning.QGeoCoordinate.isValid()
Return type

bool

This property holds This property holds the validity of this geo coordinate..

The geo coordinate is valid if the longitude and latitude properties have been set to valid values.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.latitude()
Return type

double

This property holds This property holds the latitude in decimal degrees..

The property is undefined ( qQNaN() ) if the latitude has not been set. A positive latitude indicates the Northern Hemisphere, and a negative latitude indicates the Southern Hemisphere. When setting the latitude the new value should be in the WGS84 datum format.

To be valid, the latitude must be between -90 to 90 inclusive.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.longitude()
Return type

double

This property holds This property holds the longitude in decimal degrees..

The property is undefined ( qQNaN() ) if the longitude has not been set. A positive longitude indicates the Eastern Hemisphere, and a negative longitude indicates the Western Hemisphere. When setting the longitude the new value should be in the WGS84 datum format.

To be valid, the longitude must be between -180 to 180 inclusive.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.__ne__(rhs)
Parameters

rhs – PySide6.QtPositioning.QGeoCoordinate

Return type

bool

PySide6.QtPositioning.QGeoCoordinate.__eq__(rhs)
Parameters

rhs – PySide6.QtPositioning.QGeoCoordinate

Return type

bool

PySide6.QtPositioning.QGeoCoordinate.setAltitude(altitude)
Parameters

altitude – double

This property holds This property holds the altitude in meters above sea level..

The property is undefined ( qQNaN() ) if the altitude has not been set.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.setLatitude(latitude)
Parameters

latitude – double

This property holds This property holds the latitude in decimal degrees..

The property is undefined ( qQNaN() ) if the latitude has not been set. A positive latitude indicates the Northern Hemisphere, and a negative latitude indicates the Southern Hemisphere. When setting the latitude the new value should be in the WGS84 datum format.

To be valid, the latitude must be between -90 to 90 inclusive.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.setLongitude(longitude)
Parameters

longitude – double

This property holds This property holds the longitude in decimal degrees..

The property is undefined ( qQNaN() ) if the longitude has not been set. A positive longitude indicates the Eastern Hemisphere, and a negative longitude indicates the Western Hemisphere. When setting the longitude the new value should be in the WGS84 datum format.

To be valid, the longitude must be between -180 to 180 inclusive.

While this property is introduced in Qt 5.5, the related accessor functions exist since the first version of this class.

PySide6.QtPositioning.QGeoCoordinate.swap(other)
Parameters

other – PySide6.QtPositioning.QGeoCoordinate

PySide6.QtPositioning.QGeoCoordinate.toString([format=QGeoCoordinate.CoordinateFormat.DegreesMinutesSecondsWithHemisphere])
Parameters

format – CoordinateFormat

Return type

str

Returns this coordinate as a string in the specified format.

For example, if this coordinate has a latitude of -27.46758, a longitude of 153.027892 and an altitude of 28.1, these are the strings returned depending on format:

format value

Returned string

Degrees

-27.46758°, 153.02789°, 28.1m

DegreesWithHemisphere

27.46758° S, 153.02789° E, 28.1m

DegreesMinutes

-27° 28.054’, 153° 1.673’, 28.1m

DegreesMinutesWithHemisphere

27° 28.054 S’, 153° 1.673’ E, 28.1m

DegreesMinutesSeconds

-27° 28’ 3.2”, 153° 1’ 40.4”, 28.1m

DegreesMinutesSecondsWithHemisphere

27° 28’ 3.2” S, 153° 1’ 40.4” E, 28.1m

The altitude field is omitted if no altitude is set.

If the coordinate is invalid, an empty string is returned.

PySide6.QtPositioning.QGeoCoordinate.type()
Return type

CoordinateType

Returns the type of this coordinate.