QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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 ()
 Proxy that will call this method on the embedded renderer. More...
 
QgsMarkerSymbolV2centerSymbol ()
 Returns the symbol for the center of a displacement group (but not ownership of the symbol) More...
 
QColor circleColor () const
 
double circleRadiusAddition () const
 
double circleWidth () const
 
QgsFeatureRendererV2clone () const
 
QgsFeatureRendererV2embeddedRenderer () const
 
QString labelAttributeName () const
 
QColor labelColor () const
 
QFont labelFont () const
 
QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, QString rule="")
 
QgsLegendSymbologyList legendSymbologyItems (QSize iconSize)
 return a list of symbology items for the legend More...
 
double maxLabelScaleDenominator () const
 
virtual QgsSymbolV2originalSymbolForFeature (QgsFeature &feat)
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymbolV2List originalSymbolsForFeature (QgsFeature &feat)
 Proxy that will call this method on the embedded renderer. More...
 
bool renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
 Reimplemented from QgsFeatureRendererV2. More...
 
QDomElement save (QDomDocument &doc)
 store renderer info to XML element More...
 
void setCenterSymbol (QgsMarkerSymbolV2 *symbol)
 Sets the center symbol (takes ownership) More...
 
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 More...
 
void setEmbeddedRenderer (QgsFeatureRendererV2 *r)
 Sets embedded renderer (takes ownership) More...
 
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)
 
void stopRender (QgsRenderContext &context)
 
virtual QgsSymbolV2symbolForFeature (QgsFeature &feature)
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymbolV2List symbols ()
 Proxy that will call this method on the embedded renderer. More...
 
virtual QgsSymbolV2List symbolsForFeature (QgsFeature &feat)
 Proxy that will call this method on the embedded renderer. More...
 
double tolerance () const
 
virtual void toSld (QDomDocument &doc, QDomElement &element) const
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
virtual QList< QString > usedAttributes ()
 Partial proxy that will call this method on the embedded renderer. More...
 
virtual bool willRenderFeature (QgsFeature &feat)
 Proxy that will call this method on the embedded renderer. More...
 
- Public Member Functions inherited from QgsFeatureRendererV2
virtual ~QgsFeatureRendererV2 ()
 
virtual void checkLegendSymbolItem (QString key, bool state=true)
 item in symbology was checked More...
 
virtual QString dump () const
 for debugging More...
 
virtual QString legendClassificationAttribute () const
 If supported by the renderer, return classification attribute for the use in legend. More...
 
virtual bool legendSymbolItemChecked (QString key)
 items of symbology items in legend is checked More...
 
virtual bool legendSymbolItemsCheckable () const
 items of symbology items in legend should be checkable More...
 
virtual QgsLegendSymbolListV2 legendSymbolItemsV2 () const
 Return a list of symbology items for the legend. More...
 
virtual void modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context)
 Allows for a renderer to modify the extent of a feature request prior to rendering. More...
 
virtual QString rotationField () const
 return rotation field name (or empty string if not set or not supported by renderer) More...
 
virtual void setRotationField (QString fieldName)
 sets rotation field of renderer (if supported by the renderer) More...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering More...
 
virtual Q_DECL_DEPRECATED void startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer)
 
QString type () const
 
bool usingSymbolLevels () const
 
virtual QDomElement writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const
 create the SLD UserStyle element following the SLD v1.1 specs More...
 

Static Public Member Functions

static
QgsPointDisplacementRenderer
convertFromRenderer (const QgsFeatureRendererV2 *renderer)
 creates a QgsPointDisplacementRenderer from an existing renderer. More...
 
static QgsFeatureRendererV2create (QDomElement &symbologyElem)
 create a renderer from XML element More...
 
- Static Public Member Functions inherited from QgsFeatureRendererV2
static QgsFeatureRendererV2defaultRenderer (QGis::GeometryType geomType)
 return a new renderer - used by default in vector layers More...
 
static QgsFeatureRendererV2load (QDomElement &symbologyElem)
 create a renderer from XML element More...
 
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 More...
 

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 More...
 
void renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon More...
 
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline More...
 
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)
 
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)
 
- Protected Attributes inherited from QgsFeatureRendererV2
int mCurrentVertexMarkerSize
 The current size of editing marker. More...
 
int mCurrentVertexMarkerType
 The current type of editing marker. More...
 
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 32 of file qgspointdisplacementrenderer.cpp.

QgsPointDisplacementRenderer::~QgsPointDisplacementRenderer ( )

Definition at line 47 of file qgspointdisplacementrenderer.cpp.

Member Function Documentation

int QgsPointDisplacementRenderer::capabilities ( )
virtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 213 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
virtual

Implements QgsFeatureRendererV2.

Definition at line 53 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 563 of file qgspointdisplacementrenderer.cpp.

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

create a renderer from XML element

Definition at line 328 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 = "" 
)
virtual
Note
not available in python bindings

Reimplemented from QgsFeatureRendererV2.

Definition at line 393 of file qgspointdisplacementrenderer.cpp.

QgsLegendSymbologyList QgsPointDisplacementRenderer::legendSymbologyItems ( QSize  iconSize)
virtual

return a list of symbology items for the legend

Reimplemented from QgsFeatureRendererV2.

Definition at line 384 of file qgspointdisplacementrenderer.cpp.

double QgsPointDisplacementRenderer::maxLabelScaleDenominator ( ) const
inline

Definition at line 101 of file qgspointdisplacementrenderer.h.

QgsSymbolV2 * QgsPointDisplacementRenderer::originalSymbolForFeature ( QgsFeature feat)
virtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 240 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2List QgsPointDisplacementRenderer::originalSymbolsForFeature ( QgsFeature feat)
virtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 256 of file qgspointdisplacementrenderer.cpp.

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

Reimplemented from QgsFeatureRendererV2.

Reimplemented from QgsFeatureRendererV2.

Definition at line 77 of file qgspointdisplacementrenderer.cpp.

QDomElement QgsPointDisplacementRenderer::save ( QDomDocument &  doc)
virtual

store renderer info to XML element

Reimplemented from QgsFeatureRendererV2.

Definition at line 358 of file qgspointdisplacementrenderer.cpp.

void QgsPointDisplacementRenderer::setCenterSymbol ( QgsMarkerSymbolV2 symbol)

Sets the center symbol (takes ownership)

Definition at line 434 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 193 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 
)
virtual

Implements QgsFeatureRendererV2.

Definition at line 273 of file qgspointdisplacementrenderer.cpp.

void QgsPointDisplacementRenderer::stopRender ( QgsRenderContext context)
virtual

Implements QgsFeatureRendererV2.

Definition at line 306 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2 * QgsPointDisplacementRenderer::symbolForFeature ( QgsFeature feature)
virtual

Proxy that will call this method on the embedded renderer.

Implements QgsFeatureRendererV2.

Definition at line 231 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2List QgsPointDisplacementRenderer::symbols ( )
virtual

Proxy that will call this method on the embedded renderer.

Implements QgsFeatureRendererV2.

Definition at line 222 of file qgspointdisplacementrenderer.cpp.

QgsSymbolV2List QgsPointDisplacementRenderer::symbolsForFeature ( QgsFeature feat)
virtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 247 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
virtual

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

Reimplemented from QgsFeatureRendererV2.

Definition at line 71 of file qgspointdisplacementrenderer.cpp.

QList< QString > QgsPointDisplacementRenderer::usedAttributes ( )
virtual

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

Implements QgsFeatureRendererV2.

Definition at line 199 of file qgspointdisplacementrenderer.cpp.

bool QgsPointDisplacementRenderer::willRenderFeature ( QgsFeature feat)
virtual

Proxy that will call this method on the embedded renderer.

Reimplemented from QgsFeatureRendererV2.

Definition at line 263 of file qgspointdisplacementrenderer.cpp.


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