qgsdistancearea.h

Go to the documentation of this file.

/***************************************************************************
  qgsdistancearea.h - Distance and area calculations on the ellipsoid
 ---------------------------------------------------------------------------
  Date                 : September 2005
  Copyright            : (C) 2005 by Martin Dobias
  email                : won.der at centrum.sk
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSDISTANCEAREA_H
#define QGSDISTANCEAREA_H

#include <QList>
#include "qgscoordinatetransform.h"
#include "qgswkbptr.h"
#include "qgsunittypes.h"

class QgsGeometry;
class QgsAbstractGeometryV2;
class QgsCurveV2;

class CORE_EXPORT QgsDistanceArea
{
  public:
    QgsDistanceArea();

    ~QgsDistanceArea();

    QgsDistanceArea( const QgsDistanceArea &origDA );

    QgsDistanceArea & operator=( const QgsDistanceArea & origDA );

    void setEllipsoidalMode( bool flag );

    bool ellipsoidalEnabled() const { return mEllipsoidalMode; }

    bool willUseEllipsoid() const;

    void setSourceCrs( long srsid );

    void setSourceCrs( const QgsCoordinateReferenceSystem& srcCRS );

    void setSourceAuthId( const QString& authid );

    // TODO QGIS 3.0 - make sourceCrs() return QgsCoordinateReferenceSystem
    Q_DECL_DEPRECATED long sourceCrs() const { return mCoordTransform->sourceCrs().srsid(); }

    long sourceCrsId() const { return mCoordTransform->sourceCrs().srsid(); }

    bool geographic() const { return mCoordTransform->sourceCrs().geographicFlag(); }

    bool setEllipsoid( const QString& ellipsoid );

    // Inverse flattening is calculated with invf = a/(a-b)
    bool setEllipsoid( double semiMajor, double semiMinor );

    QString ellipsoid() const { return mEllipsoid; }

    double ellipsoidSemiMajor() const { return mSemiMajor; }
    double ellipsoidSemiMinor() const { return mSemiMinor; }
    double ellipsoidInverseFlattening() const { return mInvFlattening; }

    Q_DECL_DEPRECATED double measure( const QgsGeometry* geometry ) const;

    double measureArea( const QgsGeometry* geometry ) const;

    double measureLength( const QgsGeometry* geometry ) const;

    double measurePerimeter( const QgsGeometry *geometry ) const;

    double measureLine( const QList<QgsPoint>& points ) const;

    double measureLine( const QgsPoint& p1, const QgsPoint& p2 ) const;

    double measureLine( const QgsPoint& p1, const QgsPoint& p2, QGis::UnitType& units ) const;

    QGis::UnitType lengthUnits() const;

    QgsUnitTypes::AreaUnit areaUnits() const;

    double measurePolygon( const QList<QgsPoint>& points ) const;

    double bearing( const QgsPoint& p1, const QgsPoint& p2 ) const;

    //TODO QGIS 3.0 - remove isArea parameter (use AreaUnit variant instead), rename to formatDistance
    static QString textUnit( double value, int decimals, QGis::UnitType u, bool isArea, bool keepBaseUnit = false );

    static QString formatArea( double area, int decimals, QgsUnitTypes::AreaUnit unit, bool keepBaseUnit = false );

    // TODO QGIS 3.0 - remove this method, as its behaviour is non-intuitive.
    void convertMeasurement( double &measure, QGis::UnitType &measureUnits, QGis::UnitType displayUnits, bool isArea ) const;

    double convertLengthMeasurement( double length, QGis::UnitType toUnits ) const;

    double convertAreaMeasurement( double area, QgsUnitTypes::AreaUnit toUnits ) const;

  protected:
    // @note not available in python bindings
    QgsConstWkbPtr measurePolygon( QgsConstWkbPtr feature, double* area, double* perimeter, bool hasZptr = false ) const;

    double computeDistanceBearing( const QgsPoint& p1, const QgsPoint& p2,
                                   double* course1 = nullptr, double* course2 = nullptr ) const;

    double computeDistanceFlat( const QgsPoint& p1, const QgsPoint& p2 ) const;

    double computeDistance( const QList<QgsPoint>& points ) const;

    double computePolygonArea( const QList<QgsPoint>& points ) const;

    double computePolygonFlatArea( const QList<QgsPoint>& points ) const;

    void computeAreaInit();

  private:

    enum MeasureType
    {
      Default,
      Area,
      Length
    };

    void _copy( const QgsDistanceArea & origDA );

    QgsCoordinateTransform* mCoordTransform;

    bool mEllipsoidalMode;

    QString mEllipsoid;

    double mSemiMajor, mSemiMinor, mInvFlattening;

    // utility functions for polygon area measurement

    double getQ( double x ) const;
    double getQbar( double x ) const;

    double measure( const QgsAbstractGeometryV2* geomV2, MeasureType type = Default ) const;
    double measureLine( const QgsCurveV2* curve ) const;
    double measurePolygon( const QgsCurveV2* curve ) const;

    // temporary area measurement stuff

    double m_QA, m_QB, m_QC;
    double m_QbarA, m_QbarB, m_QbarC, m_QbarD;
    double m_AE;  /* a^2(1-e^2) */
    double m_Qp;  /* Q at the north pole */
    double m_E;   /* area of the earth */
    double m_TwoPI;

};

#endif