qgscoordinatetransform_p.h

Go to the documentation of this file.

/***************************************************************************
               qgscoordinatetransform_p.h
               --------------------------
    begin                : July 2016
    copyright            : (C) 2016 Nyall Dawson
    email                : nyall dot dawson at gmail dot 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 QGSCOORDINATETRANSFORMPRIVATE_H
#define QGSCOORDINATETRANSFORMPRIVATE_H
 
#include "qgsconfig.h"
 
#define SIP_NO_FILE

 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the QGIS API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
 
#include <QSharedData>
 
struct PJconsts;
typedef struct PJconsts PJ;
typedef PJ *ProjData;
 
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransformcontext.h"
 
class QgsCoordinateTransformPrivate : public QSharedData
{
  public:
    explicit QgsCoordinateTransformPrivate();
 
    QgsCoordinateTransformPrivate( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination, const QgsCoordinateTransformContext &context );
 
    QgsCoordinateTransformPrivate( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination, int sourceDatumTransform, int destDatumTransform );
 
    QgsCoordinateTransformPrivate( const QgsCoordinateTransformPrivate &other );
 
    ~QgsCoordinateTransformPrivate();
 
    bool checkValidity();
 
    void invalidate();
 
    bool initialize();
 
    void calculateTransforms( const QgsCoordinateTransformContext &context );
 
    ProjData threadLocalProjData();
 
    int mAvailableOpCount = -1;
    ProjData threadLocalFallbackProjData();
 
    // Only meant to be called by QgsCoordinateTransform::removeFromCacheObjectsBelongingToCurrentThread()
    bool removeObjectsBelongingToCurrentThread( void *pj_context );

    bool mIsValid = false;

    bool mShortCircuit = false;

    bool mGeographicToWebMercator = false;

    bool mHasVerticalComponent = false;

    QgsCoordinateReferenceSystem mSourceCRS;

    QgsCoordinateReferenceSystem mDestCRS;
 
    Q_DECL_DEPRECATED QString mSourceProjString;
    Q_DECL_DEPRECATED QString mDestProjString;
 
    Q_DECL_DEPRECATED int mSourceDatumTransform = -1;
    Q_DECL_DEPRECATED int mDestinationDatumTransform = -1;
    QString mProjCoordinateOperation;
    bool mShouldReverseCoordinateOperation = false;
    bool mAllowFallbackTransforms = true;
 
    bool mSourceIsDynamic = false;
    bool mDestIsDynamic = false;
    double mSourceCoordinateEpoch = std::numeric_limits< double >::quiet_NaN();
    double mDestCoordinateEpoch = std::numeric_limits< double >::quiet_NaN();
    double mDefaultTime = std::numeric_limits< double >::quiet_NaN();

    bool mIsReversed = false;
 
    QReadWriteLock mProjLock;
    QMap< uintptr_t, ProjData > mProjProjections;
    QMap< uintptr_t, ProjData > mProjFallbackProjections;

    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 setDynamicCrsToDynamicCrsWarningHandler( const std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs )> &handler );
 
  private:
    void freeProj();
 
    static std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsDatumTransform::GridDetails &grid )> sMissingRequiredGridHandler;
 
    static std::function<
      void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsDatumTransform::TransformDetails &preferredOperation, const QgsDatumTransform::TransformDetails &availableOperation )>
      sMissingPreferredGridHandler;
 
    static std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &error )> sCoordinateOperationCreationErrorHandler;
 
    static std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsDatumTransform::TransformDetails &desiredOperation )>
      sMissingGridUsedByContextHandler;
 
    static std::function< void( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs )> sDynamicCrsToDynamicCrsWarningHandler;
 
    QgsCoordinateTransformPrivate &operator=( const QgsCoordinateTransformPrivate & ) = delete;
};

 
#endif // QGSCOORDINATETRANSFORMPRIVATE_H