qgsrulebasedrendererv2.h

Go to the documentation of this file.

/***************************************************************************
    qgsrulebasedrendererv2.h - Rule-based renderer (symbology-ng)
    ---------------------
    begin                : May 2010
    copyright            : (C) 2010 by Martin Dobias
    email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSRULEBASEDRENDERERV2_H
#define QGSRULEBASEDRENDERERV2_H

#include "qgsfield.h"
#include "qgsfeature.h"
#include "qgis.h"

#include "qgsrendererv2.h"

class QgsExpression;

class QgsCategorizedSymbolRendererV2;
class QgsGraduatedSymbolRendererV2;

class CORE_EXPORT QgsRuleBasedRendererV2 : public QgsFeatureRendererV2
{
  public:
    // TODO: use QVarLengthArray instead of QList

    enum FeatureFlags { FeatIsSelected = 1, FeatDrawMarkers = 2 };

    // feature for rendering: QgsFeature and some flags
    struct FeatureToRender
    {
      FeatureToRender( QgsFeature& _f, int _flags )
          : feat( _f )
          , flags( _flags )
      {}
      QgsFeature feat;
      int flags; // selected and/or draw markers
    };

    // rendering job: a feature to be rendered with a particular symbol
    // (both f, symbol are _not_ owned by this class)
    struct RenderJob
    {
      RenderJob( FeatureToRender& _ftr, QgsSymbolV2* _s )
          : ftr( _ftr )
          , symbol( _s )
      {}
      FeatureToRender& ftr;
      QgsSymbolV2* symbol;
    };

    // render level: a list of jobs to be drawn at particular level
    // (jobs are owned by this class)
    struct RenderLevel
    {
      explicit RenderLevel( int z ): zIndex( z ) {}
      ~RenderLevel() { Q_FOREACH ( RenderJob* j, jobs ) delete j; }
      int zIndex;
      QList<RenderJob*> jobs;

      RenderLevel& operator=( const RenderLevel& rh )
      {
        zIndex = rh.zIndex;
        qDeleteAll( jobs );
        jobs.clear();
        Q_FOREACH ( RenderJob* job, rh.jobs )
        {
          jobs << new RenderJob( *job );
        }
        return *this;
      }

      RenderLevel( const RenderLevel& other )
          : zIndex( other.zIndex )
      {
        Q_FOREACH ( RenderJob* job, other.jobs )
        {
          jobs << new RenderJob( *job );
        }
      }

    };

    // rendering queue: a list of rendering levels
    typedef QList<RenderLevel> RenderQueue;

    class Rule;
    typedef QList<Rule*> RuleList;

    class CORE_EXPORT Rule
    {
      public:
        enum RenderResult
        {
          Filtered = 0, 
          Inactive,     
          Rendered      
        };

        Rule( QgsSymbolV2* symbol, int scaleMinDenom = 0, int scaleMaxDenom = 0, const QString& filterExp = QString(),
              const QString& label = QString(), const QString& description = QString(), bool elseRule = false );
        ~Rule();

        QString dump( int indent = 0 ) const;

        QSet<QString> usedAttributes() const;

        bool needsGeometry() const;

        QgsSymbolV2List symbols( const QgsRenderContext& context = QgsRenderContext() ) const;

        QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = "" ) const;

        QgsLegendSymbolListV2 legendSymbolItemsV2( int currentLevel = -1 ) const;

        bool isFilterOK( QgsFeature& f, QgsRenderContext *context = nullptr ) const;

        bool isScaleOK( double scale ) const;

        QgsSymbolV2* symbol() { return mSymbol; }
        QString label() const { return mLabel; }
        bool dependsOnScale() const { return mScaleMinDenom != 0 || mScaleMaxDenom != 0; }
        int scaleMinDenom() const { return mScaleMinDenom; }
        int scaleMaxDenom() const { return mScaleMaxDenom; }

        QgsExpression* filter() const { return mFilter; }

        QString filterExpression() const { return mFilterExp; }

        QString description() const { return mDescription; }

        Q_DECL_DEPRECATED bool checkState() const { return mIsActive; }

        bool active() const { return mIsActive; }

        QString ruleKey() const { return mRuleKey; }
        void setRuleKey( const QString& key ) { mRuleKey = key; }

        void setSymbol( QgsSymbolV2* sym );
        void setLabel( const QString& label ) { mLabel = label; }

        void setScaleMinDenom( int scaleMinDenom ) { mScaleMinDenom = scaleMinDenom; }

        void setScaleMaxDenom( int scaleMaxDenom ) { mScaleMaxDenom = scaleMaxDenom; }

        void setFilterExpression( const QString& filterExp );

        void setDescription( const QString& description ) { mDescription = description; }

        Q_DECL_DEPRECATED void setCheckState( bool state ) { mIsActive = state; }

        void setActive( bool state ) { mIsActive = state; }

        Rule* clone() const;

        void toSld( QDomDocument& doc, QDomElement &element, const QgsStringMap& props ) const;
        static Rule* createFromSld( QDomElement& element, QGis::GeometryType geomType );

        QDomElement save( QDomDocument& doc, QgsSymbolV2Map& symbolMap ) const;

        Q_DECL_DEPRECATED bool startRender( QgsRenderContext& context, const QgsFields& fields );

        bool startRender( QgsRenderContext& context, const QgsFields& fields, QString& filter );

        QSet<int> collectZLevels();

        void setNormZLevels( const QMap<int, int>& zLevelsToNormLevels );

        RenderResult renderFeature( FeatureToRender& featToRender, QgsRenderContext& context, RenderQueue& renderQueue );

        bool willRenderFeature( QgsFeature& feat, QgsRenderContext* context = nullptr );

        QgsSymbolV2List symbolsForFeature( QgsFeature& feat, QgsRenderContext* context = nullptr );

        QSet< QString > legendKeysForFeature( QgsFeature& feat, QgsRenderContext* context = nullptr );

        RuleList rulesForFeature( QgsFeature& feat, QgsRenderContext* context = nullptr );

        void stopRender( QgsRenderContext& context );

        static Rule* create( QDomElement& ruleElem, QgsSymbolV2Map& symbolMap );

        RuleList& children() { return mChildren; }

        RuleList descendants() const { RuleList l; Q_FOREACH ( Rule *c, mChildren ) { l += c; l += c->descendants(); } return l; }

        Rule* parent() { return mParent; }

        void appendChild( Rule* rule );

        void insertChild( int i, Rule* rule );

        void removeChild( Rule* rule );

        void removeChildAt( int i );

        Rule* takeChild( Rule* rule );

        Rule* takeChildAt( int i );

        Rule* findRuleByKey( const QString& key );

        void updateElseRules();

        void setIsElse( bool iselse );

        bool isElse() { return mElseRule; }

      protected:
        void initFilter();

        Rule* mParent; // parent rule (NULL only for root rule)
        QgsSymbolV2* mSymbol;
        int mScaleMinDenom, mScaleMaxDenom;
        QString mFilterExp, mLabel, mDescription;
        bool mElseRule;
        RuleList mChildren;
        RuleList mElseRules;
        bool mIsActive; // whether it is enabled or not

        QString mRuleKey; // string used for unique identification of rule within renderer

        // temporary
        QgsExpression* mFilter;
        // temporary while rendering
        QSet<int> mSymbolNormZLevels;
        RuleList mActiveChildren;

      private:

        Rule( const Rule& rh );
        Rule& operator=( const Rule& rh );
    };


    static QgsFeatureRendererV2* create( QDomElement& element );

    QgsRuleBasedRendererV2( QgsRuleBasedRendererV2::Rule* root );
    QgsRuleBasedRendererV2( QgsSymbolV2* defaultSymbol );

    ~QgsRuleBasedRendererV2();

    virtual QgsSymbolV2* symbolForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

    virtual bool renderFeature( QgsFeature& feature, QgsRenderContext& context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override;

    virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) override;

    virtual void stopRender( QgsRenderContext& context ) override;

    virtual QString filter( const QgsFields& fields = QgsFields() ) override;

    virtual QList<QString> usedAttributes() override;

    virtual bool filterNeedsGeometry() const override;

    virtual QgsRuleBasedRendererV2* clone() const override;

    virtual void toSld( QDomDocument& doc, QDomElement &element ) const override;
    virtual void toSld( QDomDocument& doc, QDomElement &element, const QgsStringMap& props ) const override;

    static QgsFeatureRendererV2* createFromSld( QDomElement& element, QGis::GeometryType geomType );

    virtual QgsSymbolV2List symbols( QgsRenderContext& context ) override;

    virtual QDomElement save( QDomDocument& doc ) override;

    virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override;

    virtual bool legendSymbolItemsCheckable() const override;

    virtual bool legendSymbolItemChecked( const QString& key ) override;

    virtual void checkLegendSymbolItem( const QString& key, bool state = true ) override;

    virtual void setLegendSymbolItem( const QString& key, QgsSymbolV2* symbol ) override;

    virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = "" ) override;

    virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const override;

    virtual QString dump() const override;

    virtual bool willRenderFeature( QgsFeature& feat, QgsRenderContext& context ) override;

    virtual QgsSymbolV2List symbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;

    virtual QgsSymbolV2List originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;

    virtual QSet<QString> legendKeysForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

    virtual int capabilities() override { return MoreSymbolsPerFeature | Filter | ScaleDependent; }


    Rule* rootRule() { return mRootRule; }


    static void refineRuleCategories( Rule* initialRule, QgsCategorizedSymbolRendererV2* r );
    static void refineRuleRanges( Rule* initialRule, QgsGraduatedSymbolRendererV2* r );
    static void refineRuleScales( Rule* initialRule, QList<int> scales );

    static QgsRuleBasedRendererV2* convertFromRenderer( const QgsFeatureRendererV2 *renderer );

    static void convertToDataDefinedSymbology( QgsSymbolV2* symbol, const QString& sizeScaleField, const QString& rotationField = QString() );

  protected:
    Rule* mRootRule;

    // temporary
    RenderQueue mRenderQueue;
    QList<FeatureToRender> mCurrentFeatures;

    QString mFilter;
};

#endif // QGSRULEBASEDRENDERERV2_H