QgsPointDisplacementRenderer Class Reference

A renderer that automatically displaces points with the same position. More...

#include <qgspointdisplacementrenderer.h>

Inheritance diagram for QgsPointDisplacementRenderer:

Public Member Functions
	QgsPointDisplacementRenderer (const QString &labelAttributeName="")
	~QgsPointDisplacementRenderer ()
QgsFeatureRendererV2 *	clone () const
virtual void	toSld (QDomDocument &doc, QDomElement &element) const
	used from subclasses to create SLD Rule elements following SLD v1.1 specs
bool	renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
	Reimplemented from QgsFeatureRendererV2.
QgsSymbolV2 *	symbolForFeature (QgsFeature &feature)
	to be overridden
void	startRender (QgsRenderContext &context, const QgsFields &fields)
void	stopRender (QgsRenderContext &context)
QList< QString >	usedAttributes ()
QgsSymbolV2List	symbols ()
	for symbol levels
QDomElement	save (QDomDocument &doc)
	store renderer info to XML element
QgsLegendSymbologyList	legendSymbologyItems (QSize iconSize)
	return a list of symbology items for the legend
QgsLegendSymbolList	legendSymbolItems (double scaleDenominator=-1, QString rule="")
void	setLabelAttributeName (const QString &name)
QString	labelAttributeName () const
void	setEmbeddedRenderer (QgsFeatureRendererV2 *r)
	Sets embedded renderer (takes ownership)
QgsFeatureRendererV2 *	embeddedRenderer () const
Q_DECL_DEPRECATED void	setDisplacementGroups (const QList< QMap< QgsFeatureId, QgsFeature > > &list)
	not available in python bindings
void	setLabelFont (const QFont &f)
QFont	labelFont () const
void	setCircleWidth (double w)
double	circleWidth () const
void	setCircleColor (const QColor &c)
QColor	circleColor () const
void	setLabelColor (const QColor &c)
QColor	labelColor () const
void	setCircleRadiusAddition (double d)
double	circleRadiusAddition () const
void	setMaxLabelScaleDenominator (double d)
double	maxLabelScaleDenominator () const
QgsMarkerSymbolV2 *	centerSymbol ()
	Returns the symbol for the center of a displacement group (but not ownership of the symbol)
void	setCenterSymbol (QgsMarkerSymbolV2 *symbol)
	Sets the center symbol (takes ownership)
void	setTolerance (double t)
double	tolerance () const
Public Member Functions inherited from QgsFeatureRendererV2
QString	type () const
virtual QgsSymbolV2 *	originalSymbolForFeature (QgsFeature &feature)
	Return symbol for feature.
virtual Q_DECL_DEPRECATED void	startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
virtual	~QgsFeatureRendererV2 ()
virtual QString	dump () const
	for debugging
virtual int	capabilities ()
	returns bitwise OR-ed capabilities of the renderer
bool	usingSymbolLevels () const
void	setUsingSymbolLevels (bool usingSymbolLevels)
virtual QDomElement	writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const
	create the SLD UserStyle element following the SLD v1.1 specs
virtual bool	legendSymbolItemsCheckable () const
	items of symbology items in legend should be checkable
virtual bool	legendSymbolItemChecked (QString key)
	items of symbology items in legend is checked
virtual void	checkLegendSymbolItem (QString key, bool state=true)
	item in symbology was checked
virtual QgsLegendSymbolListV2	legendSymbolItemsV2 () const
	Return a list of symbology items for the legend.
virtual QString	legendClassificationAttribute () const
	If supported by the renderer, return classification attribute for the use in legend.
void	setVertexMarkerAppearance (int type, int size)
	set type and size of editing vertex markers for subsequent rendering
virtual QString	rotationField () const
	return rotation field name (or empty string if not set or not supported by renderer)
virtual void	setRotationField (QString fieldName)
	sets rotation field of renderer (if supported by the renderer)
virtual bool	willRenderFeature (QgsFeature &feat)
	return whether the renderer will render a feature or not.
virtual QgsSymbolV2List	symbolsForFeature (QgsFeature &feat)
	return list of symbols used for rendering the feature.
virtual QgsSymbolV2List	originalSymbolsForFeature (QgsFeature &feat)
	Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()

Static Public Member Functions
static QgsFeatureRendererV2 *	create (QDomElement &symbologyElem)
	create a renderer from XML element
static QgsPointDisplacementRenderer *	convertFromRenderer (const QgsFeatureRendererV2 *renderer)
	creates a QgsPointDisplacementRenderer from an existing renderer.
Static Public Member Functions inherited from QgsFeatureRendererV2
static QgsFeatureRendererV2 *	defaultRenderer (QGis::GeometryType geomType)
	return a new renderer - used by default in vector layers
static QgsFeatureRendererV2 *	load (QDomElement &symbologyElem)
	create a renderer from XML element
static QgsFeatureRendererV2 *	loadSld (const QDomNode &node, QGis::GeometryType geomType, QString &errorMessage)
	create a new renderer according to the information contained in the UserStyle element of a SLD style document

Additional Inherited Members
Public Types inherited from QgsFeatureRendererV2
enum	Capabilities {   SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3,   ScaleDependent = 1 << 4 }
Protected Member Functions inherited from QgsFeatureRendererV2
	QgsFeatureRendererV2 (QString type)
void	renderFeatureWithSymbol (QgsFeature &feature, QgsSymbolV2 *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
void	renderVertexMarker (QPointF &pt, QgsRenderContext &context)
	render editing vertex marker at specified point
void	renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
	render editing vertex marker for a polyline
void	renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
	render editing vertex marker for a polygon
void	setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod)
Static Protected Member Functions inherited from QgsFeatureRendererV2
static const unsigned char *	_getPoint (QPointF &pt, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char *	_getLineString (QPolygonF &pts, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char *	_getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, const unsigned char *wkb)
Protected Attributes inherited from QgsFeatureRendererV2
QString	mType
bool	mUsingSymbolLevels
int	mCurrentVertexMarkerType
	The current type of editing marker.
int	mCurrentVertexMarkerSize
	The current size of editing marker.

Detailed Description

A renderer that automatically displaces points with the same position.

Constructor & Destructor Documentation

QgsPointDisplacementRenderer::QgsPointDisplacementRenderer

(

const QString &

labelAttributeName = ""

)

QgsPointDisplacementRenderer::~QgsPointDisplacementRenderer

(

)

Member Function Documentation

QgsMarkerSymbolV2* QgsPointDisplacementRenderer::centerSymbol ( )

inline

Returns the symbol for the center of a displacement group (but not ownership of the symbol)

QColor QgsPointDisplacementRenderer::circleColor ( ) const

inline

double QgsPointDisplacementRenderer::circleRadiusAddition ( ) const

inline

double QgsPointDisplacementRenderer::circleWidth ( ) const

inline

QgsFeatureRendererV2 * QgsPointDisplacementRenderer::clone ( ) const

virtual

Implements QgsFeatureRendererV2.

QgsPointDisplacementRenderer * QgsPointDisplacementRenderer::convertFromRenderer ( const QgsFeatureRendererV2 *  renderer )

static

creates a QgsPointDisplacementRenderer from an existing renderer.

Note

added in 2.5

Returns

a new renderer if the conversion was possible, otherwise 0.

QgsFeatureRendererV2 * QgsPointDisplacementRenderer::create ( QDomElement &  symbologyElem )

static

create a renderer from XML element

QgsFeatureRendererV2* QgsPointDisplacementRenderer::embeddedRenderer ( ) const

inline

QString QgsPointDisplacementRenderer::labelAttributeName ( ) const

inline

QColor QgsPointDisplacementRenderer::labelColor ( ) const

inline

QFont QgsPointDisplacementRenderer::labelFont ( ) const

inline

QgsLegendSymbolList QgsPointDisplacementRenderer::legendSymbolItems ( double  scaleDenominator = -1, QString  rule = ""  )

virtual

Note

not available in python bindings

Reimplemented from QgsFeatureRendererV2.

QgsLegendSymbologyList QgsPointDisplacementRenderer::legendSymbologyItems ( QSize  iconSize )

virtual

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

double QgsPointDisplacementRenderer::maxLabelScaleDenominator ( ) const

inline

bool QgsPointDisplacementRenderer::renderFeature ( QgsFeature &  feature, QgsRenderContext &  context, int  layer = -1, bool  selected = false, bool  drawVertexMarker = false  )

virtual

Reimplemented from QgsFeatureRendererV2.

Reimplemented from QgsFeatureRendererV2.

QDomElement QgsPointDisplacementRenderer::save ( QDomDocument &  doc )

virtual

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

void QgsPointDisplacementRenderer::setCenterSymbol

(

QgsMarkerSymbolV2 *

symbol

)

Sets the center symbol (takes ownership)

void QgsPointDisplacementRenderer::setCircleColor ( const QColor &  c )

inline

void QgsPointDisplacementRenderer::setCircleRadiusAddition ( double  d )

inline

void QgsPointDisplacementRenderer::setCircleWidth ( double  w )

inline

Q_DECL_DEPRECATED void QgsPointDisplacementRenderer::setDisplacementGroups ( const QList< QMap< QgsFeatureId, QgsFeature > > &  list )

inline

not available in python bindings

Deprecated:

since 2.4

void QgsPointDisplacementRenderer::setEmbeddedRenderer

(

QgsFeatureRendererV2 *

r

)

Sets embedded renderer (takes ownership)

void QgsPointDisplacementRenderer::setLabelAttributeName ( const QString &  name )

inline

void QgsPointDisplacementRenderer::setLabelColor ( const QColor &  c )

inline

void QgsPointDisplacementRenderer::setLabelFont ( const QFont &  f )

inline

void QgsPointDisplacementRenderer::setMaxLabelScaleDenominator ( double  d )

inline

void QgsPointDisplacementRenderer::setTolerance ( double  t )

inline

void QgsPointDisplacementRenderer::startRender ( QgsRenderContext &  context, const QgsFields &  fields  )

virtual

Implements QgsFeatureRendererV2.

void QgsPointDisplacementRenderer::stopRender ( QgsRenderContext &  context )

virtual

Implements QgsFeatureRendererV2.

QgsSymbolV2 * QgsPointDisplacementRenderer::symbolForFeature ( QgsFeature &  feature )

virtual

to be overridden

Parameters

feature

feature

Returns

returns pointer to symbol or 0 if symbol was not found

Implements QgsFeatureRendererV2.

QgsSymbolV2List QgsPointDisplacementRenderer::symbols ( )

virtual

for symbol levels

Implements QgsFeatureRendererV2.

double QgsPointDisplacementRenderer::tolerance ( ) const

inline

void QgsPointDisplacementRenderer::toSld ( QDomDocument &  doc, QDomElement &  element  ) const

virtual

used from subclasses to create SLD Rule elements following SLD v1.1 specs

Reimplemented from QgsFeatureRendererV2.

QList< QString > QgsPointDisplacementRenderer::usedAttributes ( )

virtual

Implements QgsFeatureRendererV2.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgspointdisplacementrenderer.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/symbology-ng/qgspointdisplacementrenderer.cpp