QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgspointdistancerenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgspointdistancerenderer.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 QGSPOINTDISTANCERENDERER_H
19 #define QGSPOINTDISTANCERENDERER_H
20 
21 #include "qgis_core.h"
22 #include "qgis.h"
23 #include "qgsrenderer.h"
24 #include "qgsmapunitscale.h"
25 #include <QFont>
26 
27 class QgsSpatialIndex;
28 class QgsMarkerSymbol;
30 
42 {
43  public:
44 
46  struct CORE_EXPORT GroupedFeature
47  {
48 
56  GroupedFeature( const QgsFeature &feature, QgsMarkerSymbol *symbol SIP_TRANSFER, bool isSelected, const QString &label = QString() );
58 
61 
63  QgsMarkerSymbol *symbol() const { return mSymbol.get(); }
64 
66  bool isSelected;
67 
69  QString label;
70 
71  private:
72  std::shared_ptr< QgsMarkerSymbol > mSymbol;
73  };
74 
76  typedef QList< QgsPointDistanceRenderer::GroupedFeature > ClusteredGroup;
77 
83  QgsPointDistanceRenderer( const QString &rendererName, const QString &labelAttributeName = QString() );
84 
85  void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override;
86  bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override SIP_THROW( QgsCsException );
87  QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
88  bool filterNeedsGeometry() const override;
89  QgsFeatureRenderer::Capabilities capabilities() override;
90  QgsSymbolList symbols( QgsRenderContext &context ) const override;
91  QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
92  QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
93  QgsSymbolList symbolsForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
94  QgsSymbolList originalSymbolsForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
95  QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
96  bool willRenderFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
97  void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
98  void stopRender( QgsRenderContext &context ) override;
99  QgsLegendSymbolList legendSymbolItems() const override;
100  void setEmbeddedRenderer( QgsFeatureRenderer *r SIP_TRANSFER ) override;
101  const QgsFeatureRenderer *embeddedRenderer() const override;
102  void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
103  bool legendSymbolItemsCheckable() const override;
104  bool legendSymbolItemChecked( const QString &key ) override;
105  void checkLegendSymbolItem( const QString &key, bool state ) override;
106  QString filter( const QgsFields &fields = QgsFields() ) override;
107  bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
108 
117  void setLabelAttributeName( const QString &name ) { mLabelAttributeName = name; }
118 
127  QString labelAttributeName() const { return mLabelAttributeName; }
128 
136  void setLabelFont( const QFont &font ) { mLabelFont = font; }
137 
144  QFont labelFont() const { return mLabelFont;}
145 
152  void setMinimumLabelScale( double scale ) { mMinLabelScale = scale; }
153 
160  double minimumLabelScale() const { return mMinLabelScale; }
161 
169  void setLabelColor( const QColor &color ) { mLabelColor = color;}
170 
177  QColor labelColor() const { return mLabelColor; }
178 
186  void setTolerance( double distance ) { mTolerance = distance; }
187 
194  double tolerance() const { return mTolerance; }
195 
203  void setToleranceUnit( QgsUnitTypes::RenderUnit unit ) { mToleranceUnit = unit; }
204 
211  QgsUnitTypes::RenderUnit toleranceUnit() const { return mToleranceUnit; }
212 
220  void setToleranceMapUnitScale( const QgsMapUnitScale &scale ) { mToleranceMapUnitScale = scale; }
221 
228  const QgsMapUnitScale &toleranceMapUnitScale() const { return mToleranceMapUnitScale; }
229 
230  protected:
231 
233  std::unique_ptr< QgsFeatureRenderer > mRenderer;
234 
237 
240 
242  double mTolerance;
247 
249  QFont mLabelFont;
251  QColor mLabelColor;
255  double mMinLabelScale = 0;
256 
258  QList<ClusteredGroup> mClusteredGroups;
259 
261  QMap<QgsFeatureId, int> mGroupIndex;
262 
264  QMap<QgsFeatureId, QgsPointXY > mGroupLocations;
265 
267  QgsSpatialIndex *mSpatialIndex = nullptr;
268 
277  void drawLabels( QPointF centerPoint, QgsSymbolRenderContext &context, const QList<QPointF> &labelShifts, const ClusteredGroup &group );
278 
279  private:
280 
287  virtual void drawGroup( QPointF centerPoint, QgsRenderContext &context, const ClusteredGroup &group ) = 0 SIP_FORCE;
288 
290  QgsRectangle searchRect( const QgsPointXY &p, double distance ) const;
291 
293  void printGroupInfo() const;
294 
296  QString getLabel( const QgsFeature &feature ) const;
297 
299  void drawGroup( const ClusteredGroup &group, QgsRenderContext &context );
300 
306  QgsMarkerSymbol *firstSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context );
307 
313  QgsExpressionContextScope *createGroupScope( const ClusteredGroup &group ) const;
314 
315 };
316 
317 #endif // QGSPOINTDISTANCERENDERER_H
Custom exception class for Coordinate Reference System related exceptions.
Definition: qgsexception.h:66
Single scope for storing variables and functions for use within a QgsExpressionContext.
virtual void toSld(QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
used from subclasses to create SLD Rule elements following SLD v1.1 specs
Definition: qgsrenderer.h:326
virtual bool renderFeature(const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException)
Render a feature using this renderer in the given context.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Container of fields for a vector layer.
Definition: qgsfields.h:45
Struct for storing maximum and minimum scales for measurements in map units.
A marker symbol type, for rendering Point and MultiPoint geometries.
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers...
QMap< QgsFeatureId, QgsPointXY > mGroupLocations
Mapping of feature ID to approximate group location.
void setLabelColor(const QColor &color)
Sets the color to use for for labeling points.
QColor labelColor() const
Returns the color used for for labeling points.
int mLabelIndex
Label attribute index (or -1 if none). This index is not stored, it is requested in the startRender()...
QColor mLabelColor
Label text color.
QgsMapUnitScale mToleranceMapUnitScale
Map unit scale for distance tolerance.
QgsUnitTypes::RenderUnit toleranceUnit() const
Returns the units for the tolerance distance.
QList< ClusteredGroup > mClusteredGroups
Groups of features that are considered clustered together.
void setLabelFont(const QFont &font)
Sets the font used for labeling points.
QMap< QgsFeatureId, int > mGroupIndex
Mapping of feature ID to the feature's group index.
double minimumLabelScale() const
Returns the minimum map scale (i.e.
void setMinimumLabelScale(double scale)
Sets the minimum map scale (i.e.
double tolerance() const
Returns the tolerance distance for grouping points.
QFont labelFont() const
Returns the font used for labeling points.
QString labelAttributeName() const
Returns the attribute name used for labeling points, or an empty string if no labeling will be done b...
const QgsMapUnitScale & toleranceMapUnitScale() const
Returns the map unit scale object for the distance tolerance.
void setToleranceUnit(QgsUnitTypes::RenderUnit unit)
Sets the units for the tolerance distance.
QString mLabelAttributeName
Attribute name for labeling. An empty string indicates that no labels should be rendered.
double mTolerance
Distance tolerance. Points that are closer together than this distance are considered clustered.
bool mDrawLabels
Whether labels should be drawn for points. This is set internally from startRender() depending on sca...
std::unique_ptr< QgsFeatureRenderer > mRenderer
Embedded base renderer. This can be used for rendering individual, isolated points.
QgsUnitTypes::RenderUnit mToleranceUnit
Unit for distance tolerance.
void setToleranceMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale object for the distance tolerance.
void setTolerance(double distance)
Sets the tolerance distance for grouping points.
QList< QgsPointDistanceRenderer::GroupedFeature > ClusteredGroup
A group of clustered points (ie features within the distance tolerance).
A class to represent a 2D point.
Definition: qgspointxy.h:59
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Contains information about the context of a rendering operation.
A spatial index for QgsFeature objects.
An interface for classes which can visit style entity (e.g.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:38
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:168
#define SIP_THROW(name)
Definition: qgis_sip.h:189
#define SIP_FORCE
Definition: qgis_sip.h:131
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QList< QgsLegendSymbolItem > QgsLegendSymbolList
QList< QgsSymbol * > QgsSymbolList
Definition: qgsrenderer.h:44
Contains properties for a feature within a clustered group.
bool isSelected
True if feature is selected and should be rendered in a selected state.
QgsMarkerSymbol * symbol() const
Base symbol for rendering feature.