QGIS API Documentation 4.3.0-Master (901db8dfa85)
Loading...
Searching...
No Matches
QgsEllipsoidUtils Class Reference

Contains utility functions for working with ellipsoids and querying the ellipsoid database. More...

#include <qgsellipsoidutils.h>

Classes

struct  EllipsoidDefinition
 Contains definition of an ellipsoid. More...
struct  EllipsoidParameters
 Contains parameters for an ellipsoid. More...

Static Public Member Functions

static QStringList acronyms ()
 Returns a list of all known ellipsoid acronyms from the internal ellipsoid database.
static QList< QgsCelestialBody > celestialBodies ()
 Returns a list of all known celestial bodies.
static QList< QgsEllipsoidUtils::EllipsoidDefinition > definitions ()
 Returns a list of the definitions for all known ellipsoids from the internal ellipsoid database.
static QQuaternion ellipsoidEastNorthUpRotation (const QgsVector3D &position, double semiMajorAxis, double semiMinorAxis)
 Returns a rotation quaternion for the east-north-up (ENU) reference frame at position on the ellipsoid with the given semiMajorAxis and semiMinorAxis.
static EllipsoidParameters ellipsoidParameters (const QString &ellipsoid)
 Returns the parameters for the specified ellipsoid.
static void invalidateCache (bool disableCache=false)
 Clears the internal cache used.
static QQuaternion quaternionFromNormalUpRight (const QVector3D &normalUp, const QVector3D &normalRight)
 Builds a rotation quaternion from an "up" direction and a "right" direction, with the remaining basis axis derived as their cross product.

Detailed Description

Contains utility functions for working with ellipsoids and querying the ellipsoid database.

Definition at line 35 of file qgsellipsoidutils.h.

Member Function Documentation

◆ acronyms()

QStringList QgsEllipsoidUtils::acronyms ( )
static

Returns a list of all known ellipsoid acronyms from the internal ellipsoid database.

See also
definitions()

Definition at line 329 of file qgsellipsoidutils.cpp.

◆ celestialBodies()

QList< QgsCelestialBody > QgsEllipsoidUtils::celestialBodies ( )
static

Returns a list of all known celestial bodies.

Note
This method is an alias for QgsCoordinateReferenceSystemRegistry::celestialBodies().
Warning
This method requires PROJ 8.1 or later
Exceptions
QgsNotSupportedExceptionon QGIS builds based on PROJ 8.0 or earlier.
Since
QGIS 3.20

Definition at line 341 of file qgsellipsoidutils.cpp.

◆ definitions()

QList< QgsEllipsoidUtils::EllipsoidDefinition > QgsEllipsoidUtils::definitions ( )
static

Returns a list of the definitions for all known ellipsoids from the internal ellipsoid database.

See also
acronyms()

Definition at line 246 of file qgsellipsoidutils.cpp.

◆ ellipsoidEastNorthUpRotation()

QQuaternion QgsEllipsoidUtils::ellipsoidEastNorthUpRotation ( const QgsVector3D & position,
double semiMajorAxis,
double semiMinorAxis )
static

Returns a rotation quaternion for the east-north-up (ENU) reference frame at position on the ellipsoid with the given semiMajorAxis and semiMinorAxis.

The local axes are defined as:

The x axis points in the local east direction. The y axis points in the local north direction. The z axis points in the direction of the ellipsoid surface normal which passes through the position.

Since
QGIS 4.4

Definition at line 375 of file qgsellipsoidutils.cpp.

◆ ellipsoidParameters()

QgsEllipsoidUtils::EllipsoidParameters QgsEllipsoidUtils::ellipsoidParameters ( const QString & ellipsoid)
static

Returns the parameters for the specified ellipsoid.

Results are cached to allow for fast retrieval of parameters.

Definition at line 47 of file qgsellipsoidutils.cpp.

◆ invalidateCache()

void QgsEllipsoidUtils::invalidateCache ( bool disableCache = false)
static

Clears the internal cache used.

If disableCache is true then the inbuilt cache will be completely disabled. This argument is for internal use only.

Since
QGIS 3.10

Definition at line 346 of file qgsellipsoidutils.cpp.

◆ quaternionFromNormalUpRight()

QQuaternion QgsEllipsoidUtils::quaternionFromNormalUpRight ( const QVector3D & normalUp,
const QVector3D & normalRight )
static

Builds a rotation quaternion from an "up" direction and a "right" direction, with the remaining basis axis derived as their cross product.

Since
QGIS 4.4

Definition at line 360 of file qgsellipsoidutils.cpp.


The documentation for this class was generated from the following files: