QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers). More...
#include <qgspointdistancerenderer.h>
Classes | |
struct | GroupedFeature |
Contains properties for a feature within a clustered group. More... | |
Public Types | |
typedef QList< QgsPointDistanceRenderer::GroupedFeature > | ClusteredGroup |
A group of clustered points (ie features within the distance tolerance). | |
Public Types inherited from QgsFeatureRenderer | |
typedef QFlags< Capability > | Capabilities |
enum | Capability { SymbolLevels = 1 , MoreSymbolsPerFeature = 1 << 2 , Filter = 1 << 3 , ScaleDependent = 1 << 4 } |
Used to specify details about a renderer. More... | |
enum class | Property : int { HeatmapRadius , HeatmapMaximum } |
Data definable properties for renderers. More... | |
Public Member Functions | |
QgsPointDistanceRenderer (const QString &rendererName, const QString &labelAttributeName=QString()) | |
Constructor for QgsPointDistanceRenderer. | |
bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. | |
QgsFeatureRenderer::Capabilities | capabilities () override |
Returns details about internals of this renderer. | |
void | checkLegendSymbolItem (const QString &key, bool state) override |
Sets whether the legend symbology item with the specified ley should be checked. | |
const QgsFeatureRenderer * | embeddedRenderer () const override |
Returns the current embedded renderer (subrenderer) for this feature renderer. | |
QString | filter (const QgsFields &fields=QgsFields()) override |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause. | |
bool | filterNeedsGeometry () const override |
Returns true if this renderer requires the geometry to apply the filter. | |
QString | labelAttributeName () const |
Returns the attribute name used for labeling points, or an empty string if no labeling will be done by the renderer. | |
QColor | labelColor () const |
Returns the color used for for labeling points. | |
QFont | labelFont () const |
Returns the font used for labeling points. | |
QSet< QString > | legendKeysForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns legend keys matching a specified feature. | |
QString | legendKeyToExpression (const QString &key, QgsVectorLayer *layer, bool &ok) const override |
Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key. | |
bool | legendSymbolItemChecked (const QString &key) override |
Returns true if the legend symbology item with the specified key is checked. | |
QgsLegendSymbolList | legendSymbolItems () const override |
Returns a list of symbology items for the legend. | |
bool | legendSymbolItemsCheckable () const override |
Returns true if symbology items in legend are checkable. | |
double | minimumLabelScale () const |
Returns the minimum map scale (i.e. | |
QgsSymbol * | originalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns symbol for feature. | |
QgsSymbolList | originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() | |
bool | renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override |
Render a feature using this renderer in the given context. | |
void | setEmbeddedRenderer (QgsFeatureRenderer *r) override |
Sets an embedded renderer (subrenderer) for this feature renderer. | |
void | setLabelAttributeName (const QString &name) |
Sets the attribute name for labeling points. | |
void | setLabelColor (const QColor &color) |
Sets the color to use for for labeling points. | |
void | setLabelFont (const QFont &font) |
Sets the font used for labeling points. | |
void | setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override |
Sets the symbol to be used for a legend symbol item. | |
void | setMinimumLabelScale (double scale) |
Sets the minimum map scale (i.e. | |
void | setTolerance (double distance) |
Sets the tolerance distance for grouping points. | |
void | setToleranceMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale object for the distance tolerance. | |
void | setToleranceUnit (Qgis::RenderUnit unit) |
Sets the units for the tolerance distance. | |
void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
Must be called when a new render cycle is started. | |
void | stopRender (QgsRenderContext &context) override |
Must be called when a render cycle has finished, to allow the renderer to clean up. | |
QgsSymbol * | symbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
To be overridden. | |
QgsSymbolList | symbols (QgsRenderContext &context) const override |
Returns list of symbols used by the renderer. | |
QgsSymbolList | symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns list of symbols used for rendering the feature. | |
double | tolerance () const |
Returns the tolerance distance for grouping points. | |
const QgsMapUnitScale & | toleranceMapUnitScale () const |
Returns the map unit scale object for the distance tolerance. | |
Qgis::RenderUnit | toleranceUnit () const |
Returns the units for the tolerance distance. | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override |
used from subclasses to create SLD Rule elements following SLD v1.1 specs | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns a list of attributes required by this renderer. | |
bool | willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns whether the renderer will render a feature or not. | |
Public Member Functions inherited from QgsFeatureRenderer | |
virtual | ~QgsFeatureRenderer () |
virtual bool | canSkipRender () |
Returns true if the renderer can be entirely skipped, i.e. | |
virtual QgsFeatureRenderer * | clone () const =0 |
Create a deep copy of this renderer. | |
void | copyRendererData (QgsFeatureRenderer *destRenderer) const |
Clones generic renderer data to another renderer. | |
virtual QList< QgsLayerTreeModelLegendNode * > | createLegendNodes (QgsLayerTreeLayer *nodeLayer) const |
Returns a list of legend nodes to be used for the legend for the renderer. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the renderer's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the renderer's property collection, used for data defined overrides. | |
virtual QString | dump () const |
Returns debug information about this renderer. | |
virtual Qgis::FeatureRendererFlags | flags () const |
Returns flags associated with the renderer. | |
bool | forceRasterRender () const |
Returns whether the renderer must render as a raster. | |
virtual QString | legendClassificationAttribute () const |
If supported by the renderer, return classification attribute for the use in legend. | |
QSet< QString > | legendKeys () const |
Returns the set of all legend keys used by the renderer. | |
virtual void | modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context) |
Allows for a renderer to modify the extent of a feature request prior to rendering. | |
QgsFeatureRequest::OrderBy | orderBy () const |
Gets the order in which features shall be processed by this renderer. | |
bool | orderByEnabled () const |
Returns whether custom ordering will be applied before features are processed by this renderer. | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the renderer. | |
double | referenceScale () const |
Returns the symbology reference scale. | |
virtual QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) |
Stores renderer properties to an XML element. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the renderer's property collection, used for data defined overrides. | |
void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the renderer. | |
void | setForceRasterRender (bool forceRaster) |
Sets whether the renderer should be rendered to a raster destination. | |
void | setOrderBy (const QgsFeatureRequest::OrderBy &orderBy) |
Define the order in which features shall be processed by this renderer. | |
void | setOrderByEnabled (bool enabled) |
Sets whether custom ordering should be applied before features are processed by this renderer. | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the renderer. | |
void | setReferenceScale (double scale) |
Sets the symbology reference scale. | |
void | setUsingSymbolLevels (bool usingSymbolLevels) |
void | setVertexMarkerAppearance (Qgis::VertexMarkerType type, double size) |
Sets type and size of editing vertex markers for subsequent rendering. | |
QString | type () const |
virtual bool | usesEmbeddedSymbols () const |
Returns true if the renderer uses embedded symbols for features. | |
bool | usingSymbolLevels () const |
virtual QDomElement | writeSld (QDomDocument &doc, const QString &styleName, const QVariantMap &props=QVariantMap()) const |
create the SLD UserStyle element following the SLD v1.1 specs with the given name | |
Protected Member Functions | |
void | drawLabels (QPointF centerPoint, QgsSymbolRenderContext &context, const QList< QPointF > &labelShifts, const ClusteredGroup &group) const |
Renders the labels for a group. | |
Protected Member Functions inherited from QgsFeatureRenderer | |
QgsFeatureRenderer (const QString &type) | |
void | renderFeatureWithSymbol (const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker) |
Render the feature with the symbol using context. | |
void | renderVertexMarker (QPointF pt, QgsRenderContext &context) |
render editing vertex marker at specified point | |
void | renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context) |
render editing vertex marker for a polygon | |
void | renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context) |
render editing vertex marker for a polyline | |
void | saveRendererData (QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context) |
Saves generic renderer data into the specified element. | |
Protected Attributes | |
QList< ClusteredGroup > | mClusteredGroups |
Groups of features that are considered clustered together. | |
bool | mDrawLabels |
Whether labels should be drawn for points. This is set internally from startRender() depending on scale denominator. | |
QMap< QgsFeatureId, int > | mGroupIndex |
Mapping of feature ID to the feature's group index. | |
QMap< QgsFeatureId, QgsPointXY > | mGroupLocations |
Mapping of feature ID to approximate group location. | |
QString | mLabelAttributeName |
Attribute name for labeling. An empty string indicates that no labels should be rendered. | |
QColor | mLabelColor |
Label text color. | |
QFont | mLabelFont |
Label font. | |
int | mLabelIndex |
Label attribute index (or -1 if none). This index is not stored, it is requested in the startRender() method. | |
double | mMinLabelScale = 0 |
Maximum scale denominator for label display. A zero value indicates no scale limitation. | |
std::unique_ptr< QgsFeatureRenderer > | mRenderer |
Embedded base renderer. This can be used for rendering individual, isolated points. | |
QgsSpatialIndex * | mSpatialIndex = nullptr |
Spatial index for fast lookup of nearby points. | |
double | mTolerance |
Distance tolerance. Points that are closer together than this distance are considered clustered. | |
QgsMapUnitScale | mToleranceMapUnitScale |
Map unit scale for distance tolerance. | |
Qgis::RenderUnit | mToleranceUnit |
Unit for distance tolerance. | |
Protected Attributes inherited from QgsFeatureRenderer | |
double | mCurrentVertexMarkerSize = 2 |
The current size of editing marker. | |
Qgis::VertexMarkerType | mCurrentVertexMarkerType = Qgis::VertexMarkerType::Cross |
The current type of editing marker. | |
bool | mForceRaster = false |
QgsFeatureRequest::OrderBy | mOrderBy |
bool | mOrderByEnabled = false |
QgsPaintEffect * | mPaintEffect = nullptr |
double | mReferenceScale = -1.0 |
QString | mType |
bool | mUsingSymbolLevels = false |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsFeatureRenderer | |
static QgsFeatureRenderer * | defaultRenderer (Qgis::GeometryType geomType) |
Returns a new renderer - used by default in vector layers. | |
static QgsFeatureRenderer * | load (QDomElement &symbologyElem, const QgsReadWriteContext &context) |
create a renderer from XML element | |
static QgsFeatureRenderer * | loadSld (const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage) |
Create a new renderer according to the information contained in the UserStyle element of a SLD style document. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol property definitions. | |
Static Protected Member Functions inherited from QgsFeatureRenderer | |
static QPointF | _getPoint (QgsRenderContext &context, const QgsPoint &point) |
Creates a point in screen coordinates from a wkb string in map coordinates. | |
static void | convertSymbolRotation (QgsSymbol *symbol, const QString &field) |
static void | convertSymbolSizeScale (QgsSymbol *symbol, Qgis::ScaleMethod method, const QString &field) |
An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers).
QgsPointDistanceRenderer handles calculation of point clusters using a distance based threshold. Subclasses must implement drawGroup() to handle the rendering of individual point clusters in the desired style.
Definition at line 41 of file qgspointdistancerenderer.h.
A group of clustered points (ie features within the distance tolerance).
Definition at line 76 of file qgspointdistancerenderer.h.
QgsPointDistanceRenderer::QgsPointDistanceRenderer | ( | const QString & | rendererName, |
const QString & | labelAttributeName = QString() |
||
) |
Constructor for QgsPointDistanceRenderer.
rendererName | name of renderer for registry |
labelAttributeName | optional attribute for labeling points |
Definition at line 33 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.
Returns true
if the visitor should continue visiting other objects, or false
if visiting should be canceled.
Reimplemented from QgsFeatureRenderer.
Definition at line 218 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns details about internals of this renderer.
E.g. if you only want to deal with visible features:
Reimplemented from QgsFeatureRenderer.
Definition at line 246 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Sets whether the legend symbology item with the specified ley should be checked.
Reimplemented from QgsFeatureRenderer.
Definition at line 202 of file qgspointdistancerenderer.cpp.
|
protected |
Renders the labels for a group.
centerPoint | center point of group |
context | destination render context |
labelShifts | displacement for individual label positions |
group | group of clustered features to label |
Definition at line 417 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns the current embedded renderer (subrenderer) for this feature renderer.
The base class implementation does not use subrenderers and will always return nullptr
.
Reimplemented from QgsFeatureRenderer.
Definition at line 173 of file qgspointdistancerenderer.cpp.
If a renderer does not require all the features this method may be overridden and return an expression used as where clause.
This will be called once after startRender() and before the first call to renderFeature(). By default this returns a null string and all features will be requested. You do not need to specify the extent in here, this is taken care of separately and will be combined with a filter returned from this method.
Reimplemented from QgsFeatureRenderer.
Definition at line 210 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns true
if this renderer requires the geometry to apply the filter.
Reimplemented from QgsFeatureRenderer.
Definition at line 241 of file qgspointdistancerenderer.cpp.
|
inline |
Returns the attribute name used for labeling points, or an empty string if no labeling will be done by the renderer.
Definition at line 128 of file qgspointdistancerenderer.h.
|
inline |
Returns the color used for for labeling points.
Definition at line 178 of file qgspointdistancerenderer.h.
|
inline |
Returns the font used for labeling points.
Definition at line 145 of file qgspointdistancerenderer.h.
|
overridevirtual |
Returns legend keys matching a specified feature.
Reimplemented from QgsFeatureRenderer.
Definition at line 296 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key.
key | legend key |
layer | associated vector layer |
ok | will be set to true if legend key was successfully converted to a filter expression |
Reimplemented from QgsFeatureRenderer.
Definition at line 303 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns true
if the legend symbology item with the specified key is checked.
Reimplemented from QgsFeatureRenderer.
Definition at line 194 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns a list of symbology items for the legend.
Reimplemented from QgsFeatureRenderer.
Definition at line 375 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns true
if symbology items in legend are checkable.
Reimplemented from QgsFeatureRenderer.
Definition at line 186 of file qgspointdistancerenderer.cpp.
|
inline |
Returns the minimum map scale (i.e.
most "zoomed out") at which points should be labeled by the renderer. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
Definition at line 161 of file qgspointdistancerenderer.h.
|
overridevirtual |
Returns symbol for feature.
The difference compared to symbolForFeature() is that it returns original symbol which can be used as an identifier for renderer's rule - the former may return a temporary replacement of a symbol for use in rendering.
Reimplemented from QgsFeatureRenderer.
Definition at line 273 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()
Reimplemented from QgsFeatureRenderer.
Definition at line 289 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Render a feature using this renderer in the given context.
Must be called between startRender() and stopRender() calls. Default implementation renders a symbol as determined by symbolForFeature() call. Returns true
if the feature has been returned (this is used for example to determine whether the feature may be labelled).
If layer is not -1, the renderer should draw only a particular layer from symbols (in order to support symbol level rendering).
Reimplemented from QgsFeatureRenderer.
Definition at line 51 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Sets an embedded renderer (subrenderer) for this feature renderer.
The base class implementation does nothing with subrenderers, but individual derived classes can use these to modify their behavior.
subRenderer | the embedded renderer. Ownership will be transferred. |
Reimplemented from QgsFeatureRenderer.
Definition at line 168 of file qgspointdistancerenderer.cpp.
|
inline |
Sets the attribute name for labeling points.
name | attribute name, or empty string to avoid labeling features by the renderer |
Definition at line 118 of file qgspointdistancerenderer.h.
|
inline |
Sets the color to use for for labeling points.
color | label color |
Definition at line 170 of file qgspointdistancerenderer.h.
|
inline |
Sets the font used for labeling points.
font | label font |
Definition at line 137 of file qgspointdistancerenderer.h.
|
overridevirtual |
Sets the symbol to be used for a legend symbol item.
key | rule key for legend symbol |
symbol | new symbol for legend item. Ownership is transferred to renderer. |
Reimplemented from QgsFeatureRenderer.
Definition at line 178 of file qgspointdistancerenderer.cpp.
|
inline |
Sets the minimum map scale (i.e.
most "zoomed out") at which points should be labeled by the renderer. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
Definition at line 153 of file qgspointdistancerenderer.h.
|
inline |
Sets the tolerance distance for grouping points.
Units are specified using setToleranceUnit().
distance | tolerance distance |
Definition at line 187 of file qgspointdistancerenderer.h.
|
inline |
Sets the map unit scale object for the distance tolerance.
This is only used if the toleranceUnit() is set to QgsUnitTypes::RenderMapUnits.
scale | scale for distance tolerance |
Definition at line 219 of file qgspointdistancerenderer.h.
|
inline |
Sets the units for the tolerance distance.
unit | tolerance distance units |
Definition at line 203 of file qgspointdistancerenderer.h.
|
overridevirtual |
Must be called when a new render cycle is started.
A call to startRender() must always be followed by a corresponding call to stopRender() after all features have been rendered.
context | Additional information passed to the renderer about the job which will be rendered |
fields | The fields available for rendering |
Reimplemented from QgsFeatureRenderer.
Definition at line 321 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Must be called when a render cycle has finished, to allow the renderer to clean up.
Calls to stopRender() must always be preceded by a call to startRender().
Reimplemented from QgsFeatureRenderer.
Definition at line 351 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
To be overridden.
Must be called between startRender() and stopRender() calls.
feature | feature |
context | render context |
Implements QgsFeatureRenderer.
Definition at line 264 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns list of symbols used by the renderer.
context | render context |
Reimplemented from QgsFeatureRenderer.
Definition at line 255 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns list of symbols used for rendering the feature.
For renderers that do not support MoreSymbolsPerFeature it is more efficient to use symbolForFeature()
Reimplemented from QgsFeatureRenderer.
Definition at line 280 of file qgspointdistancerenderer.cpp.
|
inline |
Returns the tolerance distance for grouping points.
Units are retrieved using toleranceUnit().
Definition at line 195 of file qgspointdistancerenderer.h.
|
inline |
Returns the map unit scale object for the distance tolerance.
This is only used if the toleranceUnit() is set to QgsUnitTypes::RenderMapUnits.
Definition at line 227 of file qgspointdistancerenderer.h.
|
inline |
Returns the units for the tolerance distance.
Definition at line 210 of file qgspointdistancerenderer.h.
|
overridevirtual |
used from subclasses to create SLD Rule elements following SLD v1.1 specs
Reimplemented from QgsFeatureRenderer.
Definition at line 45 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns a list of attributes required by this renderer.
Attributes not listed in here may not have been requested from the provider at rendering time.
Implements QgsFeatureRenderer.
Definition at line 227 of file qgspointdistancerenderer.cpp.
|
overridevirtual |
Returns whether the renderer will render a feature or not.
Must be called between startRender() and stopRender() calls. Default implementation uses symbolForFeature().
Reimplemented from QgsFeatureRenderer.
Definition at line 311 of file qgspointdistancerenderer.cpp.
|
protected |
Groups of features that are considered clustered together.
Definition at line 257 of file qgspointdistancerenderer.h.
|
protected |
Whether labels should be drawn for points. This is set internally from startRender() depending on scale denominator.
Definition at line 252 of file qgspointdistancerenderer.h.
|
protected |
Mapping of feature ID to the feature's group index.
Definition at line 260 of file qgspointdistancerenderer.h.
|
protected |
Mapping of feature ID to approximate group location.
Definition at line 263 of file qgspointdistancerenderer.h.
|
protected |
Attribute name for labeling. An empty string indicates that no labels should be rendered.
Definition at line 235 of file qgspointdistancerenderer.h.
|
protected |
Label text color.
Definition at line 250 of file qgspointdistancerenderer.h.
|
protected |
Label font.
Definition at line 248 of file qgspointdistancerenderer.h.
|
protected |
Label attribute index (or -1 if none). This index is not stored, it is requested in the startRender() method.
Definition at line 238 of file qgspointdistancerenderer.h.
|
protected |
Maximum scale denominator for label display. A zero value indicates no scale limitation.
Definition at line 254 of file qgspointdistancerenderer.h.
|
protected |
Embedded base renderer. This can be used for rendering individual, isolated points.
Definition at line 232 of file qgspointdistancerenderer.h.
|
protected |
Spatial index for fast lookup of nearby points.
Definition at line 266 of file qgspointdistancerenderer.h.
|
protected |
Distance tolerance. Points that are closer together than this distance are considered clustered.
Definition at line 241 of file qgspointdistancerenderer.h.
|
protected |
Map unit scale for distance tolerance.
Definition at line 245 of file qgspointdistancerenderer.h.
|
protected |
Unit for distance tolerance.
Definition at line 243 of file qgspointdistancerenderer.h.