qgsdatumtransformdialog.cpp

Go to the documentation of this file.

/***************************************************************************
                         qgsdatumtransformdialog.cpp
                         ---------------------------
    begin                : November 2013
    copyright            : (C) 2013 by Marco Hugentobler
    email                : marco.hugentobler at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsdatumtransformdialog.h"
 
#include <proj.h>
 
#include "qgscoordinatetransform.h"
#include "qgsgui.h"
#include "qgsguiutils.h"
#include "qgshelp.h"
#include "qgslogger.h"
#include "qgsproject.h"
#include "qgsprojectionselectiondialog.h"
#include "qgsprojutils.h"
#include "qgssettings.h"
 
#include <QDir>
#include <QPushButton>
#include <QString>
 
#include "moc_qgsdatumtransformdialog.cpp"
 
using namespace Qt::StringLiterals;
 
bool QgsDatumTransformDialog::run( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, QWidget *parent, QgsMapCanvas *mapCanvas, const QString &windowTitle )
{
  if ( sourceCrs == destinationCrs )
    return true;
 
  const QgsCoordinateTransformContext context = QgsProject::instance()->transformContext();
  if ( context.hasTransform( sourceCrs, destinationCrs ) )
  {
    return true;
  }
 
  QgsDatumTransformDialog dlg( sourceCrs, destinationCrs, false, true, false, qMakePair( -1, -1 ), parent, Qt::WindowFlags(), QString(), mapCanvas );
  if ( !windowTitle.isEmpty() )
    dlg.setWindowTitle( windowTitle );
 
  if ( dlg.shouldAskUserForSelection() )
  {
    if ( dlg.exec() )
    {
      const TransformInfo dt = dlg.selectedDatumTransform();
      QgsCoordinateTransformContext context = QgsProject::instance()->transformContext();
      Q_NOWARN_DEPRECATED_PUSH
      context.addSourceDestinationDatumTransform( dt.sourceCrs, dt.destinationCrs, dt.sourceTransformId, dt.destinationTransformId );
      Q_NOWARN_DEPRECATED_POP
      context.addCoordinateOperation( dt.sourceCrs, dt.destinationCrs, dt.proj, dt.allowFallback );
      QgsProject::instance()->setTransformContext( context );
      return true;
    }
    else
    {
      return false;
    }
  }
  else
  {
    dlg.applyDefaultTransform();
    return true;
  }
}
 
QgsDatumTransformDialog::QgsDatumTransformDialog(
  const QgsCoordinateReferenceSystem &sCrs,
  const QgsCoordinateReferenceSystem &dCrs,
  const bool allowCrsChanges,
  const bool showMakeDefault,
  const bool forceChoice,
  QPair<int, int> selectedDatumTransforms,
  QWidget *parent,
  Qt::WindowFlags f,
  const QString &selectedProj,
  QgsMapCanvas *mapCanvas,
  bool allowFallback
)
  : QDialog( parent, f )
  , mPreviousCursorOverride( std::make_unique<QgsTemporaryCursorRestoreOverride>() ) // this dialog is often shown while cursor overrides are in place, so temporarily remove them
{
  setupUi( this );
 
  QgsCoordinateReferenceSystem sourceCrs = sCrs;
  QgsCoordinateReferenceSystem destinationCrs = dCrs;
 
  QgsGui::enableAutoGeometryRestore( this );
 
  if ( !showMakeDefault )
    mCoordinateOperationsWidget->setShowMakeDefault( false );
 
  if ( forceChoice )
  {
    mButtonBox->removeButton( mButtonBox->button( QDialogButtonBox::Cancel ) );
    setWindowFlags( windowFlags() | Qt::CustomizeWindowHint );
    setWindowFlags( windowFlags() & ~Qt::WindowCloseButtonHint );
  }
 
  if ( !sourceCrs.isValid() )
    sourceCrs = QgsProject::instance()->crs();
  if ( !sourceCrs.isValid() )
    sourceCrs = QgsCoordinateReferenceSystem( u"EPSG:4326"_s );
  if ( !destinationCrs.isValid() )
    destinationCrs = QgsProject::instance()->crs();
  if ( !destinationCrs.isValid() )
    destinationCrs = QgsCoordinateReferenceSystem( u"EPSG:4326"_s );
 
  mSourceProjectionSelectionWidget->setOptionVisible( QgsProjectionSelectionWidget::CrsNotSet, false );
  mDestinationProjectionSelectionWidget->setOptionVisible( QgsProjectionSelectionWidget::CrsNotSet, false );
 
  mSourceProjectionSelectionWidget->setCrs( sourceCrs );
  mDestinationProjectionSelectionWidget->setCrs( destinationCrs );
  if ( !allowCrsChanges )
  {
    mCrsStackedWidget->setCurrentIndex( 1 );
    mSourceProjectionSelectionWidget->setEnabled( false );
    mDestinationProjectionSelectionWidget->setEnabled( false );
    mSourceCrsLabel->setText( QgsProjectionSelectionWidget::crsOptionText( sourceCrs ) );
    mDestCrsLabel->setText( QgsProjectionSelectionWidget::crsOptionText( destinationCrs ) );
  }
 
  mCoordinateOperationsWidget->setMapCanvas( mapCanvas );
 
  connect( mSourceProjectionSelectionWidget, &QgsProjectionSelectionWidget::crsChanged, this, &QgsDatumTransformDialog::setSourceCrs );
  connect( mDestinationProjectionSelectionWidget, &QgsProjectionSelectionWidget::crsChanged, this, &QgsDatumTransformDialog::setDestinationCrs );
 
  mCoordinateOperationsWidget->setSourceCrs( sourceCrs );
  mCoordinateOperationsWidget->setDestinationCrs( destinationCrs );
 
  connect( mButtonBox, &QDialogButtonBox::helpRequested, this, [] { QgsHelp::openHelp( u"working_with_projections/working_with_projections.html"_s ); } );
 
  connect( mCoordinateOperationsWidget, &QgsCoordinateOperationWidget::operationChanged, this, &QgsDatumTransformDialog::operationChanged );
  QgsCoordinateOperationWidget::OperationDetails deets;
  deets.proj = selectedProj;
  deets.sourceTransformId = selectedDatumTransforms.first;
  deets.destinationTransformId = selectedDatumTransforms.second;
  deets.allowFallback = allowFallback;
  mCoordinateOperationsWidget->setSelectedOperation( deets );
 
  connect( mCoordinateOperationsWidget, &QgsCoordinateOperationWidget::operationDoubleClicked, this, [this] {
    if ( mCoordinateOperationsWidget->sourceCrs().isValid() && mCoordinateOperationsWidget->destinationCrs().isValid() && mCoordinateOperationsWidget->selectedOperation().isAvailable )
      accept();
  } );
}
 
void QgsDatumTransformDialog::setOKButtonEnabled()
{
  mButtonBox->button( QDialogButtonBox::Ok )
    ->setEnabled( mCoordinateOperationsWidget->sourceCrs().isValid() && mCoordinateOperationsWidget->destinationCrs().isValid() && mCoordinateOperationsWidget->selectedOperation().isAvailable );
}
 
void QgsDatumTransformDialog::accept()
{
  if ( mCoordinateOperationsWidget->makeDefaultSelected() && mCoordinateOperationsWidget->hasSelection() )
  {
    QgsSettings settings;
    settings.beginGroup( u"/Projections"_s );
 
    const TransformInfo dt = selectedDatumTransform();
 
    const QString srcAuthId = dt.sourceCrs.authid();
    const QString destAuthId = dt.destinationCrs.authid();
    const int sourceDatumTransform = dt.sourceTransformId;
    QString sourceDatumProj;
    Q_NOWARN_DEPRECATED_PUSH
    if ( sourceDatumTransform >= 0 )
      sourceDatumProj = QgsDatumTransform::datumTransformToProj( sourceDatumTransform );
    const int destinationDatumTransform = dt.destinationTransformId;
    QString destinationDatumProj;
    if ( destinationDatumTransform >= 0 )
      destinationDatumProj = QgsDatumTransform::datumTransformToProj( destinationDatumTransform );
    Q_NOWARN_DEPRECATED_POP
    settings.setValue( srcAuthId + u"//"_s + destAuthId + u"_srcTransform"_s, sourceDatumProj );
    settings.setValue( srcAuthId + u"//"_s + destAuthId + u"_destTransform"_s, destinationDatumProj );
    settings.setValue( srcAuthId + u"//"_s + destAuthId + u"_coordinateOp"_s, dt.proj );
    settings.setValue( srcAuthId + u"//"_s + destAuthId + u"_allowFallback"_s, dt.allowFallback );
  }
  QDialog::accept();
}
 
void QgsDatumTransformDialog::reject()
{
  if ( !mButtonBox->button( QDialogButtonBox::Cancel ) )
    return; // users HAVE to make a choice, no click on the dialog "x" to avoid this!
 
  QDialog::reject();
}
 
bool QgsDatumTransformDialog::shouldAskUserForSelection() const
{
  if ( mCoordinateOperationsWidget->availableOperations().count() > 1 )
  {
    return QgsSettings().value( u"/projections/promptWhenMultipleTransformsExist"_s, false, QgsSettings::App ).toBool();
  }
  // TODO: show if transform grids are required, but missing
  return false;
}
 
QgsDatumTransformDialog::TransformInfo QgsDatumTransformDialog::defaultDatumTransform() const
{
  TransformInfo preferred;
  preferred.sourceCrs = mCoordinateOperationsWidget->sourceCrs();
  preferred.destinationCrs = mCoordinateOperationsWidget->destinationCrs();
  const QgsCoordinateOperationWidget::OperationDetails defaultOp = mCoordinateOperationsWidget->defaultOperation();
  preferred.sourceTransformId = defaultOp.sourceTransformId;
  preferred.destinationTransformId = defaultOp.destinationTransformId;
  preferred.proj = defaultOp.proj;
  return preferred;
}
 
void QgsDatumTransformDialog::applyDefaultTransform()
{
  if ( mCoordinateOperationsWidget->availableOperations().count() > 0 )
  {
    QgsCoordinateTransformContext context = QgsProject::instance()->transformContext();
    const TransformInfo dt = defaultDatumTransform();
    Q_NOWARN_DEPRECATED_PUSH
    context.addSourceDestinationDatumTransform( dt.sourceCrs, dt.destinationCrs, dt.sourceTransformId, dt.destinationTransformId );
    Q_NOWARN_DEPRECATED_POP
 
    // on proj 6 builds, removing a coordinate operation falls back to default
    context.removeCoordinateOperation( dt.sourceCrs, dt.destinationCrs );
    QgsProject::instance()->setTransformContext( context );
  }
}
 
QgsDatumTransformDialog::TransformInfo QgsDatumTransformDialog::selectedDatumTransform()
{
  const QgsCoordinateOperationWidget::OperationDetails selected = mCoordinateOperationsWidget->selectedOperation();
  TransformInfo sdt;
  sdt.sourceCrs = mCoordinateOperationsWidget->sourceCrs();
  sdt.destinationCrs = mCoordinateOperationsWidget->destinationCrs();
  sdt.sourceTransformId = selected.sourceTransformId;
  sdt.destinationTransformId = selected.destinationTransformId;
  sdt.proj = selected.proj;
  sdt.allowFallback = selected.allowFallback;
  return sdt;
}
 
bool QgsDatumTransformDialog::gridShiftTransformation( const QString &itemText ) const
{
  return !itemText.isEmpty() && !itemText.contains( "towgs84"_L1, Qt::CaseInsensitive );
}
 
void QgsDatumTransformDialog::operationChanged()
{
  setOKButtonEnabled();
}
 
void QgsDatumTransformDialog::setSourceCrs( const QgsCoordinateReferenceSystem &sourceCrs )
{
  mCoordinateOperationsWidget->setSourceCrs( sourceCrs );
  setOKButtonEnabled();
}
 
void QgsDatumTransformDialog::setDestinationCrs( const QgsCoordinateReferenceSystem &destinationCrs )
{
  mCoordinateOperationsWidget->setDestinationCrs( destinationCrs );
  setOKButtonEnabled();
}