More flexible API for preview job determination

nyalldawson · nyalldawson · commit 01e8ed85e319 · 2017-12-05T09:02:40.000+10:00
diff --git a/python/core/qgsdataprovider.sip b/python/core/qgsdataprovider.sip
@@ -380,6 +380,7 @@ Current time stamp of data source
 .. versionadded:: 3.0
 %End
 
+
   signals:
 
     void fullExtentCalculated();
diff --git a/src/core/qgsdataprovider.cpp b/src/core/qgsdataprovider.cpp
@@ -42,7 +42,7 @@ void QgsDataProvider::setListening( bool isListening )
   Q_UNUSED( isListening );
 }
 
-bool QgsDataProvider::renderInPreview( double lastRenderingTimeMS, double maxRenderingTimeMS )
+bool QgsDataProvider::renderInPreview( QgsDataProvider::PreviewContext context )
 {
-  return lastRenderingTimeMS <= maxRenderingTimeMS;
+  return context.lastRenderingTimeMs <= context.maxRenderingTimeMs;
 }
diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h
@@ -461,6 +461,23 @@ class CORE_EXPORT QgsDataProvider : public QObject
      */
     virtual void setListening( bool isListening );
 
+#ifndef SIP_RUN
+
+    /**
+     * Stores settings related to the context in which a preview job runs.
+     * \note Not available in Python bindings
+     * \since QGIS 3.0
+     */
+    struct PreviewContext
+    {
+      //! Previous rendering time for the layer, in ms
+      double lastRenderingTimeMs = -1;
+
+      //! Default maximum allowable render time, in ms
+      double maxRenderingTimeMs = MAXIMUM_LAYER_PREVIEW_TIME_MS;
+    };
+#endif
+
     /**
      * Returns whether the layer must be rendered in preview jobs.
      *
@@ -474,7 +491,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
      *
      * \note not available in Python bindings
      */
-    virtual bool renderInPreview( double lastRenderingTimeMS, double maxRenderingTimeMS ); // SIP_SKIP
+    virtual bool renderInPreview( QgsDataProvider::PreviewContext context ); // SIP_SKIP
 
   signals:
 
diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -2273,9 +2273,12 @@ void QgsMapCanvas::startPreviewJob( int number )
   // truncate preview layers to fast layers
   const QList<QgsMapLayer *> layers = jobSettings.layers();
   QList< QgsMapLayer * > previewLayers;
+  QgsDataProvider::PreviewContext context;
+  context.maxRenderingTimeMs = MAXIMUM_LAYER_PREVIEW_TIME_MS;
   for ( QgsMapLayer *layer : layers )
   {
-    if ( !layer->dataProvider()->renderInPreview( mLastLayerRenderTime.value( layer->id() ), MAXIMUM_LAYER_PREVIEW_TIME_MS ) )
+    context.lastRenderingTimeMs = mLastLayerRenderTime.value( layer->id() );
+    if ( !layer->dataProvider()->renderInPreview( context ) )
     {
       QgsDebugMsgLevel( QString( "Layer %1 not rendered because it does not match the renderInPreview criterion %2" ).arg( layer->id() ).arg( mLastLayerRenderTime.value( layer->id() ) ), 3 );
       continue;

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ void QgsDataProvider::setListening( bool isListening )`
`42`	`42`	`Q_UNUSED( isListening );`
`43`	`43`	`}`
`44`	`44`
`45`		`-bool QgsDataProvider::renderInPreview( double lastRenderingTimeMS, double maxRenderingTimeMS )`
	`45`	`+bool QgsDataProvider::renderInPreview( QgsDataProvider::PreviewContext context )`
`46`	`46`	`{`
`47`		`- return lastRenderingTimeMS <= maxRenderingTimeMS;`
	`47`	`+ return context.lastRenderingTimeMs <= context.maxRenderingTimeMs;`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2273,9 +2273,12 @@ void QgsMapCanvas::startPreviewJob( int number )`
`2273`	`2273`	`// truncate preview layers to fast layers`
`2274`	`2274`	`const QList<QgsMapLayer *> layers = jobSettings.layers();`
`2275`	`2275`	`QList< QgsMapLayer * > previewLayers;`
	`2276`	`+ QgsDataProvider::PreviewContext context;`
	`2277`	`+ context.maxRenderingTimeMs = MAXIMUM_LAYER_PREVIEW_TIME_MS;`
`2276`	`2278`	`for ( QgsMapLayer *layer : layers )`
`2277`	`2279`	`{`
`2278`		`- if ( !layer->dataProvider()->renderInPreview( mLastLayerRenderTime.value( layer->id() ), MAXIMUM_LAYER_PREVIEW_TIME_MS ) )`
	`2280`	`+ context.lastRenderingTimeMs = mLastLayerRenderTime.value( layer->id() );`
	`2281`	`+ if ( !layer->dataProvider()->renderInPreview( context ) )`
`2279`	`2282`	`{`
`2280`	`2283`	`QgsDebugMsgLevel( QString( "Layer %1 not rendered because it does not match the renderInPreview criterion %2" ).arg( layer->id() ).arg( mLastLayerRenderTime.value( layer->id() ) ), 3 );`
`2281`	`2284`	`continue;`