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

#include <qgsrulebasedrendererv2.h>

Collaboration diagram for QgsRuleBasedRendererV2::Rule:

Public Member Functions
	Rule (QgsSymbolV2 *symbol, int scaleMinDenom=0, int scaleMaxDenom=0, QString filterExp=QString(), QString label=QString(), QString description=QString())
	Constructor takes ownership of the symbol.
	~Rule ()
void	appendChild (Rule *rule)
	add child rule, take ownership, sets this as parent
RuleList &	children ()
Rule *	clone () const
	clone this rule, return new instance
QSet< int >	collectZLevels ()
	get all used z-levels from this rule and children
bool	dependsOnScale () const
RuleList	descendants () const
QString	description () const
QString	dump (int offset=0) const
QgsExpression *	filter () const
QString	filterExpression () const
void	insertChild (int i, Rule *rule)
	add child rule, take ownership, sets this as parent
bool	isFilterOK (QgsFeature &f) const
bool	isScaleOK (double scale) const
QString	label () const
QgsLegendSymbolList	legendSymbolItems ()
Rule *	parent ()
void	removeChild (Rule *rule)
	delete child rule
void	removeChildAt (int i)
	delete child rule
bool	renderFeature (FeatureToRender &featToRender, QgsRenderContext &context, RenderQueue &renderQueue)
RuleList	rulesForFeature (QgsFeature &feat)
	tell which rules will be used to render the feature
QDomElement	save (QDomDocument &doc, QgsSymbolV2Map &symbolMap)
int	scaleMaxDenom () const
int	scaleMinDenom () const
void	setDescription (QString description)
void	setFilterExpression (QString filterExp)
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
void	setScaleMaxDenom (int scaleMaxDenom)
void	setScaleMinDenom (int scaleMinDenom)
void	setSymbol (QgsSymbolV2 *sym)
	set a new symbol (or NULL). Deletes old symbol.
bool	startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
	prepare the rule for rendering and its children (build active children array)
void	stopRender (QgsRenderContext &context)
QgsSymbolV2 *	symbol ()
QgsSymbolV2List	symbols ()
QgsSymbolV2List	symbolsForFeature (QgsFeature &feat)
	tell which symbols will be used to render the feature
void	takeChild (Rule *rule)
	take child rule out, set parent as null
Rule *	takeChildAt (int i)
	take child rule out, set parent as null
void	toSld (QDomDocument &doc, QDomElement &element, QgsStringMap props)
QSet< QString >	usedAttributes ()
bool	willRenderFeature (QgsFeature &feat)
	only tell whether a feature will be rendered without actually rendering it
Static Public Member Functions
static Rule *	create (QDomElement &ruleElem, QgsSymbolV2Map &symbolMap)
static Rule *	createFromSld (QDomElement &element, QGis::GeometryType geomType)
Protected Member Functions
void	initFilter ()
Protected Attributes
RuleList	mActiveChildren
RuleList	mChildren
QString	mDescription
bool	mElseRule
QgsExpression *	mFilter
QString	mFilterExp
QString	mLabel
Rule *	mParent
int	mScaleMaxDenom
int	mScaleMinDenom
QgsSymbolV2 *	mSymbol
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.

Constructor & Destructor Documentation

QgsRuleBasedRendererV2::Rule::Rule	(	QgsSymbolV2 *	symbol,
		int	scaleMinDenom = `0`,
		int	scaleMaxDenom = `0`,
		QString	filterExp = `QString()`,
		QString	label = `QString()`,
		QString	description = `QString()`
	)

Constructor takes ownership of the symbol.

Definition at line 32 of file qgsrulebasedrendererv2.cpp.

References initFilter().

QgsRuleBasedRendererV2::Rule::~Rule ( )

Definition at line 41 of file qgsrulebasedrendererv2.cpp.

Member Function Documentation

void QgsRuleBasedRendererV2::Rule::appendChild ( Rule * rule ) [inline]

add child rule, take ownership, sets this as parent

Definition at line 155 of file qgsrulebasedrendererv2.h.

References mParent.

Referenced by clone(), create(), QgsRuleBasedRendererV2::createFromSld(), QgsRuleBasedRendererV2::QgsRuleBasedRendererV2(), QgsRuleBasedRendererV2::refineRuleCategories(), QgsRuleBasedRendererV2::refineRuleRanges(), QgsRuleBasedRendererV2::refineRuleScales(), and save().

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

Definition at line 150 of file qgsrulebasedrendererv2.h.

Referenced by descendants(), QgsRuleBasedRendererV2Model::index(), QgsRuleBasedRendererV2Model::parent(), QgsRuleBasedRendererV2Model::removeRows(), QgsRuleBasedRendererV2Model::rowCount(), and QgsRuleBasedRendererV2Widget::selectedSymbols().

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

clone this rule, return new instance

Definition at line 155 of file qgsrulebasedrendererv2.cpp.

References appendChild(), QgsSymbolV2::clone(), and clone().

Referenced by clone(), and QgsRuleBasedRendererV2::clone().

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

get all used z-levels from this rule and children

Definition at line 315 of file qgsrulebasedrendererv2.cpp.

References collectZLevels().

Referenced by collectZLevels(), and QgsRuleBasedRendererV2::startRender().

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::create	(	QDomElement &	ruleElem,
		QgsSymbolV2Map &	symbolMap
	)		`[static]`

Definition at line 451 of file qgsrulebasedrendererv2.cpp.

References appendChild(), QgsRuleBasedRendererV2::create(), and QgsDebugMsg.

Referenced by QgsRuleBasedRendererV2::create(), and QgsRuleBasedRendererV2Model::dropMimeData().

QgsRuleBasedRendererV2::Rule * QgsRuleBasedRendererV2::Rule::createFromSld	(	QDomElement &	element,
		QGis::GeometryType	geomType
	)		`[static]`

Definition at line 492 of file qgsrulebasedrendererv2.cpp.

References QgsSymbolLayerV2Utils::createSymbolLayerV2ListFromSld(), QgsExpression::dump(), QgsOgcUtils::expressionFromOgcFilter(), QgsExpression::hasParserError(), QGis::Line, QgsExpression::parserErrorString(), QGis::Point, QGis::Polygon, and QgsDebugMsg.

Referenced by QgsRuleBasedRendererV2::createFromSld().

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

Definition at line 102 of file qgsrulebasedrendererv2.h.

Referenced by QgsRuleBasedRendererV2Model::data(), and QgsRendererRulePropsDialog::QgsRendererRulePropsDialog().

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

Definition at line 151 of file qgsrulebasedrendererv2.h.

References children().

Referenced by QgsRuleBasedRendererV2Widget::countFeatures().

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

Definition at line 107 of file qgsrulebasedrendererv2.h.

Referenced by QgsRendererRulePropsDialog::QgsRendererRulePropsDialog().

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

Definition at line 62 of file qgsrulebasedrendererv2.cpp.

References dump().

Referenced by dump(), QgsRuleBasedRendererV2::dump(), QgsRuleBasedRendererV2Model::insertRule(), and QgsRuleBasedRendererV2Model::removeRows().

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

Definition at line 105 of file qgsrulebasedrendererv2.h.

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

Definition at line 106 of file qgsrulebasedrendererv2.h.

Referenced by QgsRuleBasedRendererV2Model::data(), and QgsRendererRulePropsDialog::QgsRendererRulePropsDialog().

void QgsRuleBasedRendererV2::Rule::initFilter ( ) [protected]

Definition at line 49 of file qgsrulebasedrendererv2.cpp.

Referenced by Rule().

void QgsRuleBasedRendererV2::Rule::insertChild	(	int	i,
		Rule *	rule
	)		`[inline]`

add child rule, take ownership, sets this as parent

Definition at line 157 of file qgsrulebasedrendererv2.h.

References mParent.

Referenced by QgsRuleBasedRendererV2Model::insertRule().

bool QgsRuleBasedRendererV2::Rule::isFilterOK ( QgsFeature & f ) const

Definition at line 133 of file qgsrulebasedrendererv2.cpp.

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

Definition at line 142 of file qgsrulebasedrendererv2.cpp.

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

Definition at line 101 of file qgsrulebasedrendererv2.h.

Referenced by QgsRuleBasedRendererV2Widget::countFeatures(), QgsRuleBasedRendererV2Model::data(), QgsRendererRulePropsDialog::QgsRendererRulePropsDialog(), and QgsRuleBasedRendererV2Widget::refineRuleScalesGui().

QgsLegendSymbolList QgsRuleBasedRendererV2::Rule::legendSymbolItems ( )

Note:: not available in python bindings

Definition at line 118 of file qgsrulebasedrendererv2.cpp.

References legendSymbolItems().

Referenced by legendSymbolItems(), and QgsRuleBasedRendererV2::legendSymbolItems().

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

Definition at line 152 of file qgsrulebasedrendererv2.h.

Referenced by QgsRuleBasedRendererV2Model::parent().

void QgsRuleBasedRendererV2::Rule::removeChild ( Rule * rule ) [inline]

delete child rule

Definition at line 159 of file qgsrulebasedrendererv2.h.

void QgsRuleBasedRendererV2::Rule::removeChildAt ( int i ) [inline]

delete child rule

Definition at line 161 of file qgsrulebasedrendererv2.h.

Referenced by QgsRuleBasedRendererV2Model::removeRows().

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