Do not overwrite renderContext in QgsMapRendererJob::drawLabeling

arnaud-morvan · nyalldawson · commit c97645e19bc5 · 2019-01-29T08:00:26.000+11:00
Dedicated QgsRenderContext is already created and configured in prepareLabelingJob.
diff --git a/python/core/auto_generated/qgsmaprendererjob.sip.in b/python/core/auto_generated/qgsmaprendererjob.sip.in
@@ -183,6 +183,7 @@ emitted when asynchronous rendering is finished (or canceled).
 
 
 
+
 };
 
 
diff --git a/src/core/qgsmaprenderercustompainterjob.cpp b/src/core/qgsmaprenderercustompainterjob.cpp
@@ -295,12 +295,12 @@ void QgsMapRendererCustomPainterJob::doRender()
         mLabelJob.img->fill( 0 );
         painter.begin( mLabelJob.img );
         mLabelJob.context.setPainter( &painter );
-        drawLabeling( mSettings, mLabelJob.context, mLabelingEngineV2.get(), &painter );
+        drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), &painter );
         painter.end();
       }
       else
       {
-        drawLabeling( mSettings, mLabelJob.context, mLabelingEngineV2.get(), mPainter );
+        drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), mPainter );
       }
 
       mLabelJob.complete = true;
@@ -318,8 +318,7 @@ void QgsMapRendererCustomPainterJob::doRender()
   QgsDebugMsgLevel( "Rendering completed in (seconds): " + QString( "%1" ).arg( renderTime.elapsed() / 1000.0 ), 2 );
 }
 
-
-void QgsMapRendererJob::drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter )
+void QgsMapRendererJob::drawLabeling( QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter )
 {
   QgsDebugMsgLevel( QStringLiteral( "Draw labeling start" ), 5 );
 
@@ -329,22 +328,22 @@ void QgsMapRendererJob::drawLabeling( const QgsMapSettings &settings, QgsRenderC
   // Reset the composition mode before rendering the labels
   painter->setCompositionMode( QPainter::CompositionMode_SourceOver );
 
-  // TODO: this is not ideal - we could override rendering stopped flag that has been set in meanwhile
-  renderContext = QgsRenderContext::fromMapSettings( settings );
   renderContext.setPainter( painter );
 
   if ( labelingEngine2 )
   {
-    // set correct extent
-    renderContext.setExtent( settings.visibleExtent() );
-    renderContext.setCoordinateTransform( QgsCoordinateTransform() );
-
     labelingEngine2->run( renderContext );
   }
 
   QgsDebugMsg( QStringLiteral( "Draw labeling took (seconds): %1" ).arg( t.elapsed() / 1000. ) );
 }
 
+void QgsMapRendererJob::drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter )
+{
+  Q_UNUSED( settings );
+
+  drawLabeling( renderContext, labelingEngine2, painter );
+}
 
 bool QgsMapRendererJob::needTemporaryImage( QgsMapLayer *ml )
 {
diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h
@@ -286,8 +286,14 @@ class CORE_EXPORT QgsMapRendererJob : public QObject
      */
     void cleanupLabelJob( LabelRenderJob &job ) SIP_SKIP;
 
+    /**
+     * \note not available in Python bindings
+     * \deprecated Will be removed in QGIS 4.0
+     */
+    Q_DECL_DEPRECATED static void drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter ) SIP_SKIP;
+
     //! \note not available in Python bindings
-    static void drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter ) SIP_SKIP;
+    static void drawLabeling( QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter ) SIP_SKIP;
 
   private:
 
diff --git a/src/core/qgsmaprendererparalleljob.cpp b/src/core/qgsmaprendererparalleljob.cpp
@@ -297,7 +297,7 @@ void QgsMapRendererParallelJob::renderLabelsStatic( QgsMapRendererParallelJob *s
     // draw the labels!
     try
     {
-      drawLabeling( self->mSettings, job.context, self->mLabelingEngineV2.get(), &painter );
+      drawLabeling( job.context, self->mLabelingEngineV2.get(), &painter );
     }
     catch ( QgsException &e )
     {

Original file line number	Diff line number	Diff line change
`@@ -183,6 +183,7 @@ emitted when asynchronous rendering is finished (or canceled).`
`183`	`183`
`184`	`184`
`185`	`185`
	`186`	`+`
`186`	`187`	`};`
`187`	`188`
`188`	`189`
Original file line number	Diff line number	Diff line change
`@@ -295,12 +295,12 @@ void QgsMapRendererCustomPainterJob::doRender()`
`295`	`295`	`mLabelJob.img->fill( 0 );`
`296`	`296`	`painter.begin( mLabelJob.img );`
`297`	`297`	`mLabelJob.context.setPainter( &painter );`
`298`		`- drawLabeling( mSettings, mLabelJob.context, mLabelingEngineV2.get(), &painter );`
	`298`	`+ drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), &painter );`
`299`	`299`	`painter.end();`
`300`	`300`	`}`
`301`	`301`	`else`
`302`	`302`	`{`
`303`		`- drawLabeling( mSettings, mLabelJob.context, mLabelingEngineV2.get(), mPainter );`
	`303`	`+ drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), mPainter );`
`304`	`304`	`}`
`305`	`305`
`306`	`306`	`mLabelJob.complete = true;`
`@@ -318,8 +318,7 @@ void QgsMapRendererCustomPainterJob::doRender()`
`318`	`318`	`QgsDebugMsgLevel( "Rendering completed in (seconds): " + QString( "%1" ).arg( renderTime.elapsed() / 1000.0 ), 2 );`
`319`	`319`	`}`
`320`	`320`
`321`		`-`
`322`		`-void QgsMapRendererJob::drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine labelingEngine2, QPainter painter )`
	`321`	`+void QgsMapRendererJob::drawLabeling( QgsRenderContext &renderContext, QgsLabelingEngine labelingEngine2, QPainter painter )`
`323`	`322`	`{`
`324`	`323`	`QgsDebugMsgLevel( QStringLiteral( "Draw labeling start" ), 5 );`
`325`	`324`
`@@ -329,22 +328,22 @@ void QgsMapRendererJob::drawLabeling( const QgsMapSettings &settings, QgsRenderC`
`329`	`328`	`// Reset the composition mode before rendering the labels`
`330`	`329`	`painter->setCompositionMode( QPainter::CompositionMode_SourceOver );`
`331`	`330`
`332`		`- // TODO: this is not ideal - we could override rendering stopped flag that has been set in meanwhile`
`333`		`- renderContext = QgsRenderContext::fromMapSettings( settings );`
`334`	`331`	`renderContext.setPainter( painter );`
`335`	`332`
`336`	`333`	`if ( labelingEngine2 )`
`337`	`334`	`{`
`338`		`- // set correct extent`
`339`		`- renderContext.setExtent( settings.visibleExtent() );`
`340`		`- renderContext.setCoordinateTransform( QgsCoordinateTransform() );`
`341`		`-`
`342`	`335`	`labelingEngine2->run( renderContext );`
`343`	`336`	`}`
`344`	`337`
`345`	`338`	`QgsDebugMsg( QStringLiteral( "Draw labeling took (seconds): %1" ).arg( t.elapsed() / 1000. ) );`
`346`	`339`	`}`
`347`	`340`
	`341`	`+void QgsMapRendererJob::drawLabeling( const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine labelingEngine2, QPainter painter )`
	`342`	`+{`
	`343`	`+ Q_UNUSED( settings );`
	`344`	`+`
	`345`	`+ drawLabeling( renderContext, labelingEngine2, painter );`
	`346`	`+}`
`348`	`347`
`349`	`348`	`bool QgsMapRendererJob::needTemporaryImage( QgsMapLayer *ml )`
`350`	`349`	`{`
Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ void QgsMapRendererParallelJob::renderLabelsStatic( QgsMapRendererParallelJob *s`
`297`	`297`	`// draw the labels!`
`298`	`298`	`try`
`299`	`299`	`{`
`300`		`- drawLabeling( self->mSettings, job.context, self->mLabelingEngineV2.get(), &painter );`
	`300`	`+ drawLabeling( job.context, self->mLabelingEngineV2.get(), &painter );`
`301`	`301`	`}`
`302`	`302`	`catch ( QgsException &e )`
`303`	`303`	`{`