qgscoordinatetransform.h

Go to the documentation of this file.

/***************************************************************************
               qgscoordinatetransform.h  - Coordinate Transforms
               ------------------------
    begin                : Dec 2004
    copyright            : (C) 2004 Tim Sutton
    email                : tim at linfiniti.com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSCOORDINATETRANSFORM_H
#define QGSCOORDINATETRANSFORM_H
 
#include "qgsconfig.h"
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
 
#include <QExplicitlySharedDataPointer>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsCoordinateTransformPrivate;
class QgsBox3D;
class QgsPointXY;
class QgsRectangle;
class QPolygonF;
class QgsProject;
class QgsVector3D;

class CORE_EXPORT QgsCoordinateTransform
{
  public:
    QgsCoordinateTransform();

    explicit QgsCoordinateTransform(
      const QgsCoordinateReferenceSystem &source,
      const QgsCoordinateReferenceSystem &destination,
      const QgsCoordinateTransformContext &context,
      Qgis::CoordinateTransformationFlags flags = Qgis::CoordinateTransformationFlags()
    );

    explicit QgsCoordinateTransform(
      const QgsCoordinateReferenceSystem &source,
      const QgsCoordinateReferenceSystem &destination,
      const QgsProject *project,
      Qgis::CoordinateTransformationFlags flags = Qgis::CoordinateTransformationFlags()
    );

    Q_DECL_DEPRECATED explicit QgsCoordinateTransform( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination, int sourceDatumTransformId, int destinationDatumTransformId )
      SIP_DEPRECATED;
 
    QgsCoordinateTransform( const QgsCoordinateTransform &o );
    QgsCoordinateTransform &operator=( const QgsCoordinateTransform &o );
 
    ~QgsCoordinateTransform();
 
    bool operator==( const QgsCoordinateTransform &other ) const;
    bool operator!=( const QgsCoordinateTransform &other ) const;

    static bool isTransformationPossible( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination );

    bool isValid() const;

    void setSourceCrs( const QgsCoordinateReferenceSystem &crs );

    void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );

    void setContext( const QgsCoordinateTransformContext &context );

    QgsCoordinateTransformContext context() const;

    QgsCoordinateReferenceSystem sourceCrs() const;

    QgsCoordinateReferenceSystem destinationCrs() const;

    QgsPointXY transform( const QgsPointXY &point, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    QgsPointXY transform( double x, double y, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    QgsVector3D transform( const QgsVector3D &point, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    QgsRectangle transformBoundingBox( const QgsRectangle &rectangle, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward, bool handle180Crossover = false ) const SIP_THROW(
      QgsCsException
    );

    QgsBox3D transformBox3D( const QgsBox3D &box, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    void transformInPlace( double &x SIP_INOUT, double &y SIP_INOUT, double &z SIP_INOUT, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    void transformInPlace( float &x, float &y, double &z, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_SKIP;

    void transformInPlace( float &x, float &y, float &z, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_SKIP;

    void transformInPlace( QVector<float> &x, QVector<float> &y, QVector<float> &z, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_SKIP;

    void transformInPlace( QVector<double> &x, QVector<double> &y, QVector<double> &z, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_SKIP;

    void transformPolygon( QPolygonF &polygon, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    QgsRectangle transform( const QgsRectangle &rectangle, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    void transformCoords( int numPoint, double *x, double *y, double *z, Qgis::TransformDirection direction = Qgis::TransformDirection::Forward ) const SIP_THROW( QgsCsException );

    bool isShortCircuited() const;

    bool hasVerticalComponent() const;

    QString coordinateOperation() const;

    QgsDatumTransform::TransformDetails instantiatedCoordinateOperationDetails() const;

    void setCoordinateOperation( const QString &operation ) const;

    void setAllowFallbackTransforms( bool allowed );

    bool allowFallbackTransforms() const;

    void setBallparkTransformsAreAppropriate( bool appropriate );

    void disableFallbackOperationHandler( bool disabled );

    bool fallbackOperationOccurred() const;

    Q_DECL_DEPRECATED int sourceDatumTransformId() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setSourceDatumTransformId( int datumId ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED int destinationDatumTransformId() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setDestinationDatumTransformId( int datumId ) SIP_DEPRECATED;
 
#ifndef SIP_RUN

    static void invalidateCache( bool disableCache = false );
#else

    static void invalidateCache( bool disableCache SIP_PYARGREMOVE = false );
#endif

    double scaleFactor( const QgsRectangle &referenceExtent ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsCoordinateTransform: %1 to %2>"_s.arg( sipCpp->sourceCrs().isValid() ? sipCpp->sourceCrs().authid() : u"NULL"_s,
                  sipCpp->destinationCrs().isValid() ? sipCpp->destinationCrs().authid() : u"NULL"_s );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN

      static void setCustomMissingRequiredGridHandler(
        const std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsDatumTransform::GridDetails &grid )> &handler
      );

    static void setCustomMissingPreferredGridHandler(
      const std::function< void(
        const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsDatumTransform::TransformDetails &preferredOperation, const QgsDatumTransform::TransformDetails &availableOperation
      )> &handler
    );

    static void setCustomCoordinateOperationCreationErrorHandler(
      const std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &error )> &handler
    );

    static void setCustomMissingGridUsedByContextHandler(
      const std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsDatumTransform::TransformDetails &desiredOperation )> &handler
    );
 

    static void setFallbackOperationOccurredHandler(
      const std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &desiredOperation )> &handler
    );

    static void setDynamicCrsToDynamicCrsWarningHandler( const std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs )> &handler );
 
#endif
 
  private:
#ifndef SIP_RUN
    friend class QgsProjContext;
 
    // Only meant to be called by QgsProjContext::~QgsProjContext()
    static void removeFromCacheObjectsBelongingToCurrentThread( void *pj_context );
#endif
 
    mutable QExplicitlySharedDataPointer<QgsCoordinateTransformPrivate> d;

    QgsCoordinateTransformContext mContext;
 
#ifdef QGISDEBUG
    bool mHasContext = false;
#endif
 
    mutable QString mLastError;
    bool mIgnoreImpossible = false;
    bool mBallparkTransformsAreAppropriate = false;
    bool mDisableFallbackHandler = false;
    mutable bool mFallbackOperationOccurred = false;
 
    bool setFromCache( const QgsCoordinateReferenceSystem &src, const QgsCoordinateReferenceSystem &dest, const QString &coordinateOperationProj, bool allowFallback );
 
    void addToCache();
 
    // cache
    static QReadWriteLock sCacheLock;

    static QMultiHash< QPair< QString, QString >, QgsCoordinateTransform > sTransforms;
    static bool sDisableCache;
 
 
    static std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &desiredOperation )> sFallbackOperationOccurredHandler;
 
    friend class TestQgsCoordinateTransform;
};

#ifndef SIP_RUN
inline std::ostream &operator<<( std::ostream &os, const QgsCoordinateTransform &r )
{
  QString mySummary( u"\n%%%%%%%%%%%%%%%%%%%%%%%%\nCoordinate Transform def begins:"_s );
  mySummary += "\n\tInitialized? : "_L1;
  //prevent warnings
  if ( r.isValid() )
  {
    //do nothing this is a dummy
  }
 
#if 0
  if ( r.isValid() )
  {
    mySummary += "Yes";
  }
  else
  {
    mySummary += "No";
  }
  mySummary += "\n\tShort Circuit?  : ";
  if ( r.isShortCircuited() )
  {
    mySummary += "Yes";
  }
  else
  {
    mySummary += "No";
  }
 
  mySummary += "\n\tSource Spatial Ref Sys  : ";
  if ( r.sourceCrs() )
  {
    mySummary << r.sourceCrs();
  }
  else
  {
    mySummary += "Undefined";
  }
 
  mySummary += "\n\tDest Spatial Ref Sys  : ";
  if ( r.destCRS() )
  {
    mySummary << r.destCRS();
  }
  else
  {
    mySummary += "Undefined";
  }
#endif
 
  mySummary += "\nCoordinate Transform def ends \n%%%%%%%%%%%%%%%%%%%%%%%%\n"_L1;
  return os << mySummary.toLocal8Bit().data() << std::endl;
}
#endif
 
 
#endif // QGSCOORDINATETRANSFORM_H