Always render main annotation layer above all other map layers in canvas

qgis · Sep 1, 2020 · 4d51e48 · 4d51e48
1 parent 39fbc2a
commit 4d51e48
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 3 deletions.
diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -83,6 +83,7 @@ email                : sherman at mrcc.com
 #include "qgstemporalcontroller.h"
 #include "qgsruntimeprofiler.h"
 #include "qgsprojectionselectiondialog.h"
+#include "qgsannotationlayer.h"
 
 /**
  * \ingroup gui
@@ -585,13 +586,19 @@ void QgsMapCanvas::refreshMap()
     mSettings.setLayerStyleOverrides( QgsProject::instance()->mapThemeCollection()->mapThemeStyleOverrides( mTheme ) );
   }
 
+  // render main annotation layer above all other layers
+  QgsMapSettings renderSettings = mSettings;
+  QList<QgsMapLayer *> allLayers = renderSettings.layers();
+  allLayers.insert( 0, QgsProject::instance()->mainAnnotationLayer() );
+  renderSettings.setLayers( allLayers );
+
   // create the renderer job
   Q_ASSERT( !mJob );
   mJobCanceled = false;
   if ( mUseParallelRendering )
-    mJob = new QgsMapRendererParallelJob( mSettings );
+    mJob = new QgsMapRendererParallelJob( renderSettings );
   else
-    mJob = new QgsMapRendererSequentialJob( mSettings );
+    mJob = new QgsMapRendererSequentialJob( renderSettings );
   connect( mJob, &QgsMapRendererJob::finished, this, &QgsMapCanvas::rendererJobFinished );
   mJob->setCache( mCache );
 

diff --git a/tests/src/python/test_qgsmapcanvas.py b/tests/src/python/test_qgsmapcanvas.py
@@ -22,7 +22,10 @@
                        QgsFillSymbol,
                        QgsSingleSymbolRenderer,
                        QgsMapThemeCollection,
-                       QgsProject,
+                       QgsProject, QgsAnnotationPolygonItem,
+                       QgsPolygon,
+                       QgsLineString,
+                       QgsPoint,
                        QgsApplication)
 from qgis.gui import (QgsMapCanvas)
 
@@ -349,6 +352,57 @@ def testMapTheme(self):
         self.assertEqual(themeLayers, theme5Layers, 'themes are different')
         # self.assertTrue(self.canvasImageCheck('theme5', 'theme5', canvas))
 
+    def testMainAnnotationLayerRendered(self):
+        """ test that main annotation layer is rendered above all other layers """
+        canvas = QgsMapCanvas()
+        canvas.setDestinationCrs(QgsCoordinateReferenceSystem(4326))
+        canvas.setFrameStyle(0)
+        canvas.resize(600, 400)
+        self.assertEqual(canvas.width(), 600)
+        self.assertEqual(canvas.height(), 400)
+
+        layer = QgsVectorLayer("Polygon?crs=epsg:4326&field=fldtxt:string",
+                               "layer", "memory")
+        sym3 = QgsFillSymbol.createSimple({'color': '#b200b2'})
+        layer.renderer().setSymbol(sym3)
+
+        canvas.setLayers([layer])
+        canvas.setExtent(QgsRectangle(10, 30, 20, 35))
+        canvas.show()
+        # need to wait until first redraw can occur (note that we first need to wait till drawing starts!)
+        while not canvas.isDrawing():
+            app.processEvents()
+        canvas.waitWhileRendering()
+        self.assertTrue(self.canvasImageCheck('empty_canvas', 'empty_canvas', canvas))
+
+        # add polygon to layer
+        f = QgsFeature()
+        f.setGeometry(QgsGeometry.fromRect(QgsRectangle(5, 25, 25, 45)))
+        self.assertTrue(layer.dataProvider().addFeatures([f]))
+
+        # refresh canvas
+        canvas.refresh()
+        canvas.waitWhileRendering()
+
+        # no annotation yet...
+        self.assertFalse(self.canvasImageCheck('main_annotation_layer', 'main_annotation_layer', canvas))
+
+        annotation_layer = QgsProject.instance().mainAnnotationLayer()
+        annotation_layer.setCrs(QgsCoordinateReferenceSystem(4326))
+        annotation_geom = QgsGeometry.fromRect(QgsRectangle(12, 30, 18, 33))
+        annotation = QgsAnnotationPolygonItem(annotation_geom.constGet().clone())
+        sym3 = QgsFillSymbol.createSimple({'color': '#ff0000', 'outline_style': 'no'})
+        annotation.setSymbol(sym3)
+        annotation_layer.addItem(annotation)
+
+        # refresh canvas
+        canvas.refresh()
+        canvas.waitWhileRendering()
+
+        # annotation must be rendered over other layers
+        self.assertTrue(self.canvasImageCheck('main_annotation_layer', 'main_annotation_layer', canvas))
+        annotation_layer.clear()
+
     def canvasImageCheck(self, name, reference_image, canvas):
         self.report += "<h2>Render {}</h2>\n".format(name)
         temp_dir = QDir.tempPath() + '/'

diff --git a/...ges/mapcanvas/expected_main_annotation_layer/expected_main_annotation_layer.png b/...ges/mapcanvas/expected_main_annotation_layer/expected_main_annotation_layer.png