QgsMapHitTest Class Reference

Class that runs a hit test with given map settings. More...

#include <qgsmaphittest.h>

Public Types
typedef QMap< QString, QString >	LayerFilterExpression
	Maps an expression string to a layer id. More...

Public Member Functions
	QgsMapHitTest (const QgsMapSettings &settings, const QgsGeometry &polygon=QgsGeometry(), const LayerFilterExpression &layerFilterExpression=LayerFilterExpression())
	QgsMapHitTest (const QgsMapSettings &settings, const LayerFilterExpression &layerFilterExpression)
	Constructor version used with only expressions to filter symbols (no extent or polygon intersection) More...
bool	legendKeyVisible (const QString &ruleKey, QgsVectorLayer *layer) const
	Tests whether a given legend key is visible for a specified layer. More...
void	run ()
	Runs the map hit test. More...
bool	symbolVisible (QgsSymbolV2 *symbol, QgsVectorLayer *layer) const
	Tests whether a symbol is visible for a specified layer. More...

Protected Types
typedef QMap< QgsVectorLayer *, SymbolV2Set >	HitTest
typedef QSet< QString >	SymbolV2Set

Protected Member Functions
void	runHitTestLayer (QgsVectorLayer *vl, SymbolV2Set &usedSymbols, SymbolV2Set &usedSymbolsRuleKey, QgsRenderContext &context)
	Runs test for visible symbols within a layer. More...

Protected Attributes
HitTest	mHitTest
	The hit test. More...
HitTest	mHitTestRuleKey
	The hit test, using legend rule keys. More...
LayerFilterExpression	mLayerFilterExpression
	List of expression filter for each layer. More...
bool	mOnlyExpressions
	Whether to use only expressions during the filtering. More...
QgsGeometry	mPolygon
	Polygon used for filtering items. May be empty. More...
QgsMapSettings	mSettings
	The initial map settings. More...

Detailed Description

Class that runs a hit test with given map settings.

Based on the hit test it returns which symbols will be visible on the map - this is useful for content based legend.

Note

added in 2.6

Definition at line 34 of file qgsmaphittest.h.

Member Typedef Documentation

HitTest

typedef QMap<QgsVectorLayer*, SymbolV2Set> QgsMapHitTest::HitTest

protected

Note

not available in Python bindings

Definition at line 73 of file qgsmaphittest.h.

LayerFilterExpression

typedef QMap<QString, QString> QgsMapHitTest::LayerFilterExpression

Maps an expression string to a layer id.

Definition at line 38 of file qgsmaphittest.h.

SymbolV2Set

typedef QSet<QString> QgsMapHitTest::SymbolV2Set

protected

Note

not available in Python bindings

Definition at line 70 of file qgsmaphittest.h.

Constructor & Destructor Documentation

QgsMapHitTest() [1/2]

QgsMapHitTest::QgsMapHitTest	(	const QgsMapSettings &	settings,
		const QgsGeometry &	polygon = QgsGeometry(),
		const LayerFilterExpression &	layerFilterExpression = LayerFilterExpression()
	)

Parameters

settings	Map settings used to evaluate symbols
polygon	Polygon geometry to refine the hit test
layerFilterExpression	Expression string for each layer id to evaluate in order to refine the symbol selection

Definition at line 29 of file qgsmaphittest.cpp.

QgsMapHitTest() [2/2]

QgsMapHitTest::QgsMapHitTest	(	const QgsMapSettings &	settings,
		const LayerFilterExpression &	layerFilterExpression
	)

Constructor version used with only expressions to filter symbols (no extent or polygon intersection)

Definition at line 40 of file qgsmaphittest.cpp.

Member Function Documentation

legendKeyVisible()

bool QgsMapHitTest::legendKeyVisible	(	const QString &	ruleKey,
		QgsVectorLayer *	layer
	)		const

Tests whether a given legend key is visible for a specified layer.

Parameters

ruleKey	legend rule key
layer	vector layer

Note

added in QGIS 2.14

See also

symbolVisible()

Definition at line 97 of file qgsmaphittest.cpp.

run()

void QgsMapHitTest::run

(

)

Runs the map hit test.

Definition at line 47 of file qgsmaphittest.cpp.

runHitTestLayer()

void QgsMapHitTest::runHitTestLayer ( QgsVectorLayer *  vl, SymbolV2Set &  usedSymbols, SymbolV2Set &  usedSymbolsRuleKey, QgsRenderContext &  context  )

protected

Runs test for visible symbols within a layer.

Parameters

vl	vector layer
usedSymbols	set for storage of visible symbols
usedSymbolsRuleKey	set of storage of visible legend rule keys
context	render context

Note

added in QGIS 2.12

not available in Python bindings

Definition at line 105 of file qgsmaphittest.cpp.

symbolVisible()

bool QgsMapHitTest::symbolVisible	(	QgsSymbolV2 *	symbol,
		QgsVectorLayer *	layer
	)		const

Tests whether a symbol is visible for a specified layer.

Parameters

symbol	symbol to find
layer	vector layer

Note

added in QGIS 2.12

See also

legendKeyVisible()

Definition at line 89 of file qgsmaphittest.cpp.

Member Data Documentation

mHitTest

HitTest QgsMapHitTest::mHitTest

protected

The hit test.

Definition at line 89 of file qgsmaphittest.h.

mHitTestRuleKey

HitTest QgsMapHitTest::mHitTestRuleKey

protected

The hit test, using legend rule keys.

Definition at line 92 of file qgsmaphittest.h.

mLayerFilterExpression

LayerFilterExpression QgsMapHitTest::mLayerFilterExpression

protected

List of expression filter for each layer.

Definition at line 95 of file qgsmaphittest.h.

mOnlyExpressions

bool QgsMapHitTest::mOnlyExpressions

protected

Whether to use only expressions during the filtering.

Definition at line 101 of file qgsmaphittest.h.

mPolygon

QgsGeometry QgsMapHitTest::mPolygon

protected

Polygon used for filtering items. May be empty.

Definition at line 98 of file qgsmaphittest.h.

mSettings

QgsMapSettings QgsMapHitTest::mSettings

protected

The initial map settings.

Definition at line 86 of file qgsmaphittest.h.

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmaphittest.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmaphittest.cpp