Ensure we correctly set qt item caching only when appropriate

qgis · Oct 19, 2023 · 7e73b9b · 7e73b9b
1 parent 7ec2083
commit 7e73b9b
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 4 deletions.
diff --git a/python/core/auto_generated/layout/qgslayoutitem.sip.in b/python/core/auto_generated/layout/qgslayoutitem.sip.in
@@ -280,6 +280,7 @@ Base class for graphical items within a :py:class:`QgsLayout`.
     {
       FlagOverridesPaint,
       FlagProvidesClipPath,
+      FlagDisableSceneCaching,
     };
     typedef QFlags<QgsLayoutItem::Flag> Flags;
 

diff --git a/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in b/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in
@@ -127,6 +127,7 @@ Constructor for a QgsLayoutNodesItem with the given ``polygon`` nodes, attached
 
     virtual void draw( QgsLayoutItemRenderContext &context );
 
+    virtual QgsLayoutItem::Flags itemFlags() const;
 
     virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
 

diff --git a/src/core/layout/qgslayoutitem.cpp b/src/core/layout/qgslayoutitem.cpp
@@ -1579,7 +1579,7 @@ void QgsLayoutItem::refreshBlendMode()
 
   // we can only enable caching if no blend mode is set -- otherwise
   // we need to redraw the item every time it is painted
-  if ( mEvaluatedBlendMode == QPainter::CompositionMode_Source )
+  if ( mEvaluatedBlendMode == QPainter::CompositionMode_Source && !( itemFlags() & QgsLayoutItem::FlagDisableSceneCaching ) )
     setCacheMode( QGraphicsItem::DeviceCoordinateCache );
   else
     setCacheMode( QGraphicsItem::NoCache );

diff --git a/src/core/layout/qgslayoutitem.h b/src/core/layout/qgslayoutitem.h
@@ -334,6 +334,7 @@ class CORE_EXPORT QgsLayoutItem : public QgsLayoutObject, public QGraphicsRectIt
     {
       FlagOverridesPaint = 1 << 1,  //!< Item overrides the default layout item painting method
       FlagProvidesClipPath = 1 << 2, //!< Item can act as a clipping path provider (see clipPath())
+      FlagDisableSceneCaching = 1 << 3, //!< Item should not have QGraphicsItem caching enabled
     };
     Q_DECLARE_FLAGS( Flags, Flag )
 

diff --git a/src/core/layout/qgslayoutitemelevationprofile.cpp b/src/core/layout/qgslayoutitemelevationprofile.cpp
@@ -446,7 +446,7 @@ void QgsLayoutItemElevationProfile::refreshDataDefinedProperty( DataDefinedPrope
 
 QgsLayoutItem::Flags QgsLayoutItemElevationProfile::itemFlags() const
 {
-  return QgsLayoutItem::FlagOverridesPaint;
+  return QgsLayoutItem::FlagOverridesPaint | QgsLayoutItem::FlagDisableSceneCaching;
 }
 
 bool QgsLayoutItemElevationProfile::requiresRasterization() const

diff --git a/src/core/layout/qgslayoutitemmap.cpp b/src/core/layout/qgslayoutitemmap.cpp
@@ -113,7 +113,7 @@ QIcon QgsLayoutItemMap::icon() const
 
 QgsLayoutItem::Flags QgsLayoutItemMap::itemFlags() const
 {
-  return QgsLayoutItem::FlagOverridesPaint;
+  return QgsLayoutItem::FlagOverridesPaint | QgsLayoutItem::FlagDisableSceneCaching;
 }
 
 void QgsLayoutItemMap::assignFreeId()

diff --git a/src/core/layout/qgslayoutitemnodeitem.cpp b/src/core/layout/qgslayoutitemnodeitem.cpp
@@ -85,6 +85,11 @@ void QgsLayoutNodesItem::draw( QgsLayoutItemRenderContext &context )
     drawNodes( context );
 }
 
+QgsLayoutItem::Flags QgsLayoutNodesItem::itemFlags() const
+{
+  return QgsLayoutItem::FlagDisableSceneCaching;
+}
+
 double QgsLayoutNodesItem::computeDistance( QPointF pt1,
     QPointF pt2 ) const
 {

diff --git a/src/core/layout/qgslayoutitemnodeitem.h b/src/core/layout/qgslayoutitemnodeitem.h
@@ -127,7 +127,7 @@ class CORE_EXPORT QgsLayoutNodesItem: public QgsLayoutItem
     QgsLayoutNodesItem( const QPolygonF &polygon, QgsLayout *layout );
 
     void draw( QgsLayoutItemRenderContext &context ) override;
-
+    QgsLayoutItem::Flags itemFlags() const override;
     bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
     bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 

diff --git a/tests/src/core/testqgslayoutitem.cpp b/tests/src/core/testqgslayoutitem.cpp
@@ -1933,19 +1933,25 @@ void TestQgsLayoutItem::blendMode()
   QgsLayoutItemShape *item = new QgsLayoutItemShape( &l );
   l.addLayoutItem( item );
 
+  QCOMPARE( item->cacheMode(), QGraphicsItem::DeviceCoordinateCache );
+
   item->setBlendMode( QPainter::CompositionMode_Darken );
   QCOMPARE( item->blendMode(), QPainter::CompositionMode_Darken );
   QCOMPARE( item->blendModeForRender(), QPainter::CompositionMode_Darken );
+  // can't use caching when blend modes are active
+  QCOMPARE( item->cacheMode(), QGraphicsItem::NoCache );
 
   l.renderContext().setFlag( QgsLayoutRenderContext::FlagUseAdvancedEffects, false );
   QCOMPARE( item->blendModeForRender(), QPainter::CompositionMode_SourceOver );
   l.renderContext().setFlag( QgsLayoutRenderContext::FlagUseAdvancedEffects, true );
   QCOMPARE( item->blendModeForRender(), QPainter::CompositionMode_Darken );
+  QCOMPARE( item->cacheMode(), QGraphicsItem::NoCache );
 
   item->dataDefinedProperties().setProperty( QgsLayoutObject::BlendMode, QgsProperty::fromExpression( "'lighten'" ) );
   item->refreshDataDefinedProperty();
   QCOMPARE( item->blendMode(), QPainter::CompositionMode_Darken ); // should not change
   QCOMPARE( item->blendModeForRender(), QPainter::CompositionMode_Lighten );
+  QCOMPARE( item->cacheMode(), QGraphicsItem::NoCache );
 
   QgsLayout l2( QgsProject::instance() );
   l2.initializeDefaults();