QGIS API Documentation  3.27.0-Master (597e8eebd4)
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  QString legendKeyToExpression( const QString &key, QgsVectorLayer *layer, bool &ok ) const override;
97  bool willRenderFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
98  void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
99  void stopRender( QgsRenderContext &context ) override;
100  QgsLegendSymbolList legendSymbolItems() const override;
101  void setEmbeddedRenderer( QgsFeatureRenderer *r SIP_TRANSFER ) override;
102  const QgsFeatureRenderer *embeddedRenderer() const override;
103  void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
104  bool legendSymbolItemsCheckable() const override;
105  bool legendSymbolItemChecked( const QString &key ) override;
106  void checkLegendSymbolItem( const QString &key, bool state ) override;
107  QString filter( const QgsFields &fields = QgsFields() ) override;
108  bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
109 
118  void setLabelAttributeName( const QString &name ) { mLabelAttributeName = name; }
119 
128  QString labelAttributeName() const { return mLabelAttributeName; }
129 
137  void setLabelFont( const QFont &font ) { mLabelFont = font; }
138 
145  QFont labelFont() const { return mLabelFont;}
146 
153  void setMinimumLabelScale( double scale ) { mMinLabelScale = scale; }
154 
161  double minimumLabelScale() const { return mMinLabelScale; }
162 
170  void setLabelColor( const QColor &color ) { mLabelColor = color;}
171 
178  QColor labelColor() const { return mLabelColor; }
179 
187  void setTolerance( double distance ) { mTolerance = distance; }
188 
195  double tolerance() const { return mTolerance; }
196 
204  void setToleranceUnit( QgsUnitTypes::RenderUnit unit ) { mToleranceUnit = unit; }
205 
212  QgsUnitTypes::RenderUnit toleranceUnit() const { return mToleranceUnit; }
213 
221  void setToleranceMapUnitScale( const QgsMapUnitScale &scale ) { mToleranceMapUnitScale = scale; }
222 
229  const QgsMapUnitScale &toleranceMapUnitScale() const { return mToleranceMapUnitScale; }
230 
231  protected:
232 
234  std::unique_ptr< QgsFeatureRenderer > mRenderer;
235 
238 
241 
243  double mTolerance;
248 
250  QFont mLabelFont;
252  QColor mLabelColor;
256  double mMinLabelScale = 0;
257 
259  QList<ClusteredGroup> mClusteredGroups;
260 
262  QMap<QgsFeatureId, int> mGroupIndex;
263 
265  QMap<QgsFeatureId, QgsPointXY > mGroupLocations;
266 
268  QgsSpatialIndex *mSpatialIndex = nullptr;
269 
278  void drawLabels( QPointF centerPoint, QgsSymbolRenderContext &context, const QList<QPointF> &labelShifts, const ClusteredGroup &group ) const;
279 
280  private:
281 
288  virtual void drawGroup( QPointF centerPoint, QgsRenderContext &context, const ClusteredGroup &group ) const = 0 SIP_FORCE;
289 
291  QgsRectangle searchRect( const QgsPoint *p, double distance ) const;
292 
294  void printGroupInfo() const;
295 
297  QString getLabel( const QgsFeature &feature ) const;
298 
300  void drawGroup( const ClusteredGroup &group, QgsRenderContext &context ) const;
301 
307  QgsMarkerSymbol *firstSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context );
308 
314  QgsExpressionContextScope *createGroupScope( const ClusteredGroup &group ) const;
315 
316 };
317 
318 #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).
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
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:93
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:168
Represents a vector layer which manages a vector based data sets.
#define SIP_THROW(name)
Definition: qgis_sip.h:198
#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.