QGIS API Documentation  2.11.0-Master
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRuleBasedRendererV2::Rule Class Reference

This class keeps data about a rules for rule-based renderer. More...

#include <qgsrulebasedrendererv2.h>

Public Types

enum  RenderResult { Filtered = 0, Inactive, Rendered }
 

Public Member Functions

 Rule (QgsSymbolV2 *symbol, int scaleMinDenom=0, int scaleMaxDenom=0, QString filterExp=QString(), QString label=QString(), QString description=QString(), bool elseRule=false)
 Constructor takes ownership of the symbol. More...
 
 ~Rule ()
 
bool active () const
 Returns if this rule is active. More...
 
void appendChild (Rule *rule)
 add child rule, take ownership, sets this as parent More...
 
bool checkState () const
 
RuleListchildren ()
 
Ruleclone () const
 clone this rule, return new instance More...
 
QSet< int > collectZLevels ()
 get all used z-levels from this rule and children More...
 
bool dependsOnScale () const
 
RuleList descendants () const
 
QString description () const
 
QString dump (int offset=0) const
 
QgsExpressionfilter () const
 
QString filterExpression () const
 
RulefindRuleByKey (QString key)
 Try to find a rule given its unique key. More...
 
void insertChild (int i, Rule *rule)
 add child rule, take ownership, sets this as parent More...
 
bool isElse ()
 
bool isFilterOK (QgsFeature &f, QgsRenderContext *context=0) const
 
bool isScaleOK (double scale) const
 
QString label () const
 
QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, QString rule="")
 
QgsLegendSymbolListV2 legendSymbolItemsV2 (int currentLevel=-1) const
 
Ruleparent ()
 
void removeChild (Rule *rule)
 delete child rule More...
 
void removeChildAt (int i)
 delete child rule More...
 
RenderResult renderFeature (FeatureToRender &featToRender, QgsRenderContext &context, RenderQueue &renderQueue)
 
QString ruleKey () const
 Unique rule identifier (for identification of rule within renderer) More...
 
RuleList rulesForFeature (QgsFeature &feat, QgsRenderContext *context=0)
 tell which rules will be used to render the feature More...
 
QDomElement save (QDomDocument &doc, QgsSymbolV2Map &symbolMap)
 
int scaleMaxDenom () const
 
int scaleMinDenom () const
 
void setActive (bool state)
 Sets if this rule is active. More...
 
void setCheckState (bool state)
 
void setDescription (QString description)
 
void setFilterExpression (QString filterExp)
 
void setIsElse (bool iselse)
 
void setLabel (QString label)
 
void setNormZLevels (const QMap< int, int > &zLevelsToNormLevels)
 assign normalized z-levels [0..N-1] for this rule's symbol for quick access during rendering More...
 
void setRuleKey (const QString &key)
 Override the assigned rule key (should be used just internally by rule-based renderer) More...
 
void setScaleMaxDenom (int scaleMaxDenom)
 
void setScaleMinDenom (int scaleMinDenom)
 
void setSymbol (QgsSymbolV2 *sym)
 set a new symbol (or NULL). Deletes old symbol. More...
 
Q_DECL_DEPRECATED bool startRender (QgsRenderContext &context, const QgsFields &fields)
 prepare the rule for rendering and its children (build active children array) More...
 
bool startRender (QgsRenderContext &context, const QgsFields &fields, QString &filter)
 prepare the rule for rendering and its children (build active children array) More...
 
void stopRender (QgsRenderContext &context)
 
QgsSymbolV2symbol ()
 
QgsSymbolV2List symbols (const QgsRenderContext &context=QgsRenderContext())
 
QgsSymbolV2List symbolsForFeature (QgsFeature &feat, QgsRenderContext *context=0)
 tell which symbols will be used to render the feature More...
 
void takeChild (Rule *rule)
 take child rule out, set parent as null More...
 
RuletakeChildAt (int i)
 take child rule out, set parent as null More...
 
void toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props)
 
void updateElseRules ()
 
QSet< QStringusedAttributes ()
 
bool willRenderFeature (QgsFeature &feat, QgsRenderContext *context=0)
 only tell whether a feature will be rendered without actually rendering it More...
 

Static Public Member Functions

static Rulecreate (QDomElement &ruleElem, QgsSymbolV2Map &symbolMap)
 
static RulecreateFromSld (QDomElement &element, QGis::GeometryType geomType)
 

Protected Member Functions

void initFilter ()
 

Protected Attributes

RuleList mActiveChildren
 
RuleList mChildren
 
QString mDescription
 
bool mElseRule
 
RuleList mElseRules
 
QgsExpressionmFilter
 
QString mFilterExp
 
bool mIsActive
 
QString mLabel
 
RulemParent
 
QString mRuleKey
 
int mScaleMaxDenom
 
int mScaleMinDenom
 
QgsSymbolV2mSymbol
 
QList< int > mSymbolNormZLevels
 

Detailed Description

This class keeps data about a rules for rule-based renderer.

A rule consists of a symbol, filter expression and range of scales. If filter is empty, it matches all features. If scale range has both values zero, it matches all scales. If one of the min/max scale denominators is zero, there is no lower/upper bound for scales. A rule matches if both filter and scale range match.

Definition at line 84 of file qgsrulebasedrendererv2.h.

Member Enumeration Documentation

Enumerator
Filtered 

The rule does not apply.

Inactive 

The rule is inactive.

Rendered 

Something was rendered.

Definition at line 87 of file qgsrulebasedrendererv2.h.

Constructor & Destructor Documentation

QgsRuleBasedRendererV2::Rule::Rule ( QgsSymbolV2 symbol,
int  scaleMinDenom = 0,
int  scaleMaxDenom = 0,
QString  filterExp = QString(),
QString  label = QString(),
QString  description = QString(),
bool  elseRule = false 
)

Constructor takes ownership of the symbol.

Definition at line 37 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule::~Rule ( )

Definition at line 49 of file qgsrulebasedrendererv2.cpp.

Member Function Documentation

bool QgsRuleBasedRendererV2::Rule::active ( ) const
inline

Returns if this rule is active.

Returns
True if the rule is active

Definition at line 124 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::appendChild ( Rule rule)

add child rule, take ownership, sets this as parent

Definition at line 75 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::checkState ( ) const
inline
Note
added in 2.6
Deprecated:
use active instead

Definition at line 118 of file qgsrulebasedrendererv2.h.

RuleList& QgsRuleBasedRendererV2::Rule::children ( )
inline

Definition at line 182 of file qgsrulebasedrendererv2.h.

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::clone ( ) const

clone this rule, return new instance

Definition at line 259 of file qgsrulebasedrendererv2.cpp.

QSet< int > QgsRuleBasedRendererV2::Rule::collectZLevels ( )

get all used z-levels from this rule and children

Definition at line 464 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::create ( QDomElement ruleElem,
QgsSymbolV2Map symbolMap 
)
static

Definition at line 621 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::createFromSld ( QDomElement element,
QGis::GeometryType  geomType 
)
static

Definition at line 668 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::dependsOnScale ( ) const
inline

Definition at line 110 of file qgsrulebasedrendererv2.h.

RuleList QgsRuleBasedRendererV2::Rule::descendants ( ) const
inline

Definition at line 183 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::description ( ) const
inline

Definition at line 115 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::dump ( int  offset = 0) const

Definition at line 146 of file qgsrulebasedrendererv2.cpp.

QgsExpression* QgsRuleBasedRendererV2::Rule::filter ( ) const
inline

Definition at line 113 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::filterExpression ( ) const
inline

Definition at line 114 of file qgsrulebasedrendererv2.h.

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::findRuleByKey ( QString  key)

Try to find a rule given its unique key.

Note
added in 2.6

Definition at line 119 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::initFilter ( )
protected

Definition at line 57 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::insertChild ( int  i,
Rule rule 
)

add child rule, take ownership, sets this as parent

Definition at line 82 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::isElse ( )
inline

Definition at line 206 of file qgsrulebasedrendererv2.h.

bool QgsRuleBasedRendererV2::Rule::isFilterOK ( QgsFeature f,
QgsRenderContext context = 0 
) const

Definition at line 236 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::isScaleOK ( double  scale) const

Definition at line 246 of file qgsrulebasedrendererv2.cpp.

QString QgsRuleBasedRendererV2::Rule::label ( ) const
inline

Definition at line 109 of file qgsrulebasedrendererv2.h.

QgsLegendSymbolList QgsRuleBasedRendererV2::Rule::legendSymbolItems ( double  scaleDenominator = -1,
QString  rule = "" 
)
Note
not available in python bindings

Definition at line 202 of file qgsrulebasedrendererv2.cpp.

QgsLegendSymbolListV2 QgsRuleBasedRendererV2::Rule::legendSymbolItemsV2 ( int  currentLevel = -1) const
Note
added in 2.6

Definition at line 219 of file qgsrulebasedrendererv2.cpp.

Rule* QgsRuleBasedRendererV2::Rule::parent ( )
inline

Definition at line 184 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::removeChild ( Rule rule)

delete child rule

Definition at line 89 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::removeChildAt ( int  i)

delete child rule

Definition at line 96 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule::RenderResult QgsRuleBasedRendererV2::Rule::renderFeature ( QgsRuleBasedRendererV2::FeatureToRender featToRender,
QgsRenderContext context,
QgsRuleBasedRendererV2::RenderQueue renderQueue 
)

Definition at line 508 of file qgsrulebasedrendererv2.cpp.

QString QgsRuleBasedRendererV2::Rule::ruleKey ( ) const
inline

Unique rule identifier (for identification of rule within renderer)

Note
added in 2.6

Definition at line 128 of file qgsrulebasedrendererv2.h.

QgsRuleBasedRendererV2::RuleList QgsRuleBasedRendererV2::Rule::rulesForFeature ( QgsFeature feat,
QgsRenderContext context = 0 
)

tell which rules will be used to render the feature

Definition at line 589 of file qgsrulebasedrendererv2.cpp.

QDomElement QgsRuleBasedRendererV2::Rule::save ( QDomDocument doc,
QgsSymbolV2Map symbolMap 
)

Definition at line 270 of file qgsrulebasedrendererv2.cpp.

int QgsRuleBasedRendererV2::Rule::scaleMaxDenom ( ) const
inline

Definition at line 112 of file qgsrulebasedrendererv2.h.

int QgsRuleBasedRendererV2::Rule::scaleMinDenom ( ) const
inline

Definition at line 111 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setActive ( bool  state)
inline

Sets if this rule is active.

Parameters
stateDetermines if the rule should be activated or deactivated

Definition at line 147 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setCheckState ( bool  state)
inline
Note
added in 2.6
Deprecated:
use setActive instead

Definition at line 142 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setDescription ( QString  description)
inline

Definition at line 139 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setFilterExpression ( QString  filterExp)
inline

Definition at line 138 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setIsElse ( bool  iselse)
inline

Definition at line 205 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setLabel ( QString  label)
inline

Definition at line 135 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setNormZLevels ( const QMap< int, int > &  zLevelsToNormLevels)

assign normalized z-levels [0..N-1] for this rule's symbol for quick access during rendering

Note
not available in python bindings

Definition at line 488 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::setRuleKey ( const QString key)
inline

Override the assigned rule key (should be used just internally by rule-based renderer)

Note
added in 2.6

Definition at line 131 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setScaleMaxDenom ( int  scaleMaxDenom)
inline

Definition at line 137 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setScaleMinDenom ( int  scaleMinDenom)
inline

Definition at line 136 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setSymbol ( QgsSymbolV2 sym)

set a new symbol (or NULL). Deletes old symbol.

Definition at line 196 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::startRender ( QgsRenderContext context,
const QgsFields fields 
)

prepare the rule for rendering and its children (build active children array)

Definition at line 394 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::startRender ( QgsRenderContext context,
const QgsFields fields,
QString filter 
)

prepare the rule for rendering and its children (build active children array)

Definition at line 400 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::stopRender ( QgsRenderContext context)

Definition at line 606 of file qgsrulebasedrendererv2.cpp.

QgsSymbolV2* QgsRuleBasedRendererV2::Rule::symbol ( )
inline

Definition at line 108 of file qgsrulebasedrendererv2.h.

QgsSymbolV2List QgsRuleBasedRendererV2::Rule::symbols ( const QgsRenderContext context = QgsRenderContext())

Definition at line 182 of file qgsrulebasedrendererv2.cpp.

QgsSymbolV2List QgsRuleBasedRendererV2::Rule::symbolsForFeature ( QgsFeature feat,
QgsRenderContext context = 0 
)

tell which symbols will be used to render the feature

Definition at line 573 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::takeChild ( Rule rule)

take child rule out, set parent as null

Definition at line 104 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::takeChildAt ( int  i)

take child rule out, set parent as null

Definition at line 111 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::toSld ( QDomDocument doc,
QDomElement element,
QgsStringMap  props 
)

Definition at line 302 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::updateElseRules ( )

Definition at line 135 of file qgsrulebasedrendererv2.cpp.

QSet< QString > QgsRuleBasedRendererV2::Rule::usedAttributes ( )

Definition at line 164 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::willRenderFeature ( QgsFeature feat,
QgsRenderContext context = 0 
)

only tell whether a feature will be rendered without actually rendering it

Definition at line 557 of file qgsrulebasedrendererv2.cpp.

Member Data Documentation

RuleList QgsRuleBasedRendererV2::Rule::mActiveChildren
protected

Definition at line 226 of file qgsrulebasedrendererv2.h.

RuleList QgsRuleBasedRendererV2::Rule::mChildren
protected

Definition at line 216 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mDescription
protected

Definition at line 214 of file qgsrulebasedrendererv2.h.

bool QgsRuleBasedRendererV2::Rule::mElseRule
protected

Definition at line 215 of file qgsrulebasedrendererv2.h.

RuleList QgsRuleBasedRendererV2::Rule::mElseRules
protected

Definition at line 217 of file qgsrulebasedrendererv2.h.

QgsExpression* QgsRuleBasedRendererV2::Rule::mFilter
protected

Definition at line 223 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mFilterExp
protected

Definition at line 214 of file qgsrulebasedrendererv2.h.

bool QgsRuleBasedRendererV2::Rule::mIsActive
protected

Definition at line 218 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mLabel
protected

Definition at line 214 of file qgsrulebasedrendererv2.h.

Rule* QgsRuleBasedRendererV2::Rule::mParent
protected

Definition at line 211 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mRuleKey
protected

Definition at line 220 of file qgsrulebasedrendererv2.h.

int QgsRuleBasedRendererV2::Rule::mScaleMaxDenom
protected

Definition at line 213 of file qgsrulebasedrendererv2.h.

int QgsRuleBasedRendererV2::Rule::mScaleMinDenom
protected

Definition at line 213 of file qgsrulebasedrendererv2.h.

QgsSymbolV2* QgsRuleBasedRendererV2::Rule::mSymbol
protected

Definition at line 212 of file qgsrulebasedrendererv2.h.

QList<int> QgsRuleBasedRendererV2::Rule::mSymbolNormZLevels
protected

Definition at line 225 of file qgsrulebasedrendererv2.h.


The documentation for this class was generated from the following files: