Add a flag which can be set on QgsSymbols to indicate that a renderer

should use symbol levels whenever that symbol is used by the renderer Not exposed to users -- only settable via API, but IS saved in the symbol's XML definition and restored when loading a symbol from XML.
qgis · May 26, 2021 · 86b3459 · 86b3459
1 parent 92639ae
commit 86b3459
Show file tree

Hide file tree

Showing 11 changed files with 90 additions and 0 deletions.
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -53,6 +53,10 @@
 QgsSymbol.DynamicRotation.__doc__ = "Rotation of symbol may be changed during rendering and symbol should not be cached"
 Qgis.SymbolRenderHint.__doc__ = 'Flags controlling behavior of symbols during rendering\n\n.. versionadded:: 3.20\n\n' + '* ``DynamicRotation``: ' + Qgis.SymbolRenderHint.DynamicRotation.__doc__
 # --
+# monkey patching scoped based enum
+Qgis.SymbolFlag.RendererShouldUseSymbolLevels.__doc__ = "If present, indicates that a QgsFeatureRenderer using the symbol should use symbol levels for best results"
+Qgis.SymbolFlag.__doc__ = 'Flags controlling behavior of symbols\n\n.. versionadded:: 3.20\n\n' + '* ``RendererShouldUseSymbolLevels``: ' + Qgis.SymbolFlag.RendererShouldUseSymbolLevels.__doc__
+# --
 QgsSymbol.PreviewFlag = Qgis.SymbolPreviewFlag
 # monkey patching scoped based enum
 QgsSymbol.FlagIncludeCrosshairsForMarkerSymbols = Qgis.SymbolPreviewFlag.FlagIncludeCrosshairsForMarkerSymbols

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -138,6 +138,13 @@ The development version
     typedef QFlags<Qgis::SymbolRenderHint> SymbolRenderHints;
 
 
+    enum class SymbolFlag
+    {
+      RendererShouldUseSymbolLevels,
+    };
+    typedef QFlags<Qgis::SymbolFlag> SymbolFlags;
+
+
     enum class SymbolPreviewFlag
       {
       FlagIncludeCrosshairsForMarkerSymbols,
@@ -245,6 +252,8 @@ GEOS string version linked
 
 QFlags<Qgis::SymbolRenderHint> operator|(Qgis::SymbolRenderHint f1, QFlags<Qgis::SymbolRenderHint> f2);
 
+QFlags<Qgis::SymbolFlag> operator|(Qgis::SymbolFlag f1, QFlags<Qgis::SymbolFlag> f2);
+
 QFlags<Qgis::SymbolPreviewFlag> operator|(Qgis::SymbolPreviewFlag f1, QFlags<Qgis::SymbolPreviewFlag> f2);
 
 

diff --git a/python/core/auto_generated/symbology/qgssymbol.sip.in b/python/core/auto_generated/symbology/qgssymbol.sip.in
@@ -437,6 +437,24 @@ Sets rendering hint flags for the symbol.
 Returns the rendering hint flags for the symbol.
 
 .. seealso:: :py:func:`setRenderHints`
+%End
+
+    void setFlags( Qgis::SymbolFlags flags );
+%Docstring
+Sets ``flags`` for the symbol.
+
+.. seealso:: :py:func:`flags`
+
+.. versionadded:: 3.320
+%End
+
+    Qgis::SymbolFlags flags() const;
+%Docstring
+Returns flags for the symbol.
+
+.. seealso:: :py:func:`setFlags`
+
+.. versionadded:: 3.20
 %End
 
     void setClipFeaturesToExtent( bool clipFeaturesToExtent );
@@ -668,6 +686,8 @@ Render editing vertex marker at specified point
 
 
 
+
+
   private:
     QgsSymbol( const QgsSymbol & );
 };

diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -192,6 +192,17 @@ class CORE_EXPORT Qgis
     };
     Q_DECLARE_FLAGS( SymbolRenderHints, SymbolRenderHint )
 
+    /**
+     * \brief Flags controlling behavior of symbols
+     *
+     * \since QGIS 3.20
+     */
+    enum class SymbolFlag : int
+    {
+      RendererShouldUseSymbolLevels = 1 << 0, //!< If present, indicates that a QgsFeatureRenderer using the symbol should use symbol levels for best results
+    };
+    Q_DECLARE_FLAGS( SymbolFlags, SymbolFlag )
+
     /**
      * Flags for controlling how symbol preview images are generated.
      *
@@ -366,6 +377,7 @@ class CORE_EXPORT Qgis
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolRenderHints )
+Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolFlags )
 Q_DECLARE_OPERATORS_FOR_FLAGS( Qgis::SymbolPreviewFlags )
 
 

diff --git a/src/core/symbology/qgsfillsymbol.cpp b/src/core/symbology/qgsfillsymbol.cpp
@@ -150,6 +150,7 @@ QgsFillSymbol *QgsFillSymbol::clone() const
   cloneSymbol->setClipFeaturesToExtent( mClipFeaturesToExtent );
   cloneSymbol->setForceRHR( mForceRHR );
   cloneSymbol->setDataDefinedProperties( dataDefinedProperties() );
+  cloneSymbol->setFlags( mSymbolFlags );
   return cloneSymbol;
 }
 

diff --git a/src/core/symbology/qgslinesymbol.cpp b/src/core/symbology/qgslinesymbol.cpp
@@ -281,5 +281,6 @@ QgsLineSymbol *QgsLineSymbol::clone() const
   cloneSymbol->setClipFeaturesToExtent( mClipFeaturesToExtent );
   cloneSymbol->setForceRHR( mForceRHR );
   cloneSymbol->setDataDefinedProperties( dataDefinedProperties() );
+  cloneSymbol->setFlags( mSymbolFlags );
   return cloneSymbol;
 }
diff --git a/src/core/symbology/qgsmarkersymbol.cpp b/src/core/symbology/qgsmarkersymbol.cpp
@@ -484,6 +484,7 @@ QgsMarkerSymbol *QgsMarkerSymbol::clone() const
   cloneSymbol->setClipFeaturesToExtent( mClipFeaturesToExtent );
   cloneSymbol->setForceRHR( mForceRHR );
   cloneSymbol->setDataDefinedProperties( dataDefinedProperties() );
+  cloneSymbol->setFlags( mSymbolFlags );
   return cloneSymbol;
 }
 
diff --git a/src/core/symbology/qgssymbol.h b/src/core/symbology/qgssymbol.h
@@ -447,6 +447,22 @@ class CORE_EXPORT QgsSymbol
      */
     Qgis::SymbolRenderHints renderHints() const { return mRenderHints; }
 
+    /**
+     * Sets \a flags for the symbol.
+     *
+     * \see flags()
+     * \since QGIS 3.320
+     */
+    void setFlags( Qgis::SymbolFlags flags ) { mSymbolFlags = flags; }
+
+    /**
+     * Returns flags for the symbol.
+     *
+     * \see setFlags()
+     * \since QGIS 3.20
+     */
+    Qgis::SymbolFlags flags() const { return mSymbolFlags; }
+
     /**
      * Sets whether features drawn by the symbol should be clipped to the render context's
      * extent. If this option is enabled then features which are partially outside the extent
@@ -680,6 +696,14 @@ class CORE_EXPORT QgsSymbol
     qreal mOpacity = 1.0;
 
     Qgis::SymbolRenderHints mRenderHints;
+
+    /**
+     * Symbol flags.
+     *
+     * \since QGIS 3.20
+     */
+    Qgis::SymbolFlags mSymbolFlags = Qgis::SymbolFlags();
+
     bool mClipFeaturesToExtent = true;
     bool mForceRHR = false;
 

diff --git a/src/core/symbology/qgssymbollayerutils.cpp b/src/core/symbology/qgssymbollayerutils.cpp
@@ -1148,6 +1148,10 @@ QgsSymbol *QgsSymbolLayerUtils::loadSymbol( const QDomElement &element, const Qg
   symbol->setOpacity( element.attribute( QStringLiteral( "alpha" ), QStringLiteral( "1.0" ) ).toDouble() );
   symbol->setClipFeaturesToExtent( element.attribute( QStringLiteral( "clip_to_extent" ), QStringLiteral( "1" ) ).toInt() );
   symbol->setForceRHR( element.attribute( QStringLiteral( "force_rhr" ), QStringLiteral( "0" ) ).toInt() );
+  Qgis::SymbolFlags flags;
+  if ( element.attribute( QStringLiteral( "renderer_should_use_levels" ), QStringLiteral( "0" ) ).toInt() )
+    flags |= Qgis::SymbolFlag::RendererShouldUseSymbolLevels;
+  symbol->setFlags( flags );
 
   QDomElement ddProps = element.firstChildElement( QStringLiteral( "data_defined_properties" ) );
   if ( !ddProps.isNull() )
@@ -1230,6 +1234,9 @@ QDomElement QgsSymbolLayerUtils::saveSymbol( const QString &name, const QgsSymbo
   symEl.setAttribute( QStringLiteral( "alpha" ), QString::number( symbol->opacity() ) );
   symEl.setAttribute( QStringLiteral( "clip_to_extent" ), symbol->clipFeaturesToExtent() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
   symEl.setAttribute( QStringLiteral( "force_rhr" ), symbol->forceRHR() ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
+  if ( symbol->flags() & Qgis::SymbolFlag::RendererShouldUseSymbolLevels )
+    symEl.setAttribute( QStringLiteral( "renderer_should_use_levels" ), QStringLiteral( "1" ) );
+
   //QgsDebugMsg( "num layers " + QString::number( symbol->symbolLayerCount() ) );
 
   QDomElement ddProps = doc.createElement( QStringLiteral( "data_defined_properties" ) );

diff --git a/src/gui/symbology/qgssinglesymbolrendererwidget.cpp b/src/gui/symbology/qgssinglesymbolrendererwidget.cpp
@@ -112,6 +112,12 @@ void QgsSingleSymbolRendererWidget::disableSymbolLevels()
 void QgsSingleSymbolRendererWidget::setSymbolLevels( const QList<QgsLegendSymbolItem> &levels, bool enabled )
 {
   mSingleSymbol.reset( levels.at( 0 ).symbol()->clone() );
+  if ( !enabled )
+  {
+    // remove the renderer symbol levels flag (if present), as we don't symbol levels automatically re-enabling when other changes
+    // are made to the symbol
+    mSingleSymbol->setFlags( mSingleSymbol->flags() & ~Qgis::SymbolFlags( Qgis::SymbolFlag::RendererShouldUseSymbolLevels ) );
+  }
   mRenderer->setSymbol( mSingleSymbol->clone() );
   mRenderer->setUsingSymbolLevels( enabled );
   mSelector->loadSymbol( mSingleSymbol.get() );
@@ -122,6 +128,10 @@ void QgsSingleSymbolRendererWidget::changeSingleSymbol()
 {
   // update symbol from the GUI
   mRenderer->setSymbol( mSingleSymbol->clone() );
+
+  if ( mSingleSymbol->flags() & Qgis::SymbolFlag::RendererShouldUseSymbolLevels )
+    mRenderer->setUsingSymbolLevels( true );
+
   emit widgetChanged();
 }
 

diff --git a/src/gui/symbology/qgssymbolslistwidget.cpp b/src/gui/symbology/qgssymbolslistwidget.cpp
@@ -581,6 +581,7 @@ void QgsSymbolsListWidget::setSymbolFromStyle( const QString &name, QgsStyle::St
     mSymbol->appendSymbolLayer( sl );
   }
   mSymbol->setOpacity( s->opacity() );
+  mSymbol->setFlags( s->flags() );
 
   updateSymbolInfo();
   emit changed();