QGIS API Documentation  2.9.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
QgsPointDisplacementRenderer Class Reference

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

#include <qgspointdisplacementrenderer.h>

Inheritance diagram for QgsPointDisplacementRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsPointDisplacementRenderer (const QString &labelAttributeName="")
 ~QgsPointDisplacementRenderer ()
virtual int capabilities () override
 Proxy that will call this method on the embedded renderer.
QgsMarkerSymbolV2centerSymbol ()
 Returns the symbol for the center of a displacement group (but not ownership of the symbol)
QColor circleColor () const
double circleRadiusAddition () const
double circleWidth () const
QgsFeatureRendererV2clone () const override
QgsFeatureRendererV2embeddedRenderer () const
QString labelAttributeName () const
QColor labelColor () const
QFont labelFont () const
QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, QString rule="") override
QgsLegendSymbologyList legendSymbologyItems (QSize iconSize) override
 return a list of symbology items for the legend
double maxLabelScaleDenominator () const
virtual QgsSymbolV2originalSymbolForFeature (QgsFeature &feat) override
 Proxy that will call this method on the embedded renderer.
virtual QgsSymbolV2List originalSymbolsForFeature (QgsFeature &feat) override
 Proxy that will call this method on the embedded renderer.
bool renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override
 Reimplemented from QgsFeatureRendererV2.
QDomElement save (QDomDocument &doc) override
 store renderer info to XML element
void setCenterSymbol (QgsMarkerSymbolV2 *symbol)
 Sets the center symbol (takes ownership)
void setCircleColor (const QColor &c)
void setCircleRadiusAddition (double d)
void setCircleWidth (double w)
Q_DECL_DEPRECATED void setDisplacementGroups (const QList< QMap< QgsFeatureId, QgsFeature > > &list)
 not available in python bindings
void setEmbeddedRenderer (QgsFeatureRendererV2 *r)
 Sets embedded renderer (takes ownership)
void setLabelAttributeName (const QString &name)
void setLabelColor (const QColor &c)
void setLabelFont (const QFont &f)
void setMaxLabelScaleDenominator (double d)
void setTolerance (double t)
void startRender (QgsRenderContext &context, const QgsFields &fields) override
void stopRender (QgsRenderContext &context) override
virtual QgsSymbolV2symbolForFeature (QgsFeature &feature) override
 Proxy that will call this method on the embedded renderer.
virtual QgsSymbolV2List symbols () override
 Proxy that will call this method on the embedded renderer.
virtual QgsSymbolV2List symbolsForFeature (QgsFeature &feat) override
 Proxy that will call this method on the embedded renderer.
double tolerance () const
virtual void toSld (QDomDocument &doc, QDomElement &element) const override
 used from subclasses to create SLD Rule elements following SLD v1.1 specs
virtual QList< QString > usedAttributes () override
 Partial proxy that will call this method on the embedded renderer.
virtual bool willRenderFeature (QgsFeature &feat) override
 Proxy that will call this method on the embedded renderer.
- Public Member Functions inherited from QgsFeatureRendererV2
virtual ~QgsFeatureRendererV2 ()
virtual void checkLegendSymbolItem (QString key, bool state=true)
 item in symbology was checked
virtual QString dump () const
 for debugging
virtual QString legendClassificationAttribute () const
 If supported by the renderer, return classification attribute for the use in legend.
virtual bool legendSymbolItemChecked (QString key)
 items of symbology items in legend is checked
virtual bool legendSymbolItemsCheckable () const
 items of symbology items in legend should be checkable
virtual QgsLegendSymbolListV2 legendSymbolItemsV2 () const
 Return a list of symbology items for the legend.
virtual void modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context)
 Allows for a renderer to modify the extent of a feature request prior to rendering.
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the renderer.
virtual QString rotationField () const
 return rotation field name (or empty string if not set or not supported by renderer)
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the renderer.
virtual void setRotationField (QString fieldName)
 sets rotation field of renderer (if supported by the renderer)
void setUsingSymbolLevels (bool usingSymbolLevels)
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering
virtual Q_DECL_DEPRECATED void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
QString type () const
bool usingSymbolLevels () const
virtual Q_DECL_DEPRECATED
QDomElement 
writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const
 create the SLD UserStyle element following the SLD v1.1 specs
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name

Static Public Member Functions

static
QgsPointDisplacementRenderer
convertFromRenderer (const QgsFeatureRendererV2 *renderer)
 creates a QgsPointDisplacementRenderer from an existing renderer.
static QgsFeatureRendererV2create (QDomElement &symbologyElem)
 create a renderer from XML element
- Static Public Member Functions inherited from QgsFeatureRendererV2
static QgsFeatureRendererV2defaultRenderer (QGis::GeometryType geomType)
 return a new renderer - used by default in vector layers
static QgsFeatureRendererV2load (QDomElement &symbologyElem)
 create a renderer from XML element
static QgsFeatureRendererV2loadSld (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 copyPaintEffect (QgsFeatureRendererV2 *destRenderer) const
 Copies paint effect of this renderer to another renderer.
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 renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline
void setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod)
- Static Protected Member Functions inherited from QgsFeatureRendererV2
static const unsigned char * _getLineString (QPolygonF &pts, QgsRenderContext &context, const unsigned char *wkb, bool clipToExtent=true)
static const unsigned char * _getPoint (QPointF &pt, QgsRenderContext &context, const unsigned char *wkb)
static const unsigned char * _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, const unsigned char *wkb, bool clipToExtent=true)
static void convertSymbolRotation (QgsSymbolV2 *symbol, const QString &field)
static void convertSymbolSizeScale (QgsSymbolV2 *symbol, QgsSymbolV2::ScaleMethod method, const QString &field)
- Protected Attributes inherited from QgsFeatureRendererV2
int mCurrentVertexMarkerSize
 The current size of editing marker.
int mCurrentVertexMarkerType
 The current type of editing marker.
QgsPaintEffectmPaintEffect
QString mType
bool mUsingSymbolLevels

Detailed Description

A renderer that automatically displaces points with the same position.

Definition at line 31 of file qgspointdisplacementrenderer.h.

Constructor & Destructor Documentation

QgsPointDisplacementRenderer::QgsPointDisplacementRenderer ( const QString &  labelAttributeName = "")

Definition at line 33 of file qgspointdisplacementrenderer.cpp.

QgsPointDisplacementRenderer::~QgsPointDisplacementRenderer ( )

Definition at line 49 of file qgspointdisplacementrenderer.cpp.

Member Function Documentation

int QgsPointDisplacementRenderer::capabilities ( )
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 221 of file qgspointdisplacementrenderer.cpp.

QgsMarkerSymbolV2* QgsPointDisplacementRenderer::centerSymbol ( )
inline

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

Definition at line 104 of file qgspointdisplacementrenderer.h.

QColor QgsPointDisplacementRenderer::circleColor ( ) const
inline

Definition at line 92 of file qgspointdisplacementrenderer.h.

double QgsPointDisplacementRenderer::circleRadiusAddition ( ) const
inline

Definition at line 98 of file qgspointdisplacementrenderer.h.

double QgsPointDisplacementRenderer::circleWidth ( ) const
inline

Definition at line 89 of file qgspointdisplacementrenderer.h.

QgsFeatureRendererV2 * QgsPointDisplacementRenderer::clone ( ) const
overridevirtual

Implements QgsFeatureRendererV2.

Definition at line 55 of file qgspointdisplacementrenderer.cpp.

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.

Definition at line 575 of file qgspointdisplacementrenderer.cpp.

QgsFeatureRendererV2 * QgsPointDisplacementRenderer::create ( QDomElement &  symbologyElem)
static

create a renderer from XML element

Definition at line 336 of file qgspointdisplacementrenderer.cpp.

QgsFeatureRendererV2* QgsPointDisplacementRenderer::embeddedRenderer ( ) const
inline

Definition at line 79 of file qgspointdisplacementrenderer.h.

QString QgsPointDisplacementRenderer::labelAttributeName ( ) const
inline

Definition at line 75 of file qgspointdisplacementrenderer.h.

QColor QgsPointDisplacementRenderer::labelColor ( ) const
inline

Definition at line 95 of file qgspointdisplacementrenderer.h.

QFont QgsPointDisplacementRenderer::labelFont ( ) const
inline

Definition at line 86 of file qgspointdisplacementrenderer.h.

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

Reimplemented from QgsFeatureRendererV2.

Definition at line 405 of file qgspointdisplacementrenderer.cpp.

QgsLegendSymbologyList QgsPointDisplacementRenderer::legendSymbologyItems ( QSize  iconSize)
overridevirtual

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 396 of file qgspointdisplacementrenderer.cpp.

double QgsPointDisplacementRenderer::maxLabelScaleDenominator ( ) const
inline

Definition at line 101 of file qgspointdisplacementrenderer.h.

QgsSymbolV2 * QgsPointDisplacementRenderer::originalSymbolForFeature ( QgsFeature feat)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 248 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2List QgsPointDisplacementRenderer::originalSymbolsForFeature ( QgsFeature feat)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 264 of file qgspointdisplacementrenderer.cpp.

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

Reimplemented from QgsFeatureRendererV2.

Reimplemented from QgsFeatureRendererV2.

Definition at line 80 of file qgspointdisplacementrenderer.cpp.

QDomElement QgsPointDisplacementRenderer::save ( QDomDocument &  doc)
overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 366 of file qgspointdisplacementrenderer.cpp.

void QgsPointDisplacementRenderer::setCenterSymbol ( QgsMarkerSymbolV2 symbol)

Sets the center symbol (takes ownership)

Definition at line 446 of file qgspointdisplacementrenderer.cpp.

void QgsPointDisplacementRenderer::setCircleColor ( const QColor &  c)
inline

Definition at line 91 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setCircleRadiusAddition ( double  d)
inline

Definition at line 97 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setCircleWidth ( double  w)
inline

Definition at line 88 of file qgspointdisplacementrenderer.h.

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

not available in python bindings

Deprecated:
since 2.4

Definition at line 83 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setEmbeddedRenderer ( QgsFeatureRendererV2 r)

Sets embedded renderer (takes ownership)

Definition at line 201 of file qgspointdisplacementrenderer.cpp.

void QgsPointDisplacementRenderer::setLabelAttributeName ( const QString &  name)
inline

Definition at line 74 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setLabelColor ( const QColor &  c)
inline

Definition at line 94 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setLabelFont ( const QFont &  f)
inline

Definition at line 85 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setMaxLabelScaleDenominator ( double  d)
inline

Definition at line 100 of file qgspointdisplacementrenderer.h.

void QgsPointDisplacementRenderer::setTolerance ( double  t)
inline

Definition at line 108 of file qgspointdisplacementrenderer.h.

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

Implements QgsFeatureRendererV2.

Definition at line 281 of file qgspointdisplacementrenderer.cpp.

void QgsPointDisplacementRenderer::stopRender ( QgsRenderContext context)
overridevirtual

Implements QgsFeatureRendererV2.

Definition at line 314 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2 * QgsPointDisplacementRenderer::symbolForFeature ( QgsFeature feature)
overridevirtual

Proxy that will call this method on the embedded renderer.

Implements QgsFeatureRendererV2.

Definition at line 239 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2List QgsPointDisplacementRenderer::symbols ( )
overridevirtual

Proxy that will call this method on the embedded renderer.

Implements QgsFeatureRendererV2.

Definition at line 230 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2List QgsPointDisplacementRenderer::symbolsForFeature ( QgsFeature feat)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 255 of file qgspointdisplacementrenderer.cpp.

double QgsPointDisplacementRenderer::tolerance ( ) const
inline

Definition at line 109 of file qgspointdisplacementrenderer.h.

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

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

Reimplemented from QgsFeatureRendererV2.

Definition at line 74 of file qgspointdisplacementrenderer.cpp.

QList< QString > QgsPointDisplacementRenderer::usedAttributes ( )
overridevirtual

Partial proxy that will call this method on the embedded renderer.

Implements QgsFeatureRendererV2.

Definition at line 207 of file qgspointdisplacementrenderer.cpp.

bool QgsPointDisplacementRenderer::willRenderFeature ( QgsFeature feat)
overridevirtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 271 of file qgspointdisplacementrenderer.cpp.


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