Pass QgsFeedback to methods in interpolation for more responsive

nyalldawson · nyalldawson · commit 60e98be8d3c7 · 2017-11-03T07:42:31.000+10:00
cancelation and progress reports
diff --git a/src/analysis/interpolation/qgsgridfilewriter.cpp b/src/analysis/interpolation/qgsgridfilewriter.cpp
@@ -60,7 +60,7 @@ int QgsGridFileWriter::writeFile( QgsFeedback *feedback )
     currentXValue = mInterpolationExtent.xMinimum() + mCellSizeX / 2.0; //calculate value in the center of the cell
     for ( int j = 0; j < mNumColumns; ++j )
     {
-      if ( mInterpolator->interpolatePoint( currentXValue, currentYValue, interpolatedValue ) == 0 )
+      if ( mInterpolator->interpolatePoint( currentXValue, currentYValue, interpolatedValue, feedback ) == 0 )
       {
         outStream << interpolatedValue << ' ';
       }
diff --git a/src/analysis/interpolation/qgsidwinterpolator.cpp b/src/analysis/interpolation/qgsidwinterpolator.cpp
@@ -31,11 +31,11 @@ QgsIDWInterpolator::QgsIDWInterpolator()
 
 }
 
-int QgsIDWInterpolator::interpolatePoint( double x, double y, double &result )
+int QgsIDWInterpolator::interpolatePoint( double x, double y, double &result, QgsFeedback *feedback )
 {
   if ( !mDataIsCached )
   {
-    cacheBaseData();
+    cacheBaseData( feedback );
   }
 
   double currentWeight;
diff --git a/src/analysis/interpolation/qgsidwinterpolator.h b/src/analysis/interpolation/qgsidwinterpolator.h
@@ -30,6 +30,8 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator
   public:
     QgsIDWInterpolator( const QList<QgsInterpolator::LayerData> &layerData );
 
+    int interpolatePoint( double x, double y, double &result, QgsFeedback *feedback = nullptr ) override;
+
     /**
      * Calculates interpolation value for map coordinates x, y
        \param x x-coordinate (in map units)
diff --git a/src/analysis/interpolation/qgsinterpolator.cpp b/src/analysis/interpolation/qgsinterpolator.cpp
@@ -20,15 +20,15 @@
 #include "qgsvectordataprovider.h"
 #include "qgsvectorlayer.h"
 #include "qgsgeometry.h"
-#include "qgswkbptr.h"
+#include "qgsfeedback.h"
 
 QgsInterpolator::QgsInterpolator( const QList<LayerData> &layerData )
   : mLayerData( layerData )
 {
 
 }
 
-int QgsInterpolator::cacheBaseData()
+QgsInterpolator::Result QgsInterpolator::cacheBaseData( QgsFeedback *feedback )
 {
   if ( mLayerData.empty() )
   {
@@ -41,10 +41,8 @@ int QgsInterpolator::cacheBaseData()
 
   Q_FOREACH ( const LayerData &layer, mLayerData )
   {
-    if ( !layer.vectorLayer )
-    {
-      continue;
-    }
+    if ( feedback && feedback->isCanceled() )
+      return Canceled;
 
     QgsVectorLayer *vlayer = layer.vectorLayer;
     if ( !vlayer )
@@ -61,12 +59,21 @@ int QgsInterpolator::cacheBaseData()
 
     double attributeValue = 0.0;
     bool attributeConversionOk = false;
+    double progress = layerCount * layerStep;
 
     QgsFeatureIterator fit = vlayer->getFeatures( QgsFeatureRequest().setSubsetOfAttributes( attList ) );
+    double featureStep = source->featureCount() > 0 ? layerStep / source->featureCount() : layerStep;
 
     QgsFeature feature;
     while ( fit.nextFeature( feature ) )
     {
+      if ( feedback && feedback->isCanceled() )
+        return Canceled;
+
+      progress += featureStep;
+      if ( feedback )
+        feedback->setProgress( progress );
+
       if ( !layer.zCoordInterpolation )
       {
         QVariant attributeVariant = feature.attribute( layer.interpolationAttribute );
diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h
@@ -24,6 +24,7 @@
 
 class QgsVectorLayer;
 class QgsGeometry;
+class QgsFeedback;
 
 struct ANALYSIS_EXPORT vertexData
 {
@@ -63,11 +64,12 @@ class ANALYSIS_EXPORT QgsInterpolator
 
     /**
      * Calculates interpolation value for map coordinates x, y
-       \param x x-coordinate (in map units)
-       \param y y-coordinate (in map units)
-       \param result out: interpolation result
-       \returns 0 in case of success*/
-    virtual int interpolatePoint( double x, double y, double &result ) = 0;
+     * \param x x-coordinate (in map units)
+     * \param y y-coordinate (in map units)
+     * \param result out: interpolation result
+     * \param feedback optional feedback object for progress and cancelation support
+     * \returns 0 in case of success*/
+    virtual int interpolatePoint( double x, double y, double &result, QgsFeedback *feedback = nullptr ) = 0;
 
     //! \note not available in Python bindings
     QList<LayerData> layerData() const { return mLayerData; } SIP_SKIP
diff --git a/src/analysis/interpolation/qgstininterpolator.cpp b/src/analysis/interpolation/qgstininterpolator.cpp
@@ -43,7 +43,7 @@ QgsTINInterpolator::~QgsTINInterpolator()
   delete mTriangleInterpolator;
 }
 
-int QgsTINInterpolator::interpolatePoint( double x, double y, double &result )
+int QgsTINInterpolator::interpolatePoint( double x, double y, double &result, QgsFeedback * )
 {
   if ( !mIsInitialized )
   {
diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h
@@ -50,13 +50,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
     QgsTINInterpolator( const QList<QgsInterpolator::LayerData> &inputData, TINInterpolation interpolation = Linear, QgsFeedback *feedback = nullptr );
     ~QgsTINInterpolator();
 
-    /**
-     * Calculates interpolation value for map coordinates x, y
-       \param x x-coordinate (in map units)
-       \param y y-coordinate (in map units)
-       \param result out: interpolation result
-       \returns 0 in case of success*/
-    int interpolatePoint( double x, double y, double &result ) override;
+    int interpolatePoint( double x, double y, double &result, QgsFeedback *feedback ) override;
 
     /**
      * Returns the fields output by features when saving the triangulation.

Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ int QgsGridFileWriter::writeFile( QgsFeedback *feedback )`
`60`	`60`	`currentXValue = mInterpolationExtent.xMinimum() + mCellSizeX / 2.0; //calculate value in the center of the cell`
`61`	`61`	`for ( int j = 0; j < mNumColumns; ++j )`
`62`	`62`	`{`
`63`		`- if ( mInterpolator->interpolatePoint( currentXValue, currentYValue, interpolatedValue ) == 0 )`
	`63`	`+ if ( mInterpolator->interpolatePoint( currentXValue, currentYValue, interpolatedValue, feedback ) == 0 )`
`64`	`64`	`{`
`65`	`65`	`outStream << interpolatedValue << ' ';`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,11 @@ QgsIDWInterpolator::QgsIDWInterpolator()`
`31`	`31`
`32`	`32`	`}`
`33`	`33`
`34`		`-int QgsIDWInterpolator::interpolatePoint( double x, double y, double &result )`
	`34`	`+int QgsIDWInterpolator::interpolatePoint( double x, double y, double &result, QgsFeedback *feedback )`
`35`	`35`	`{`
`36`	`36`	`if ( !mDataIsCached )`
`37`	`37`	`{`
`38`		`- cacheBaseData();`
	`38`	`+ cacheBaseData( feedback );`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`double currentWeight;`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ QgsTINInterpolator::~QgsTINInterpolator()`
`43`	`43`	`delete mTriangleInterpolator;`
`44`	`44`	`}`
`45`	`45`
`46`		`-int QgsTINInterpolator::interpolatePoint( double x, double y, double &result )`
	`46`	`+int QgsTINInterpolator::interpolatePoint( double x, double y, double &result, QgsFeedback * )`
`47`	`47`	`{`
`48`	`48`	`if ( !mIsInitialized )`
`49`	`49`	`{`