QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
qgspointclusterrenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgspointclusterrenderer.cpp
3 ---------------------------
4 begin : February 2016
5 copyright : (C) 2016 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
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
20#include "qgssymbollayerutils.h"
22#include "qgsproperty.h"
24#include "qgsmarkersymbol.h"
25#include "qgsunittypes.h"
26
27#include <cmath>
28
30 : QgsPointDistanceRenderer( QStringLiteral( "pointCluster" ) )
31{
32 mClusterSymbol.reset( new QgsMarkerSymbol() );
33 mClusterSymbol->setSize( 4 );
34 mClusterSymbol->setColor( QColor( 245, 75, 80 ) );
35
37 fm->setFontFamily( QFont().defaultFamily() );
38 fm->setColor( QColor( 255, 255, 255 ) );
39 fm->setSize( 3.2 );
40 fm->setOffset( QPointF( 0, -0.4 ) );
42 mClusterSymbol->insertSymbolLayer( 1, fm );
43}
44
46{
48 if ( mRenderer )
49 r->setEmbeddedRenderer( mRenderer->clone() );
56 if ( mClusterSymbol )
57 {
58 r->setClusterSymbol( mClusterSymbol->clone() );
59 }
61 return r;
62}
63
64void QgsPointClusterRenderer::drawGroup( QPointF centerPoint, QgsRenderContext &context, const ClusteredGroup &group ) const
65{
66 if ( group.size() > 1 )
67 {
68 mClusterSymbol->renderPoint( centerPoint, &( group.at( 0 ).feature ), context, -1, false );
69 }
70 else
71 {
72 //single isolated symbol, draw it untouched
73 QgsMarkerSymbol *symbol = group.at( 0 ).symbol();
74 symbol->startRender( context );
75 symbol->renderPoint( centerPoint, &( group.at( 0 ).feature ), context, -1, group.at( 0 ).isSelected );
76 symbol->stopRender( context );
77 }
78}
79
81{
82 if ( mClusterSymbol )
83 {
84 mClusterSymbol->startRender( context, fields );
85 }
87}
88
90{
92 if ( mClusterSymbol )
93 {
94 mClusterSymbol->stopRender( context );
95 }
96}
97
98QgsFeatureRenderer *QgsPointClusterRenderer::create( QDomElement &symbologyElem, const QgsReadWriteContext &context )
99{
101 r->setTolerance( symbologyElem.attribute( QStringLiteral( "tolerance" ), QStringLiteral( "0.00001" ) ).toDouble() );
102 r->setToleranceUnit( QgsUnitTypes::decodeRenderUnit( symbologyElem.attribute( QStringLiteral( "toleranceUnit" ), QStringLiteral( "MapUnit" ) ) ) );
103 r->setToleranceMapUnitScale( QgsSymbolLayerUtils::decodeMapUnitScale( symbologyElem.attribute( QStringLiteral( "toleranceUnitScale" ) ) ) );
104
105 //look for an embedded renderer <renderer-v2>
106 QDomElement embeddedRendererElem = symbologyElem.firstChildElement( QStringLiteral( "renderer-v2" ) );
107 if ( !embeddedRendererElem.isNull() )
108 {
109 r->setEmbeddedRenderer( QgsFeatureRenderer::load( embeddedRendererElem, context ) );
110 }
111
112 //center symbol
113 const QDomElement centerSymbolElem = symbologyElem.firstChildElement( QStringLiteral( "symbol" ) );
114 if ( !centerSymbolElem.isNull() )
115 {
116 r->setClusterSymbol( QgsSymbolLayerUtils::loadSymbol<QgsMarkerSymbol>( centerSymbolElem, context ) );
117 }
118 return r;
119}
120
122{
123 return mClusterSymbol.get();
124}
125
126QDomElement QgsPointClusterRenderer::save( QDomDocument &doc, const QgsReadWriteContext &context )
127{
128 QDomElement rendererElement = doc.createElement( RENDERER_TAG_NAME );
129 rendererElement.setAttribute( QStringLiteral( "type" ), QStringLiteral( "pointCluster" ) );
130 rendererElement.setAttribute( QStringLiteral( "tolerance" ), QString::number( mTolerance ) );
131 rendererElement.setAttribute( QStringLiteral( "toleranceUnit" ), QgsUnitTypes::encodeUnit( mToleranceUnit ) );
132 rendererElement.setAttribute( QStringLiteral( "toleranceUnitScale" ), QgsSymbolLayerUtils::encodeMapUnitScale( mToleranceMapUnitScale ) );
133
134 if ( mRenderer )
135 {
136 const QDomElement embeddedRendererElem = mRenderer->save( doc, context );
137 rendererElement.appendChild( embeddedRendererElem );
138 }
139 if ( mClusterSymbol )
140 {
141 const QDomElement centerSymbolElem = QgsSymbolLayerUtils::saveSymbol( QStringLiteral( "centerSymbol" ), mClusterSymbol.get(), doc, context );
142 rendererElement.appendChild( centerSymbolElem );
143 }
144
145 saveRendererData( doc, rendererElement, context );
146
147 return rendererElement;
148}
149
151{
152 QSet<QString> attr = QgsPointDistanceRenderer::usedAttributes( context );
153 if ( mClusterSymbol )
154 attr.unite( mClusterSymbol->usedAttributes( context ) );
155 return attr;
156}
157
159{
160 if ( !QgsPointDistanceRenderer::accept( visitor ) )
161 return false;
162
163 if ( mClusterSymbol )
164 {
165 QgsStyleSymbolEntity entity( mClusterSymbol.get() );
166 if ( !visitor->visit( QgsStyleEntityVisitorInterface::StyleLeaf( &entity, QStringLiteral( "cluster" ), QObject::tr( "Cluster Symbol" ) ) ) )
167 return false;
168 }
169
170 return true;
171}
172
174{
175 mClusterSymbol.reset( symbol );
176}
177
179{
180 if ( renderer->type() == QLatin1String( "pointCluster" ) )
181 {
182 return dynamic_cast<QgsPointClusterRenderer *>( renderer->clone() );
183 }
184 else if ( renderer->type() == QLatin1String( "singleSymbol" ) ||
185 renderer->type() == QLatin1String( "categorizedSymbol" ) ||
186 renderer->type() == QLatin1String( "graduatedSymbol" ) ||
187 renderer->type() == QLatin1String( "RuleRenderer" ) )
188 {
190 pointRenderer->setEmbeddedRenderer( renderer->clone() );
191 renderer->copyRendererData( pointRenderer );
192 return pointRenderer;
193 }
194 else if ( renderer->type() == QLatin1String( "pointDisplacement" ) )
195 {
197 const QgsPointDisplacementRenderer *displacementRenderer = static_cast< const QgsPointDisplacementRenderer * >( renderer );
198 if ( displacementRenderer->embeddedRenderer() )
199 pointRenderer->setEmbeddedRenderer( displacementRenderer->embeddedRenderer()->clone() );
200 pointRenderer->setTolerance( displacementRenderer->tolerance() );
201 pointRenderer->setToleranceUnit( displacementRenderer->toleranceUnit() );
202 pointRenderer->setToleranceMapUnitScale( displacementRenderer->toleranceMapUnitScale() );
203 if ( const_cast< QgsPointDisplacementRenderer * >( displacementRenderer )->centerSymbol() )
204 pointRenderer->setClusterSymbol( const_cast< QgsPointDisplacementRenderer * >( displacementRenderer )->centerSymbol()->clone() );
205 renderer->copyRendererData( pointRenderer );
206 return pointRenderer;
207 }
208 else
209 {
210 return nullptr;
211 }
212}
QString type() const
Definition: qgsrenderer.h:142
void copyRendererData(QgsFeatureRenderer *destRenderer) const
Clones generic renderer data to another renderer.
Definition: qgsrenderer.cpp:46
static QgsFeatureRenderer * load(QDomElement &symbologyElem, const QgsReadWriteContext &context)
create a renderer from XML element
void saveRendererData(QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context)
Saves generic renderer data into the specified element.
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
Container of fields for a vector layer.
Definition: qgsfields.h:45
void setFontFamily(const QString &family)
Sets the font family for the font which will be used to render the point.
virtual void setSize(double size)
Sets the symbol size.
void setOffset(QPointF offset)
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker...
A marker symbol type, for rendering Point and MultiPoint geometries.
QgsMarkerSymbol * clone() const override
Returns a deep copy of this symbol.
void renderPoint(QPointF point, const QgsFeature *f, QgsRenderContext &context, int layer=-1, bool selected=false)
Renders the symbol at the specified point, using the given render context.
A renderer that automatically clusters points with the same geographic position.
void startRender(QgsRenderContext &context, const QgsFields &fields) override
Must be called when a new render cycle is started.
QgsPointClusterRenderer * clone() const override
Create a deep copy of this renderer.
void setClusterSymbol(QgsMarkerSymbol *symbol)
Sets the symbol for rendering clustered groups.
QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) override
Stores renderer properties to an XML element.
QSet< QString > usedAttributes(const QgsRenderContext &context) const override
Returns a list of attributes required by this renderer.
static QgsFeatureRenderer * create(QDomElement &symbologyElem, const QgsReadWriteContext &context)
Creates a renderer from XML element.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
QgsMarkerSymbol * clusterSymbol()
Returns the symbol used for rendering clustered groups (but not ownership of the symbol).
void stopRender(QgsRenderContext &context) override
Must be called when a render cycle has finished, to allow the renderer to clean up.
static QgsPointClusterRenderer * convertFromRenderer(const QgsFeatureRenderer *renderer)
Creates a QgsPointClusterRenderer from an existing renderer.
A renderer that automatically displaces points with the same geographic location.
QgsMarkerSymbol * centerSymbol()
Returns the symbol for the center of a displacement group (but not ownership of the symbol).
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers...
void setLabelColor(const QColor &color)
Sets the color to use for for labeling points.
double mMinLabelScale
Maximum scale denominator for label display. A zero value indicates no scale limitation.
QColor mLabelColor
Label text color.
QgsMapUnitScale mToleranceMapUnitScale
Map unit scale for distance tolerance.
void setLabelFont(const QFont &font)
Sets the font used for labeling points.
void setToleranceUnit(Qgis::RenderUnit unit)
Sets the units for the tolerance distance.
void setMinimumLabelScale(double scale)
Sets the minimum map scale (i.e.
void stopRender(QgsRenderContext &context) override
Must be called when a render cycle has finished, to allow the renderer to clean up.
double tolerance() const
Returns the tolerance distance for grouping points.
void startRender(QgsRenderContext &context, const QgsFields &fields) override
Must be called when a new render cycle is started.
const QgsMapUnitScale & toleranceMapUnitScale() const
Returns the map unit scale object for the distance tolerance.
void setEmbeddedRenderer(QgsFeatureRenderer *r) override
Sets an embedded renderer (subrenderer) for this feature renderer.
const QgsFeatureRenderer * embeddedRenderer() const override
Returns the current embedded renderer (subrenderer) for this feature renderer.
double mTolerance
Distance tolerance. Points that are closer together than this distance are considered clustered.
QSet< QString > usedAttributes(const QgsRenderContext &context) const override
Returns a list of attributes required by this renderer.
std::unique_ptr< QgsFeatureRenderer > mRenderer
Embedded base renderer. This can be used for rendering individual, isolated points.
Qgis::RenderUnit toleranceUnit() const
Returns the units for the tolerance distance.
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.
Qgis::RenderUnit mToleranceUnit
Unit for distance tolerance.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
An interface for classes which can visit style entity (e.g.
virtual bool visit(const QgsStyleEntityVisitorInterface::StyleLeaf &entity)
Called when the visitor will visit a style entity.
A symbol entity for QgsStyle databases.
Definition: qgsstyle.h:1341
static QString encodeMapUnitScale(const QgsMapUnitScale &mapUnitScale)
static QgsMapUnitScale decodeMapUnitScale(const QString &str)
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
@ PropertyCharacter
Character, eg for font marker symbol layers.
virtual void setDataDefinedProperty(Property key, const QgsProperty &property)
Sets a data defined property for the layer.
virtual void setColor(const QColor &color)
Sets the "representative" color for the symbol layer.
void stopRender(QgsRenderContext &context)
Ends the rendering process.
Definition: qgssymbol.cpp:873
void startRender(QgsRenderContext &context, const QgsFields &fields=QgsFields())
Begins the rendering process for the symbol.
Definition: qgssymbol.cpp:825
static Q_INVOKABLE Qgis::RenderUnit decodeRenderUnit(const QString &string, bool *ok=nullptr)
Decodes a render unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
#define RENDERER_TAG_NAME
Definition: qgsrenderer.h:50
Contains information relating to the style entity currently being visited.