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

#include <qgsrulebasedrendererv2.h>

Public Types
enum	RenderResult { Filtered = 0, Inactive, Rendered }
	The result of rendering a rule. More...

Public Member Functions
	Rule (QgsSymbolV2 *symbol, int scaleMinDenom=0, int scaleMaxDenom=0, const QString &filterExp=QString(), const QString &label=QString(), const 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

RuleList &	children ()
	Return all children rules of this rule. More...

Rule *	clone () 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
	Returns all children, grand-children, grand-grand-children, grand-gra... More...

QString	description () const
	A human readable description for this rule. More...

QString	dump (int indent=0) const
	Dump for debug purpose. More...

QgsExpression *	filter () const
	A filter that will check if this rule applies. More...

QString	filterExpression () const
	A filter that will check if this rule applies. More...

Rule *	findRuleByKey (const 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 ()
	Check if this rule is an ELSE rule. More...

bool	isFilterOK (QgsFeature &f, QgsRenderContext *context=0) const
	Check if a given feature shall be rendered by this rule. More...

bool	isScaleOK (double scale) const
	Check if this rule applies for a given scale. More...

QString	label () const

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

QgsLegendSymbolListV2	legendSymbolItemsV2 (int currentLevel=-1) const

Rule *	parent ()
	The parent rule. More...

void	removeChild (Rule *rule)
	delete child rule More...

void	removeChildAt (int i)
	delete child rule More...

RenderResult	renderFeature (FeatureToRender &featToRender, QgsRenderContext &context, RenderQueue &renderQueue)
	Render a given feature, will recursively call subclasses and only render if the constraints apply. More...

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 (const QString &description)
	Set a human readable description for this rule. More...

void	setFilterExpression (const QString &filterExp)
	Set the expression used to check if a given feature shall be rendered with this rule. More...

void	setIsElse (bool iselse)
	Sets if this rule is an ELSE rule. More...

void	setLabel (const 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)
	Set the maximum denominator for which this rule shall apply. More...

void	setScaleMinDenom (int scaleMinDenom)
	Set the minimum denominator for which this rule shall apply. More...

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)
	Stop a rendering process. More...

QgsSymbolV2 *	symbol ()

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...

Rule *	takeChildAt (int i)
	take child rule out, set parent as null More...

void	toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props)

void	updateElseRules ()
	Check which child rules are else rules and update the internal list of else rules. More...

QSet< QString >	usedAttributes ()
	Return the attributes used to evaluate the expression of this rule. More...

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 Rule *	create (QDomElement &ruleElem, QgsSymbolV2Map &symbolMap)
	Create a rule from an XML definition. More...

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

Protected Member Functions
void	initFilter ()

Protected Attributes
RuleList	mActiveChildren

RuleList	mChildren

QString	mDescription

bool	mElseRule

RuleList	mElseRules

QgsExpression *	mFilter

QString	mFilterExp

bool	mIsActive

QString	mLabel

Rule *	mParent

QString	mRuleKey

int	mScaleMaxDenom

int	mScaleMinDenom

QgsSymbolV2 *	mSymbol

QSet< 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

enum QgsRuleBasedRendererV2::Rule::RenderResult

The result of rendering a rule.

Enumerator
Filtered	The rule does not apply.
Inactive	The rule is inactive.
Rendered	Something was rendered.

Definition at line 88 of file qgsrulebasedrendererv2.h.

Constructor & Destructor Documentation

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

Constructor takes ownership of the symbol.

Definition at line 38 of file qgsrulebasedrendererv2.cpp.

QgsRuleBasedRendererV2::Rule::~Rule ( )

Definition at line 50 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 171 of file qgsrulebasedrendererv2.h.

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

add child rule, take ownership, sets this as parent

Definition at line 76 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::checkState ( ) const

inline

Note: added in 2.6

Deprecated:: use active instead

Definition at line 165 of file qgsrulebasedrendererv2.h.

RuleList& QgsRuleBasedRendererV2::Rule::children ( )

inline

Return all children rules of this rule.

Returns: A list of rules

Definition at line 287 of file qgsrulebasedrendererv2.h.

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

clone this rule, return new instance

Definition at line 260 of file qgsrulebasedrendererv2.cpp.

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

get all used z-levels from this rule and children

Definition at line 465 of file qgsrulebasedrendererv2.cpp.

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

static

Create a rule from an XML definition.

Parameters

ruleElem	The XML rule element
symbolMap	Symbol map

Returns: A new rule

Definition at line 623 of file qgsrulebasedrendererv2.cpp.

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

static

Definition at line 670 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::dependsOnScale ( ) const

inline

Definition at line 140 of file qgsrulebasedrendererv2.h.

RuleList QgsRuleBasedRendererV2::Rule::descendants ( ) const

inline

Returns all children, grand-children, grand-grand-children, grand-gra...

you get it

Returns: A list of descendant rules

Definition at line 294 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::description ( ) const

inline

A human readable description for this rule.

Returns: Description

Definition at line 161 of file qgsrulebasedrendererv2.h.

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

Dump for debug purpose.

Parameters

indent How many characters to indent. Will increase by two with every of the recursive calls

Returns: A string representing this rule

Definition at line 147 of file qgsrulebasedrendererv2.cpp.

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

inline

A filter that will check if this rule applies.

Returns: An expression

Definition at line 148 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::filterExpression ( ) const

inline

A filter that will check if this rule applies.

Returns: An expression

Definition at line 154 of file qgsrulebasedrendererv2.h.

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

Try to find a rule given its unique key.

Note: added in 2.6

Definition at line 120 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::initFilter ( )

protected

Definition at line 58 of file qgsrulebasedrendererv2.cpp.

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

add child rule, take ownership, sets this as parent

Definition at line 83 of file qgsrulebasedrendererv2.cpp.

bool QgsRuleBasedRendererV2::Rule::isElse ( )

inline

Check if this rule is an ELSE rule.

Returns: True if this rule is an else rule

Definition at line 344 of file qgsrulebasedrendererv2.h.

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

Check if a given feature shall be rendered by this rule.

Parameters

f	The feature to test
context	The context in which the rendering happens

Returns: True if the feature shall be rendered

Definition at line 237 of file qgsrulebasedrendererv2.cpp.

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

Check if this rule applies for a given scale.

Parameters

scale The scale to check. If set to 0, it will always return true.

Returns: If the rule will be evaluated at this scale

Definition at line 247 of file qgsrulebasedrendererv2.cpp.

QString QgsRuleBasedRendererV2::Rule::label ( ) const

inline

Definition at line 139 of file qgsrulebasedrendererv2.h.

QgsLegendSymbolList QgsRuleBasedRendererV2::Rule::legendSymbolItems	(	double	scaleDenominator = `-1`,
		const QString &	rule = `""`
	)

Note: not available in python bindings

Definition at line 203 of file qgsrulebasedrendererv2.cpp.

QgsLegendSymbolListV2 QgsRuleBasedRendererV2::Rule::legendSymbolItemsV2 ( int currentLevel = -1 ) const

Note: added in 2.6

Definition at line 220 of file qgsrulebasedrendererv2.cpp.

Rule* QgsRuleBasedRendererV2::Rule::parent ( )

inline

The parent rule.

Returns: Parent rule

Definition at line 301 of file qgsrulebasedrendererv2.h.

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

delete child rule

Definition at line 90 of file qgsrulebasedrendererv2.cpp.

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

delete child rule

Definition at line 97 of file qgsrulebasedrendererv2.cpp.

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

Render a given feature, will recursively call subclasses and only render if the constraints apply.

Parameters

featToRender	The feature to render
context	The rendering context
renderQueue	The rendering queue to which the feature should be added

Returns: The result of the rendering. In explicit if the feature is added to the queue or the reason for not rendering the feature.

Definition at line 509 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 175 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 591 of file qgsrulebasedrendererv2.cpp.

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

Definition at line 271 of file qgsrulebasedrendererv2.cpp.

int QgsRuleBasedRendererV2::Rule::scaleMaxDenom ( ) const

inline

Definition at line 142 of file qgsrulebasedrendererv2.h.

int QgsRuleBasedRendererV2::Rule::scaleMinDenom ( ) const

inline

Definition at line 141 of file qgsrulebasedrendererv2.h.

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

inline

Sets if this rule is active.

Parameters

state Determines if the rule should be activated or deactivated

Definition at line 222 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setCheckState ( bool state )

inline

Note: added in 2.6

Deprecated:: use setActive instead

Definition at line 216 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setDescription ( const QString & description )

inline

Set a human readable description for this rule.

Parameters

description Description

Definition at line 212 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setFilterExpression ( const QString & filterExp )

inline

Set the expression used to check if a given feature shall be rendered with this rule.

Parameters

filterExp An expression

Definition at line 205 of file qgsrulebasedrendererv2.h.

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

inline

Sets if this rule is an ELSE rule.

Parameters

iselse If true, this rule is an ELSE rule

Definition at line 337 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::setLabel ( const QString & label )

inline

Definition at line 182 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 489 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 178 of file qgsrulebasedrendererv2.h.

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

inline

Set the maximum denominator for which this rule shall apply.

E.g. 100'000 if it shall be evaluated between 1:1000 and 1:100'000 Set to 0 to disable the maximum check

Parameters

scaleMaxDenom maximum scale denominator for this rule

Definition at line 198 of file qgsrulebasedrendererv2.h.

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

inline

Set the minimum denominator for which this rule shall apply.

E.g. 1000 if it shall be evaluated between 1:1000 and 1:100'000 Set to 0 to disable the minimum check

Parameters

scaleMinDenom The minimum scale denominator for this rule

Definition at line 190 of file qgsrulebasedrendererv2.h.

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

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

Definition at line 197 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 395 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 401 of file qgsrulebasedrendererv2.cpp.

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

Stop a rendering process.

Used to clean up the internal state of this rule

Parameters

context The rendering context

Definition at line 608 of file qgsrulebasedrendererv2.cpp.

QgsSymbolV2* QgsRuleBasedRendererV2::Rule::symbol ( )

inline

Definition at line 138 of file qgsrulebasedrendererv2.h.

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

Definition at line 183 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 575 of file qgsrulebasedrendererv2.cpp.

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

take child rule out, set parent as null

Definition at line 105 of file qgsrulebasedrendererv2.cpp.

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

take child rule out, set parent as null

Definition at line 112 of file qgsrulebasedrendererv2.cpp.

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

Definition at line 303 of file qgsrulebasedrendererv2.cpp.

void QgsRuleBasedRendererV2::Rule::updateElseRules ( )

Check which child rules are else rules and update the internal list of else rules.

TODO QGIS 3: Does this need to be public?

Definition at line 136 of file qgsrulebasedrendererv2.cpp.

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

Return the attributes used to evaluate the expression of this rule.

Returns: A set of attribute names

Definition at line 165 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 559 of file qgsrulebasedrendererv2.cpp.

Member Data Documentation

RuleList QgsRuleBasedRendererV2::Rule::mActiveChildren

protected

Definition at line 364 of file qgsrulebasedrendererv2.h.

RuleList QgsRuleBasedRendererV2::Rule::mChildren

protected

Definition at line 354 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mDescription

protected

Definition at line 352 of file qgsrulebasedrendererv2.h.

bool QgsRuleBasedRendererV2::Rule::mElseRule

protected

Definition at line 353 of file qgsrulebasedrendererv2.h.

RuleList QgsRuleBasedRendererV2::Rule::mElseRules

protected

Definition at line 355 of file qgsrulebasedrendererv2.h.

QgsExpression* QgsRuleBasedRendererV2::Rule::mFilter

protected

Definition at line 361 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mFilterExp

protected

Definition at line 352 of file qgsrulebasedrendererv2.h.

bool QgsRuleBasedRendererV2::Rule::mIsActive

protected

Definition at line 356 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mLabel

protected

Definition at line 352 of file qgsrulebasedrendererv2.h.

Rule* QgsRuleBasedRendererV2::Rule::mParent

protected

Definition at line 349 of file qgsrulebasedrendererv2.h.

QString QgsRuleBasedRendererV2::Rule::mRuleKey

protected

Definition at line 358 of file qgsrulebasedrendererv2.h.

int QgsRuleBasedRendererV2::Rule::mScaleMaxDenom

protected

Definition at line 351 of file qgsrulebasedrendererv2.h.

int QgsRuleBasedRendererV2::Rule::mScaleMinDenom

protected

Definition at line 351 of file qgsrulebasedrendererv2.h.

QgsSymbolV2* QgsRuleBasedRendererV2::Rule::mSymbol

protected

Definition at line 350 of file qgsrulebasedrendererv2.h.

QSet<int> QgsRuleBasedRendererV2::Rule::mSymbolNormZLevels

protected

Definition at line 363 of file qgsrulebasedrendererv2.h.

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

/tmp/buildd/qgis-2.12.0+99unstable/src/core/symbology-ng/qgsrulebasedrendererv2.h
/tmp/buildd/qgis-2.12.0+99unstable/src/core/symbology-ng/qgsrulebasedrendererv2.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation