QGIS API Documentation  2.17.0-Master (06698cd)
qgspointdisplacementrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgspointdisplacementrenderer.cpp
3  --------------------------------
4  begin : January 26, 2010
5  copyright : (C) 2010 by Marco Hugentobler
6  email : marco at hugis dot net
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSPOINTDISPLACEMENTRENDERER_H
19 #define QGSPOINTDISPLACEMENTRENDERER_H
20 
21 #include "qgsfeature.h"
22 #include "qgssymbolv2.h"
23 #include "qgspoint.h"
24 #include "qgsrendererv2.h"
25 #include <QFont>
26 #include <QSet>
27 
28 class QgsSpatialIndex;
29 
34 {
35  public:
36 
39  enum Placement
40  {
41  Ring,
42  ConcentricRings
43  };
44 
45  QgsPointDisplacementRenderer( const QString& labelAttributeName = "" );
47 
48  QgsPointDisplacementRenderer* clone() const override;
49 
50  virtual void toSld( QDomDocument& doc, QDomElement &element ) const override;
51 
53  bool renderFeature( QgsFeature& feature, QgsRenderContext& context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override;
54 
56  virtual QList<QString> usedAttributes() override;
58  virtual int capabilities() override;
62  virtual QgsSymbolV2List symbols( QgsRenderContext& context ) override;
66  virtual QgsSymbolV2* symbolForFeature( QgsFeature& feature, QgsRenderContext& context ) override;
70  virtual QgsSymbolV2* originalSymbolForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
74  virtual QgsSymbolV2List symbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
78  virtual QgsSymbolV2List originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
82  virtual bool willRenderFeature( QgsFeature& feat, QgsRenderContext& context ) override;
83 
84  virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) override;
85 
86  void stopRender( QgsRenderContext& context ) override;
87 
89  static QgsFeatureRendererV2* create( QDomElement& symbologyElem );
90  QDomElement save( QDomDocument& doc ) override;
91 
93 
95  QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = "" ) override;
96 
97  void setLabelAttributeName( const QString& name ) { mLabelAttributeName = name; }
98  QString labelAttributeName() const { return mLabelAttributeName; }
99 
100  void setEmbeddedRenderer( QgsFeatureRendererV2* r ) override;
101  const QgsFeatureRendererV2* embeddedRenderer() const override;
102 
103  virtual void setLegendSymbolItem( const QString& key, QgsSymbolV2* symbol ) override;
104 
105  virtual bool legendSymbolItemsCheckable() const override;
106  virtual bool legendSymbolItemChecked( const QString& key ) override;
107  virtual void checkLegendSymbolItem( const QString& key, bool state = true ) override;
108 
111  Q_DECL_DEPRECATED void setDisplacementGroups( const QList<QMap<QgsFeatureId, QgsFeature> >& list ) { Q_UNUSED( list ); }
112 
113  void setLabelFont( const QFont& f ) { mLabelFont = f; }
114  QFont labelFont() const { return mLabelFont;}
115 
116  void setCircleWidth( double w ) { mCircleWidth = w; }
117  double circleWidth() const { return mCircleWidth; }
118 
119  void setCircleColor( const QColor& c ) { mCircleColor = c; }
120  QColor circleColor() const { return mCircleColor; }
121 
122  void setLabelColor( const QColor& c ) { mLabelColor = c;}
123  QColor labelColor() const { return mLabelColor; }
124 
125  void setCircleRadiusAddition( double d ) { mCircleRadiusAddition = d; }
126  double circleRadiusAddition() const { return mCircleRadiusAddition; }
127 
128  void setMaxLabelScaleDenominator( double d ) { mMaxLabelScaleDenominator = d; }
129  double maxLabelScaleDenominator() const { return mMaxLabelScaleDenominator; }
130 
135  Placement placement() const { return mPlacement; }
136 
142  void setPlacement( Placement placement ) { mPlacement = placement; }
143 
145  QgsMarkerSymbolV2* centerSymbol() { return mCenterSymbol;}
147  void setCenterSymbol( QgsMarkerSymbolV2* symbol );
148 
155  void setTolerance( double t ) { mTolerance = t; }
156 
162  double tolerance() const { return mTolerance; }
163 
170  void setToleranceUnit( QgsSymbolV2::OutputUnit unit ) { mToleranceUnit = unit; }
171 
177  QgsSymbolV2::OutputUnit toleranceUnit() const { return mToleranceUnit; }
178 
185  void setToleranceMapUnitScale( const QgsMapUnitScale& scale ) { mToleranceMapUnitScale = scale; }
186 
192  const QgsMapUnitScale& toleranceMapUnitScale() const { return mToleranceMapUnitScale; }
193 
197  static QgsPointDisplacementRenderer* convertFromRenderer( const QgsFeatureRendererV2 *renderer );
198 
199  private:
200 
202  QgsFeatureRendererV2* mRenderer;
203 
205  QString mLabelAttributeName;
207  int mLabelIndex;
208 
210  QgsMarkerSymbolV2* mCenterSymbol;
211 
213  double mTolerance;
214  QgsSymbolV2::OutputUnit mToleranceUnit;
215  QgsMapUnitScale mToleranceMapUnitScale;
216 
217  Placement mPlacement;
218 
220  QFont mLabelFont;
221  QColor mLabelColor;
223  double mCircleWidth;
225  QColor mCircleColor;
227  double mCircleRadiusAddition;
229  bool mDrawLabels;
231  double mMaxLabelScaleDenominator;
232 
235  QList<DisplacementGroup> mDisplacementGroups;
237  QMap<QgsFeatureId, int> mGroupIndex;
239  QgsSpatialIndex* mSpatialIndex;
241  QSet<QgsFeatureId> mSelectedFeatures;
242 
244  QgsRectangle searchRect( const QgsPoint& p, double distance ) const;
246  void printInfoDisplacementGroups();
247 
249  QString getLabel( const QgsFeature& f );
250 
251  //rendering methods
252  void renderPoint( const QPointF& point, QgsSymbolV2RenderContext& context, const QList<QgsMarkerSymbolV2*>& symbols,
253  const QStringList& labels );
254 
255  //helper functions
256  void calculateSymbolAndLabelPositions( QgsSymbolV2RenderContext &symbolContext, QPointF centerPoint, int nPosition, double symbolDiagonal, QList<QPointF>& symbolPositions, QList<QPointF>& labelShifts , double &circleRadius ) const;
257  void drawGroup( const DisplacementGroup& group, QgsRenderContext& context );
258  void drawCircle( double radiusPainterUnits, QgsSymbolV2RenderContext& context, QPointF centerPoint, int nSymbols );
259  void drawSymbols( const QgsFeatureList& features, QgsRenderContext& context, const QList< QgsMarkerSymbolV2* >& symbolList, const QList<QPointF>& symbolPositions, bool selected = false );
260  void drawLabels( QPointF centerPoint, QgsSymbolV2RenderContext& context, const QList<QPointF>& labelShifts, const QStringList& labelList );
262  QgsSymbolV2* firstSymbolForFeature( QgsFeatureRendererV2* r, QgsFeature& f, QgsRenderContext& context );
263 };
264 
265 #endif // QGSPOINTDISPLACEMENTRENDERER_H
A rectangle specified with double values.
Definition: qgsrectangle.h:35
Placement
Placement methods for dispersing points.
OutputUnit
The unit of the output.
Definition: qgssymbolv2.h:65
double tolerance() const
Returns the tolerance distance for grouping points.
virtual Q_DECL_DEPRECATED QgsSymbolV2 * originalSymbolForFeature(QgsFeature &feature)
Return symbol for feature.
void setLabelAttributeName(const QString &name)
virtual QDomElement save(QDomDocument &doc)
store renderer info to XML element
const QgsMapUnitScale & toleranceMapUnitScale() const
Returns the map unit scale object for the distance tolerance.
Container of fields for a vector layer.
Definition: qgsfield.h:209
virtual QList< QString > usedAttributes()=0
Returns a set of attributes required for this renderer.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:187
virtual Q_DECL_DEPRECATED bool willRenderFeature(QgsFeature &feat)
Returns whether the renderer will render a feature or not.
virtual bool legendSymbolItemChecked(const QString &key)
items of symbology items in legend is checked
virtual void checkLegendSymbolItem(const QString &key, bool state=true)
item in symbology was checked
virtual QgsLegendSymbologyList legendSymbologyItems(QSize iconSize)
return a list of symbology items for the legend
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)=0
Needs to be called when a new render cycle is started.
void setToleranceUnit(QgsSymbolV2::OutputUnit unit)
Sets the units for the tolerance distance.
virtual void stopRender(QgsRenderContext &context)=0
Needs to be called when a render cycle has finished to clean up.
virtual Q_DECL_DEPRECATED QgsSymbolV2List originalSymbolsForFeature(QgsFeature &feat)
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbol...
virtual bool renderFeature(QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
Render a feature using this renderer in the given context.
virtual void setEmbeddedRenderer(QgsFeatureRendererV2 *subRenderer)
Sets an embedded renderer (subrenderer) for this feature renderer.
virtual QgsFeatureRendererV2 * clone() const =0
virtual Q_DECL_DEPRECATED QgsSymbolV2 * symbolForFeature(QgsFeature &feature)
To be overridden.
virtual QgsLegendSymbolList legendSymbolItems(double scaleDenominator=-1, const QString &rule="")
return a list of item text / symbol
Placement placement() const
Returns the placement method used for dispersing the points.
void setPlacement(Placement placement)
Sets the placement method used for dispersing the points.
virtual Q_DECL_DEPRECATED QgsSymbolV2List symbols()
For symbol levels.
A class to represent a point.
Definition: qgspoint.h:117
virtual const QgsFeatureRendererV2 * embeddedRenderer() const
Returns the current embedded renderer (subrenderer) for this feature renderer.
virtual void toSld(QDomDocument &doc, QDomElement &element) const
used from subclasses to create SLD Rule elements following SLD v1.1 specs
A renderer that automatically displaces points with the same position.
Contains information about the context of a rendering operation.
Struct for storing maximum and minimum scales for measurements in map units.
virtual Q_DECL_DEPRECATED QgsSymbolV2List symbolsForFeature(QgsFeature &feat)
Returns list of symbols used for rendering the feature.
Q_DECL_DEPRECATED void setDisplacementGroups(const QList< QMap< QgsFeatureId, QgsFeature > > &list)
not available in python bindings
virtual bool legendSymbolItemsCheckable() const
items of symbology items in legend should be checkable
void setToleranceMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale object for the distance tolerance.
virtual int capabilities()
returns bitwise OR-ed capabilities of the renderer
QgsSymbolV2::OutputUnit toleranceUnit() const
Returns the units for the tolerance distance.
QgsMarkerSymbolV2 * centerSymbol()
Returns the symbol for the center of a displacement group (but not ownership of the symbol) ...
virtual void setLegendSymbolItem(const QString &key, QgsSymbolV2 *symbol)
Sets the symbol to be used for a legend symbol item.
void setTolerance(double t)
Sets the tolerance distance for grouping points.