QGIS API Documentation 3.39.0-Master (3aed037ce22)
Loading...
Searching...
No Matches
qgsdistancearea.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsdistancearea.h - Distance and area calculations on the ellipsoid
3 ---------------------------------------------------------------------------
4 Date : September 2005
5 Copyright : (C) 2005 by Martin Dobias
6 email : won.der at centrum.sk
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSDISTANCEAREA_H
17#define QGSDISTANCEAREA_H
18
19#include "qgis_core.h"
20#include <QVector>
21#include <QReadWriteLock>
23#include "qgis.h"
24#include "qgsellipsoidutils.h"
25
26class QgsGeometry;
28class QgsCurve;
29struct geod_geodesic;
30
52class CORE_EXPORT QgsDistanceArea
53{
54 public:
55
58
59 QgsDistanceArea( const QgsDistanceArea &other );
60 QgsDistanceArea &operator=( const QgsDistanceArea &other );
61
67 bool willUseEllipsoid() const;
68
73 void setSourceCrs( const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context );
74
80 QgsCoordinateReferenceSystem sourceCrs() const { return mCoordTransform.sourceCrs(); }
81
88 QgsCoordinateReferenceSystem ellipsoidCrs() const { return mCoordTransform.destinationCrs(); }
89
98 bool setEllipsoid( const QString &ellipsoid );
99
107 bool setEllipsoid( double semiMajor, double semiMinor );
108
116 QString ellipsoid() const { return mEllipsoid; }
117
124 double ellipsoidSemiMajor() const { return mSemiMajor; }
125
132 double ellipsoidSemiMinor() const { return mSemiMinor; }
133
141 double ellipsoidInverseFlattening() const { return mInvFlattening; }
142
152 double measureArea( const QgsGeometry &geometry ) const;
153
163 double measureLength( const QgsGeometry &geometry ) const;
164
174 double measurePerimeter( const QgsGeometry &geometry ) const;
175
182 double measureLine( const QVector<QgsPointXY> &points ) const;
183
191 double measureLine( const QgsPointXY &p1, const QgsPointXY &p2 ) const;
192
206 double measureLineProjected( const QgsPointXY &p1, double distance = 1, double azimuth = M_PI_2, QgsPointXY *projectedPoint SIP_OUT = nullptr ) const;
207
212 Qgis::DistanceUnit lengthUnits() const;
213
218 Qgis::AreaUnit areaUnits() const;
219
223 double measurePolygon( const QVector<QgsPointXY> &points ) const;
224
230 double bearing( const QgsPointXY &p1, const QgsPointXY &p2 ) const SIP_THROW( QgsCsException );
231
242 static QString formatDistance( double distance, int decimals, Qgis::DistanceUnit unit, bool keepBaseUnit = false );
243
254 static QString formatArea( double area, int decimals, Qgis::AreaUnit unit, bool keepBaseUnit = false );
255
265 double convertLengthMeasurement( double length, Qgis::DistanceUnit toUnits ) const;
266
276 double convertAreaMeasurement( double area, Qgis::AreaUnit toUnits ) const;
277
288 QgsPointXY computeSpheroidProject( const QgsPointXY &p1, double distance = 1, double azimuth = M_PI_2 ) const;
289
309 QVector<QVector<QgsPointXY> > geodesicLine( const QgsPointXY &p1, const QgsPointXY &p2, double interval, bool breakLine = false ) const;
310
329 double latitudeGeodesicCrossesAntimeridian( const QgsPointXY &p1, const QgsPointXY &p2, double &fractionAlongLine SIP_OUT ) const;
330
352 QgsGeometry splitGeometryAtAntimeridian( const QgsGeometry &geometry ) const;
353
354 private:
355
360 double computePolygonArea( const QVector<QgsPointXY> &points ) const;
361
362 double computePolygonFlatArea( const QVector<QgsPointXY> &points ) const;
363
368 void computeAreaInit() const;
369
370 void setFromParams( const QgsEllipsoidUtils::EllipsoidParameters &params );
371
372 enum MeasureType
373 {
374 Default,
375 Area,
376 Length
377 };
378
380 QgsCoordinateTransform mCoordTransform;
381
383 QString mEllipsoid;
384
386 double mSemiMajor, mSemiMinor, mInvFlattening;
387
388 mutable std::unique_ptr< geod_geodesic > mGeod;
389
390 // utility functions for polygon area measurement
391
392 double measure( const QgsAbstractGeometry *geomV2, MeasureType type = Default ) const;
393 double measureLine( const QgsCurve *curve ) const;
394 double measurePolygon( const QgsCurve *curve ) const;
395
396};
397
398#endif
399
DistanceUnit
Units of distance.
Definition qgis.h:4463
AreaUnit
Units of area.
Definition qgis.h:4501
Abstract base class for all geometries.
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Class for doing transforms between two map coordinate systems.
Custom exception class for Coordinate Reference System related exceptions.
Abstract base class for curved geometry type.
Definition qgscurve.h:35
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
QgsCoordinateReferenceSystem ellipsoidCrs() const
Returns the ellipsoid (destination) spatial reference system.
QgsCoordinateReferenceSystem sourceCrs() const
Returns the source spatial reference system.
double ellipsoidInverseFlattening() const
Returns ellipsoid's inverse flattening.
QString ellipsoid() const
Returns ellipsoid's acronym.
double ellipsoidSemiMajor() const
Returns the ellipsoid's semi major axis.
double ellipsoidSemiMinor() const
Returns ellipsoid's semi minor axis.
A geometry is the spatial representation of a feature.
A class to represent a 2D point.
Definition qgspointxy.h:60
#define SIP_OUT
Definition qgis_sip.h:58
#define SIP_THROW(name,...)
Definition qgis_sip.h:203
const QgsCoordinateReferenceSystem & crs
Contains parameters for an ellipsoid.