Fix clipped render when using geometry generator symbol in layout items

Fixes #58909
qgis · Oct 1, 2024 · aa7a8d7 · aa7a8d7
1 parent f67ebd4
commit aa7a8d7
Show file tree

Hide file tree

Showing 9 changed files with 180 additions and 20 deletions.
diff --git a/src/core/layout/qgslayoutitempolygon.cpp b/src/core/layout/qgslayoutitempolygon.cpp
@@ -136,18 +136,23 @@ QgsFillSymbol *QgsLayoutItemPolygon::symbol()
 
 void QgsLayoutItemPolygon::_draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem * )
 {
+  QgsRenderContext renderContext = context.renderContext();
+  // symbol clipping messes with geometry generators used in the symbol for this item, and has no
+  // valid use here. See https://github.com/qgis/QGIS/issues/58909
+  renderContext.setFlag( Qgis::RenderContextFlag::DisableSymbolClippingToExtent );
+
   //setup painter scaling to dots so that raster symbology is drawn to scale
-  const double scale = context.renderContext().convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
+  const double scale = renderContext.convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
   const QTransform t = QTransform::fromScale( scale, scale );
 
   const QVector<QPolygonF> rings; //empty
   QPainterPath polygonPath;
   polygonPath.addPolygon( mPolygon );
 
-  mPolygonStyleSymbol->startRender( context.renderContext() );
+  mPolygonStyleSymbol->startRender( renderContext );
   mPolygonStyleSymbol->renderPolygon( polygonPath.toFillPolygon( t ), &rings,
-                                      nullptr, context.renderContext() );
-  mPolygonStyleSymbol->stopRender( context.renderContext() );
+                                      nullptr, renderContext );
+  mPolygonStyleSymbol->stopRender( renderContext );
 }
 
 void QgsLayoutItemPolygon::_readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context )

diff --git a/src/core/layout/qgslayoutitempolyline.cpp b/src/core/layout/qgslayoutitempolyline.cpp
@@ -280,20 +280,25 @@ QString QgsLayoutItemPolyline::displayName() const
 
 void QgsLayoutItemPolyline::_draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem * )
 {
-  const QgsScopedQPainterState painterState( context.renderContext().painter() );
+  QgsRenderContext renderContext = context.renderContext();
+  // symbol clipping messes with geometry generators used in the symbol for this item, and has no
+  // valid use here. See https://github.com/qgis/QGIS/issues/58909
+  renderContext.setFlag( Qgis::RenderContextFlag::DisableSymbolClippingToExtent );
+
+  const QgsScopedQPainterState painterState( renderContext.painter() );
   //setup painter scaling to dots so that raster symbology is drawn to scale
-  const double scale = context.renderContext().convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
+  const double scale = renderContext.convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
   const QTransform t = QTransform::fromScale( scale, scale );
 
-  mPolylineStyleSymbol->startRender( context.renderContext() );
-  mPolylineStyleSymbol->renderPolyline( t.map( mPolygon ), nullptr, context.renderContext() );
-  mPolylineStyleSymbol->stopRender( context.renderContext() );
+  mPolylineStyleSymbol->startRender( renderContext );
+  mPolylineStyleSymbol->renderPolyline( t.map( mPolygon ), nullptr, renderContext );
+  mPolylineStyleSymbol->stopRender( renderContext );
 
   // painter is scaled to dots, so scale back to layout units
-  context.renderContext().painter()->scale( context.renderContext().scaleFactor(), context.renderContext().scaleFactor() );
+  renderContext.painter()->scale( renderContext.scaleFactor(), renderContext.scaleFactor() );
 
-  drawStartMarker( context.renderContext().painter() );
-  drawEndMarker( context.renderContext().painter() );
+  drawStartMarker( renderContext.painter() );
+  drawEndMarker( renderContext.painter() );
 }
 
 void QgsLayoutItemPolyline::_readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context )

diff --git a/src/core/layout/qgslayoutitemshape.cpp b/src/core/layout/qgslayoutitemshape.cpp
@@ -196,17 +196,22 @@ bool QgsLayoutItemShape::accept( QgsStyleEntityVisitorInterface *visitor ) const
 
 void QgsLayoutItemShape::draw( QgsLayoutItemRenderContext &context )
 {
-  QPainter *painter = context.renderContext().painter();
+  QgsRenderContext renderContext = context.renderContext();
+  // symbol clipping messes with geometry generators used in the symbol for this item, and has no
+  // valid use here. See https://github.com/qgis/QGIS/issues/58909
+  renderContext.setFlag( Qgis::RenderContextFlag::DisableSymbolClippingToExtent );
+
+  QPainter *painter = renderContext.painter();
   painter->setPen( Qt::NoPen );
   painter->setBrush( Qt::NoBrush );
 
-  const double scale = context.renderContext().convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
+  const double scale = renderContext.convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
 
   const QVector<QPolygonF> rings; //empty list
 
-  symbol()->startRender( context.renderContext() );
-  symbol()->renderPolygon( calculatePolygon( scale ), &rings, nullptr, context.renderContext() );
-  symbol()->stopRender( context.renderContext() );
+  symbol()->startRender( renderContext );
+  symbol()->renderPolygon( calculatePolygon( scale ), &rings, nullptr, renderContext );
+  symbol()->stopRender( renderContext );
 }
 
 QPolygonF QgsLayoutItemShape::calculatePolygon( double scale ) const

diff --git a/tests/src/python/test_qgslayoutpolygon.py b/tests/src/python/test_qgslayoutpolygon.py
@@ -22,7 +22,11 @@
     QgsLayoutItemRenderContext,
     QgsLayoutUtils,
     QgsProject,
-    QgsReadWriteContext
+    QgsReadWriteContext,
+    QgsLayoutItemMap,
+    QgsRectangle,
+    Qgis,
+    QgsGeometryGeneratorSymbolLayer
 )
 import unittest
 from qgis.testing import start_app, QgisTestCase
@@ -373,6 +377,51 @@ def testClipPath(self):
         p.end()
         self.assertEqual(len(spy), 5)
 
+    def test_generator(self):
+        project = QgsProject()
+        layout = QgsLayout(project)
+        layout.initializeDefaults()
+
+        p = QPolygonF()
+        p.append(QPointF(0.0, 0.0))
+        p.append(QPointF(100.0, 10.0))
+        p.append(QPointF(200.0, 100.0))
+        shape = QgsLayoutItemPolygon(p, layout)
+        layout.addLayoutItem(shape)
+
+        map = QgsLayoutItemMap(layout)
+        map.attemptSetSceneRect(QRectF(0, 0, 10, 10))
+        map.zoomToExtent(QgsRectangle(1, 1, 2, 2))
+        layout.addLayoutItem(map)
+
+        props = {}
+        props["color"] = "green"
+        props["style"] = "solid"
+        props["style_border"] = "solid"
+        props["color_border"] = "red"
+        props["width_border"] = "6.0"
+        props["joinstyle"] = "miter"
+
+        sub_symbol = QgsFillSymbol.createSimple(props)
+
+        line_symbol = QgsFillSymbol()
+        generator = QgsGeometryGeneratorSymbolLayer.create({
+            'geometryModifier': "geom_from_wkt('POLYGON((10 10,287 10,287 200,10 200,10 10))')",
+            'SymbolType': 'Fill',
+        })
+        generator.setUnits(Qgis.RenderUnit.Millimeters)
+        generator.setSubSymbol(sub_symbol)
+
+        line_symbol.changeSymbolLayer(0, generator)
+        shape.setSymbol(line_symbol)
+
+        self.assertTrue(
+            self.render_layout_check(
+                'polygon_generator',
+                layout
+            )
+        )
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/src/python/test_qgslayoutpolyline.py b/tests/src/python/test_qgslayoutpolyline.py
@@ -9,16 +9,20 @@
 __date__ = '14/03/2016'
 __copyright__ = 'Copyright 2016, The QGIS Project'
 
-from qgis.PyQt.QtCore import QPointF
+from qgis.PyQt.QtCore import QPointF, QRectF
 from qgis.PyQt.QtGui import QPolygonF
 from qgis.PyQt.QtXml import QDomDocument
 from qgis.core import (
+    Qgis,
     QgsLayout,
     QgsLayoutItemPolyline,
+    QgsLayoutItemMap,
     QgsLayoutItemRegistry,
     QgsLineSymbol,
     QgsProject,
-    QgsReadWriteContext
+    QgsReadWriteContext,
+    QgsGeometryGeneratorSymbolLayer,
+    QgsRectangle
 )
 import unittest
 from qgis.testing import start_app, QgisTestCase
@@ -384,6 +388,47 @@ def testVerticalLine(self):
             )
         )
 
+    def test_generator(self):
+        project = QgsProject()
+        layout = QgsLayout(project)
+        layout.initializeDefaults()
+
+        p = QPolygonF()
+        p.append(QPointF(0.0, 0.0))
+        p.append(QPointF(100.0, 100.0))
+        shape = QgsLayoutItemPolyline(p, layout)
+        layout.addLayoutItem(shape)
+
+        map = QgsLayoutItemMap(layout)
+        map.attemptSetSceneRect(QRectF(0, 0, 10, 10))
+        map.zoomToExtent(QgsRectangle(1, 1, 2, 2))
+        layout.addLayoutItem(map)
+
+        props = {}
+        props["color"] = "0,0,0,255"
+        props["width"] = "10.0"
+        props["capstyle"] = "square"
+
+        sub_symbol = QgsLineSymbol.createSimple(props)
+
+        line_symbol = QgsLineSymbol()
+        generator = QgsGeometryGeneratorSymbolLayer.create({
+            'geometryModifier': "geom_from_wkt('POLYGON((10 10,287 10,287 200,10 200,10 10))')",
+            'SymbolType': 'Line',
+        })
+        generator.setUnits(Qgis.RenderUnit.Millimeters)
+        generator.setSubSymbol(sub_symbol)
+
+        line_symbol.changeSymbolLayer(0, generator)
+        shape.setSymbol(line_symbol)
+
+        self.assertTrue(
+            self.render_layout_check(
+                'polyline_generator',
+                layout
+            )
+        )
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/tests/src/python/test_qgslayoutshape.py b/tests/src/python/test_qgslayoutshape.py
@@ -21,6 +21,10 @@
     QgsProject,
     QgsReadWriteContext,
     QgsUnitTypes,
+    QgsLayoutItemMap,
+    Qgis,
+    QgsGeometryGeneratorSymbolLayer,
+    QgsRectangle
 )
 import unittest
 from qgis.testing import start_app, QgisTestCase
@@ -37,6 +41,10 @@ def setUpClass(cls):
         super(TestQgsLayoutShape, cls).setUpClass()
         cls.item_class = QgsLayoutItemShape
 
+    @classmethod
+    def control_path_prefix(cls):
+        return "layout_shape"
+
     def testClipPath(self):
         pr = QgsProject()
         l = QgsLayout(pr)
@@ -101,6 +109,49 @@ def testBoundingRectForStrokeSizeOnRestore(self):
         # bounding rect for item should include stroke
         self.assertEqual(shape2.boundingRect(), QRectF(-20.0, -20.0, 140.0, 240.0))
 
+    def test_generator(self):
+        project = QgsProject()
+        layout = QgsLayout(project)
+        layout.initializeDefaults()
+
+        shape = QgsLayoutItemShape(layout)
+        shape.setShapeType(QgsLayoutItemShape.Shape.Rectangle)
+        shape.attemptSetSceneRect(QRectF(0, 0, 100, 200))
+        layout.addLayoutItem(shape)
+
+        map = QgsLayoutItemMap(layout)
+        map.attemptSetSceneRect(QRectF(0, 0, 10, 10))
+        map.zoomToExtent(QgsRectangle(1, 1, 2, 2))
+        layout.addLayoutItem(map)
+
+        props = {}
+        props["color"] = "green"
+        props["style"] = "solid"
+        props["style_border"] = "solid"
+        props["color_border"] = "red"
+        props["width_border"] = "6.0"
+        props["joinstyle"] = "miter"
+
+        sub_symbol = QgsFillSymbol.createSimple(props)
+
+        line_symbol = QgsFillSymbol()
+        generator = QgsGeometryGeneratorSymbolLayer.create({
+            'geometryModifier': "geom_from_wkt('POLYGON((10 10,287 10,287 200,10 200,10 10))')",
+            'SymbolType': 'Fill',
+        })
+        generator.setUnits(Qgis.RenderUnit.Millimeters)
+        generator.setSubSymbol(sub_symbol)
+
+        line_symbol.changeSymbolLayer(0, generator)
+        shape.setSymbol(line_symbol)
+
+        self.assertTrue(
+            self.render_layout_check(
+                'layoutshape_generator',
+                layout
+            )
+        )
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/...ages/composer_polygon/expected_polygon_generator/expected_polygon_generator.png b/...ages/composer_polygon/expected_polygon_generator/expected_polygon_generator.png
diff --git a/...s/composer_polyline/expected_polyline_generator/expected_polyline_generator.png b/...s/composer_polyline/expected_polyline_generator/expected_polyline_generator.png
diff --git a/.../layout_shape/expected_layoutshape_generator/expected_layoutshape_generator.png b/.../layout_shape/expected_layoutshape_generator/expected_layoutshape_generator.png