QGIS API Documentation  2.99.0-Master (e077efd)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsPointDisplacementRenderer Class Reference

A renderer that automatically displaces points with the same geographic location. More...

#include <qgspointdisplacementrenderer.h>

Inheritance diagram for QgsPointDisplacementRenderer:
Inheritance graph
[legend]

Public Types

enum  Placement { Ring, ConcentricRings }
 Placement methods for dispersing points. More...
 
- Public Types inherited from QgsPointDistanceRenderer
typedef QList< GroupedFeatureClusteredGroup
 A group of clustered points (ie features within the distance tolerance). More...
 
- Public Types inherited from QgsFeatureRenderer
enum  Capability { SymbolLevels = 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 }
 Used to specify details about a renderer. More...
 

Public Member Functions

 QgsPointDisplacementRenderer (const QString &labelAttributeName=QString())
 Constructor for QgsPointDisplacementRenderer. More...
 
QgsMarkerSymbolcenterSymbol ()
 Returns the symbol for the center of a displacement group (but not ownership of the symbol). More...
 
QColor circleColor () const
 Returns the color used for drawing the displacement group circle. More...
 
double circleRadiusAddition () const
 Returns the factor for increasing the ring size of displacement groups. More...
 
double circleWidth () const
 Returns the line width for the displacement group circle in mm. More...
 
QgsPointDisplacementRendererclone () const override
 Create a deep copy of this renderer. More...
 
Placement placement () const
 Returns the placement method used for dispersing the points. More...
 
QDomElement save (QDomDocument &doc) override
 store renderer info to XML element More...
 
void setCenterSymbol (QgsMarkerSymbol *symbol)
 Sets the center symbol for a displacement group. More...
 
void setCircleColor (const QColor &color)
 Sets the color used for drawing the displacement group circle. More...
 
void setCircleRadiusAddition (double distance)
 Sets a factor for increasing the ring size of displacement groups. More...
 
void setCircleWidth (double width)
 Sets the line width for the displacement group circle. More...
 
void setPlacement (Placement placement)
 Sets the placement method used for dispersing the points. More...
 
virtual void startRender (QgsRenderContext &context, const QgsFields &fields) override
 Needs to be called when a new render cycle is started. More...
 
void stopRender (QgsRenderContext &context) override
 Needs to be called when a render cycle has finished to clean up. More...
 
virtual QSet< QString > usedAttributes () const override
 Return a list of attributes required by this renderer. More...
 
- Public Member Functions inherited from QgsPointDistanceRenderer
 QgsPointDistanceRenderer (const QString &rendererName, const QString &labelAttributeName=QString())
 Constructor for QgsPointDistanceRenderer. More...
 
virtual Capabilities capabilities () override
 Returns details about internals of this renderer. More...
 
void checkLegendSymbolItem (const QString &key, bool state) override
 item in symbology was checked More...
 
const QgsFeatureRendererembeddedRenderer () const override
 Returns the current embedded renderer (subrenderer) for this feature renderer. More...
 
virtual 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. More...
 
QString labelAttributeName () const
 Returns the attribute name used for labeling points, or an empty string if no labeling will be done by the renderer. More...
 
QColor labelColor () const
 Returns the color used for for labeling points. More...
 
QFont labelFont () const
 Returns the font used for labeling points. More...
 
virtual QSet< QString > legendKeysForFeature (QgsFeature &feature, QgsRenderContext &context) override
 Return legend keys matching a specified feature. More...
 
bool legendSymbolItemChecked (const QString &key) override
 items of symbology items in legend is checked More...
 
QgsLegendSymbolList legendSymbolItems (double scaleDenominator=-1, const QString &rule="") override
 return a list of item text / symbol More...
 
bool legendSymbolItemsCheckable () const override
 items of symbology items in legend should be checkable More...
 
QgsLegendSymbologyList legendSymbologyItems (QSize iconSize) override
 return a list of symbology items for the legend More...
 
double maxLabelScaleDenominator () const
 Returns the denominator for the maximum scale at which points should be labeled by the renderer. More...
 
virtual QgsSymboloriginalSymbolForFeature (QgsFeature &feat, QgsRenderContext &context) override
 Return symbol for feature. More...
 
virtual QgsSymbolList originalSymbolsForFeature (QgsFeature &feat, QgsRenderContext &context) override
 Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More...
 
bool renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override
 Render a feature using this renderer in the given context. More...
 
void setEmbeddedRenderer (QgsFeatureRenderer *r) override
 Sets an embedded renderer (subrenderer) for this feature renderer. More...
 
void setLabelAttributeName (const QString &name)
 Sets the attribute name for labeling points. More...
 
void setLabelColor (const QColor &color)
 Sets the color to use for for labeling points. More...
 
void setLabelFont (const QFont &font)
 Sets the font used for labeling points. More...
 
void setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override
 Sets the symbol to be used for a legend symbol item. More...
 
void setMaxLabelScaleDenominator (double denominator)
 Sets the maximum scale at which points should be labeled by the renderer. More...
 
void setTolerance (double distance)
 Sets the tolerance distance for grouping points. More...
 
void setToleranceMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale object for the distance tolerance. More...
 
void setToleranceUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the tolerance distance. More...
 
void stopRender (QgsRenderContext &context) override
 Needs to be called when a render cycle has finished to clean up. More...
 
virtual QgsSymbolsymbolForFeature (QgsFeature &feature, QgsRenderContext &context) override
 To be overridden. More...
 
virtual QgsSymbolList symbols (QgsRenderContext &context) override
 Returns list of symbols used by the renderer. More...
 
virtual QgsSymbolList symbolsForFeature (QgsFeature &feat, QgsRenderContext &context) override
 Returns list of symbols used for rendering the feature. More...
 
double tolerance () const
 Returns the tolerance distance for grouping points. More...
 
const QgsMapUnitScaletoleranceMapUnitScale () const
 Returns the map unit scale object for the distance tolerance. More...
 
QgsUnitTypes::RenderUnit toleranceUnit () const
 Returns the units for the tolerance distance. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const override
 used from subclasses to create SLD Rule elements following SLD v1.1 specs More...
 
virtual bool willRenderFeature (QgsFeature &feat, QgsRenderContext &context) override
 Returns whether the renderer will render a feature or not. More...
 
- Public Member Functions inherited from QgsFeatureRenderer
virtual ~QgsFeatureRenderer ()
 
virtual QString dump () const
 Returns debug information about this renderer. More...
 
virtual bool filterNeedsGeometry () const
 Returns true if this renderer requires the geometry to apply the filter. More...
 
bool forceRasterRender () const
 Returns whether the renderer must render as a raster. More...
 
virtual QString legendClassificationAttribute () const
 If supported by the renderer, return classification attribute for the use in legend. More...
 
virtual QgsLegendSymbolListV2 legendSymbolItemsV2 () const
 Return a list of symbology items for the legend. More...
 
virtual void modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context)
 Allows for a renderer to modify the extent of a feature request prior to rendering. More...
 
QgsFeatureRequest::OrderBy orderBy () const
 Get the order in which features shall be processed by this renderer. More...
 
bool orderByEnabled () const
 Returns whether custom ordering will be applied before features are processed by this renderer. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the renderer. More...
 
void setForceRasterRender (bool forceRaster)
 Sets whether the renderer should be rendered to a raster destination. More...
 
void setOrderBy (const QgsFeatureRequest::OrderBy &orderBy)
 Define the order in which features shall be processed by this renderer. More...
 
void setOrderByEnabled (bool enabled)
 Sets whether custom ordering should be applied before features are processed by this renderer. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the renderer. More...
 
void setUsingSymbolLevels (bool usingSymbolLevels)
 
void setVertexMarkerAppearance (int type, int size)
 set type and size of editing vertex markers for subsequent rendering More...
 
QString type () const
 
bool usingSymbolLevels () const
 
virtual QDomElement writeSld (QDomDocument &doc, const QString &styleName, const QgsStringMap &props=QgsStringMap()) const
 create the SLD UserStyle element following the SLD v1.1 specs with the given name More...
 

Static Public Member Functions

static QgsPointDisplacementRendererconvertFromRenderer (const QgsFeatureRenderer *renderer)
 Creates a QgsPointDisplacementRenderer from an existing renderer. More...
 
static QgsFeatureRenderercreate (QDomElement &symbologyElem)
 Create a renderer from XML element. More...
 
- Static Public Member Functions inherited from QgsFeatureRenderer
static QgsFeatureRendererdefaultRenderer (QgsWkbTypes::GeometryType geomType)
 return a new renderer - used by default in vector layers More...
 
static QgsFeatureRendererload (QDomElement &symbologyElem)
 create a renderer from XML element More...
 
static QgsFeatureRendererloadSld (const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage)
 Create a new renderer according to the information contained in the UserStyle element of a SLD style document. More...
 

Additional Inherited Members

- Protected Member Functions inherited from QgsPointDistanceRenderer
void drawLabels (QPointF centerPoint, QgsSymbolRenderContext &context, const QList< QPointF > &labelShifts, const ClusteredGroup &group)
 Renders the labels for a group. More...
 
- Protected Member Functions inherited from QgsFeatureRenderer
 QgsFeatureRenderer (const QString &type)
 
void copyRendererData (QgsFeatureRenderer *destRenderer) const
 Clones generic renderer data to another renderer. More...
 
void renderFeatureWithSymbol (QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker)
 
void renderVertexMarker (QPointF pt, QgsRenderContext &context)
 render editing vertex marker at specified point More...
 
void renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context)
 render editing vertex marker for a polygon More...
 
void renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context)
 render editing vertex marker for a polyline More...
 
- Static Protected Member Functions inherited from QgsFeatureRenderer
static QPointF _getPoint (QgsRenderContext &context, const QgsPointV2 &point)
 Creates a point in screen coordinates from a wkb string in map coordinates. More...
 
static void convertSymbolRotation (QgsSymbol *symbol, const QString &field)
 
static void convertSymbolSizeScale (QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field)
 
- Protected Attributes inherited from QgsPointDistanceRenderer
QList< ClusteredGroupmClusteredGroups
 Groups of features that are considered clustered together. More...
 
bool mDrawLabels
 Whether labels should be drawn for points. This is set internally from startRender() depending on scale denominator. More...
 
QMap< QgsFeatureId, int > mGroupIndex
 Mapping of feature ID to the feature's group index. More...
 
QMap< QgsFeatureId, QgsPointmGroupLocations
 Mapping of feature ID to approximate group location. More...
 
QString mLabelAttributeName
 Attribute name for labeling. An empty string indicates that no labels should be rendered. More...
 
QColor mLabelColor
 Label text color. More...
 
QFont mLabelFont
 Label font. More...
 
int mLabelIndex
 Label attribute index (or -1 if none). This index is not stored, it is requested in the startRender() method. More...
 
double mMaxLabelScaleDenominator
 Maximum scale denominator for label display. A negative number indicatese no scale limitation. More...
 
QScopedPointer< QgsFeatureRenderermRenderer
 Embedded base renderer. This can be used for rendering individual, isolated points. More...
 
QgsSpatialIndexmSpatialIndex
 Spatial index for fast lookup of nearby points. More...
 
double mTolerance
 Distance tolerance. Points that are closer together than this distance are considered clustered. More...
 
QgsMapUnitScale mToleranceMapUnitScale
 Map unit scale for distance tolerance. More...
 
QgsUnitTypes::RenderUnit mToleranceUnit
 Unit for distance tolerance. More...
 
- Protected Attributes inherited from QgsFeatureRenderer
int mCurrentVertexMarkerSize
 The current size of editing marker. More...
 
int mCurrentVertexMarkerType
 The current type of editing marker. More...
 
bool mForceRaster
 
QgsFeatureRequest::OrderBy mOrderBy
 
bool mOrderByEnabled
 
QgsPaintEffectmPaintEffect
 
QString mType
 
bool mUsingSymbolLevels
 

Detailed Description

A renderer that automatically displaces points with the same geographic location.

Definition at line 27 of file qgspointdisplacementrenderer.h.

Member Enumeration Documentation

§ Placement

Placement methods for dispersing points.

Enumerator
Ring 

Place points in a single ring around group.

ConcentricRings 

Place points in concentric rings around group.

Definition at line 33 of file qgspointdisplacementrenderer.h.

Constructor & Destructor Documentation

§ QgsPointDisplacementRenderer()

QgsPointDisplacementRenderer::QgsPointDisplacementRenderer ( const QString &  labelAttributeName = QString())

Constructor for QgsPointDisplacementRenderer.

Parameters
labelAttributeNameoptional attribute name for labeling points

Definition at line 32 of file qgspointdisplacementrenderer.cpp.

Member Function Documentation

§ centerSymbol()

QgsMarkerSymbol * QgsPointDisplacementRenderer::centerSymbol ( )

Returns the symbol for the center of a displacement group (but not ownership of the symbol).

See also
setCenterSymbol()

Definition at line 171 of file qgspointdisplacementrenderer.cpp.

§ circleColor()

QColor QgsPointDisplacementRenderer::circleColor ( ) const
inline

Returns the color used for drawing the displacement group circle.

See also
setCircleColor()
circleWidth()

Definition at line 77 of file qgspointdisplacementrenderer.h.

§ circleRadiusAddition()

double QgsPointDisplacementRenderer::circleRadiusAddition ( ) const
inline

Returns the factor for increasing the ring size of displacement groups.

See also
setCircleRadiusAddition()

Definition at line 88 of file qgspointdisplacementrenderer.h.

§ circleWidth()

double QgsPointDisplacementRenderer::circleWidth ( ) const
inline

Returns the line width for the displacement group circle in mm.

See also
setCircleWidth()
circleColor()

Definition at line 64 of file qgspointdisplacementrenderer.h.

§ clone()

QgsPointDisplacementRenderer * QgsPointDisplacementRenderer::clone ( ) const
overridevirtual

Create a deep copy of this renderer.

Should be implemented by all subclasses and generate a proper subclass.

Returns
A copy of this renderer

Implements QgsFeatureRenderer.

Definition at line 42 of file qgspointdisplacementrenderer.cpp.

§ convertFromRenderer()

QgsPointDisplacementRenderer * QgsPointDisplacementRenderer::convertFromRenderer ( const QgsFeatureRenderer renderer)
static

Creates a QgsPointDisplacementRenderer from an existing renderer.

Note
added in 2.5
Returns
a new renderer if the conversion was possible, otherwise nullptr.

Definition at line 338 of file qgspointdisplacementrenderer.cpp.

§ create()

QgsFeatureRenderer * QgsPointDisplacementRenderer::create ( QDomElement &  symbologyElem)
static

Create a renderer from XML element.

Definition at line 135 of file qgspointdisplacementrenderer.cpp.

§ placement()

Placement QgsPointDisplacementRenderer::placement ( ) const
inline

Returns the placement method used for dispersing the points.

See also
setPlacement()
Note
added in QGIS 2.12

Definition at line 94 of file qgspointdisplacementrenderer.h.

§ save()

QDomElement QgsPointDisplacementRenderer::save ( QDomDocument &  doc)
overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRenderer.

Definition at line 176 of file qgspointdisplacementrenderer.cpp.

§ setCenterSymbol()

void QgsPointDisplacementRenderer::setCenterSymbol ( QgsMarkerSymbol symbol)

Sets the center symbol for a displacement group.

Parameters
symbolnew center symbol. Ownership is transferred to the renderer.
See also
centerSymbol()

Definition at line 226 of file qgspointdisplacementrenderer.cpp.

§ setCircleColor()

void QgsPointDisplacementRenderer::setCircleColor ( const QColor &  color)
inline

Sets the color used for drawing the displacement group circle.

Parameters
colorcircle color
See also
circleColor()
setCircleWidth()

Definition at line 71 of file qgspointdisplacementrenderer.h.

§ setCircleRadiusAddition()

void QgsPointDisplacementRenderer::setCircleRadiusAddition ( double  distance)
inline

Sets a factor for increasing the ring size of displacement groups.

Parameters
distanceaddition factor
See also
circleRadiusAddition()

Definition at line 83 of file qgspointdisplacementrenderer.h.

§ setCircleWidth()

void QgsPointDisplacementRenderer::setCircleWidth ( double  width)
inline

Sets the line width for the displacement group circle.

Parameters
widthline width in mm
See also
circleWidth()
setCircleColor()

Definition at line 58 of file qgspointdisplacementrenderer.h.

§ setPlacement()

void QgsPointDisplacementRenderer::setPlacement ( Placement  placement)
inline

Sets the placement method used for dispersing the points.

Parameters
placementplacement method
See also
placement()
Note
added in QGIS 2.12

Definition at line 101 of file qgspointdisplacementrenderer.h.

§ startRender()

void QgsPointDisplacementRenderer::startRender ( QgsRenderContext context,
const QgsFields fields 
)
overridevirtual

Needs to be called when a new render cycle is started.

Parameters
contextAdditional information passed to the renderer about the job which will be rendered
fieldsThe fields available for rendering
Returns
Information passed back from the renderer that can e.g. be used to reduce the amount of requested features

Reimplemented from QgsPointDistanceRenderer.

Definition at line 116 of file qgspointdisplacementrenderer.cpp.

§ stopRender()

void QgsPointDisplacementRenderer::stopRender ( QgsRenderContext context)
overridevirtual

Needs to be called when a render cycle has finished to clean up.

Implements QgsFeatureRenderer.

Definition at line 126 of file qgspointdisplacementrenderer.cpp.

§ usedAttributes()

QSet< QString > QgsPointDisplacementRenderer::usedAttributes ( ) const
overridevirtual

Return a list of attributes required by this renderer.

Attributes not listed in here may not have been requested from the provider at rendering time.

Returns
A set of attributes

Reimplemented from QgsPointDistanceRenderer.

Definition at line 218 of file qgspointdisplacementrenderer.cpp.


The documentation for this class was generated from the following files: