QGIS API Documentation  2.99.0-Master (19b062c)
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 "qgis_core.h"
22 #include "qgis.h"
24 
31 {
32  public:
33 
37  enum Placement
38  {
39  Ring,
41  Grid
42  };
43 
48  QgsPointDisplacementRenderer( const QString &labelAttributeName = QString() );
49 
51  virtual void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
52  void stopRender( QgsRenderContext &context ) override;
53  QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
54  virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
55 
57  static QgsFeatureRenderer *create( QDomElement &symbologyElem, const QgsReadWriteContext &context ) SIP_FACTORY;
58 
65  void setCircleWidth( double width ) { mCircleWidth = width; }
66 
72  double circleWidth() const { return mCircleWidth; }
73 
80  void setCircleColor( const QColor &color ) { mCircleColor = color; }
81 
87  QColor circleColor() const { return mCircleColor; }
88 
94  void setCircleRadiusAddition( double distance ) { mCircleRadiusAddition = distance; }
95 
100  double circleRadiusAddition() const { return mCircleRadiusAddition; }
101 
107  Placement placement() const { return mPlacement; }
108 
115  void setPlacement( Placement placement ) { mPlacement = placement; }
116 
121  QgsMarkerSymbol *centerSymbol();
122 
128  void setCenterSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );
129 
135  static QgsPointDisplacementRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
136 
137  private:
138 #ifdef SIP_RUN
141 #endif
142 
144  std::unique_ptr< QgsMarkerSymbol > mCenterSymbol;
145 
147  Placement mPlacement = Ring;
148 
150  double mCircleWidth = 0.4;
152  QColor mCircleColor;
154  double mCircleRadiusAddition = 0;
155 
156  virtual void drawGroup( QPointF centerPoint, QgsRenderContext &context, const QgsPointDistanceRenderer::ClusteredGroup &group ) override SIP_FORCE;
157 
158  //helper functions
159  void calculateSymbolAndLabelPositions( QgsSymbolRenderContext &symbolContext, QPointF centerPoint, int nPosition, double symbolDiagonal, QList<QPointF> &symbolPositions, QList<QPointF> &labelShifts, double &circleRadius,
160  double &gridRadius, int &gridSize ) const;
161  void drawCircle( double radiusPainterUnits, QgsSymbolRenderContext &context, QPointF centerPoint, int nSymbols );
162  void drawSymbols( const ClusteredGroup &group, QgsRenderContext &context, const QList<QPointF> &symbolPositions );
163  void drawGrid( int gridSizeUnits, QgsSymbolRenderContext &context,
164  QList<QPointF> pointSymbolPositions, int nSymbols );
165  void centralizeGrid( QList<QPointF> &pointSymbolPositions, double radius, int size ) const;
166 };
167 
168 #endif // QGSPOINTDISPLACEMENTRENDERER_H
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers...
The class is used as a container of context for various read/write operations on other objects...
Placement
Placement methods for dispersing points.
double circleRadiusAddition() const
Returns the factor for increasing the ring size of displacement groups.
Container of fields for a vector layer.
Definition: qgsfields.h:42
void setCircleColor(const QColor &color)
Sets the color used for drawing the displacement group circle.
#define SIP_FORCE
Definition: qgis_sip.h:124
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QColor circleColor() const
Returns the color used for drawing the displacement group circle.
Place points in concentric rings around group.
void setPlacement(Placement placement)
Sets the placement method used for dispersing the points.
#define SIP_FACTORY
Definition: qgis_sip.h:69
Place points in a single ring around group.
A renderer that automatically displaces points with the same geographic location. ...
Contains information about the context of a rendering operation.
QList< QgsPointDistanceRenderer::GroupedFeature > ClusteredGroup
A group of clustered points (ie features within the distance tolerance).
Placement placement() const
Returns the placement method used for dispersing the points.
void setCircleRadiusAddition(double distance)
Sets a factor for increasing the ring size of displacement groups.
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
double circleWidth() const
Returns the line width for the displacement group circle in mm.