QGIS API Documentation
2.10.1-Pisa
|
A renderer which draws points as a live heatmap. More...
#include <qgsheatmaprenderer.h>
Public Member Functions | |
QgsHeatmapRenderer () | |
virtual | ~QgsHeatmapRenderer () |
virtual QgsFeatureRendererV2 * | clone () const override |
QgsVectorColorRampV2 * | colorRamp () const |
Returns the color ramp used for shading the heatmap. More... | |
virtual QString | dump () const override |
for debugging More... | |
double | invertRamp () const |
Returns whether the ramp is inverted. More... | |
double | maximumValue () const |
Returns the maximum value used for shading the heatmap. More... | |
virtual void | modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context) override |
Allows for a renderer to modify the extent of a feature request prior to rendering. More... | |
double | radius () const |
Returns the radius for the heatmap. More... | |
const QgsMapUnitScale & | radiusMapUnitScale () const |
Returns the map unit scale used for the heatmap's radius. More... | |
QgsSymbolV2::OutputUnit | radiusUnit () const |
Returns the units used for the heatmap's radius. More... | |
virtual bool | renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override |
double | renderQuality () const |
Returns the render quality used for drawing the heatmap. More... | |
virtual QDomElement | save (QDomDocument &doc) override |
store renderer info to XML element More... | |
void | setColorRamp (QgsVectorColorRampV2 *ramp) |
Sets the color ramp to use for shading the heatmap. More... | |
void | setInvertRamp (const bool invert) |
Sets whether the ramp is inverted. More... | |
void | setMaximumValue (const double value) |
Sets the maximum value used for shading the heatmap. More... | |
void | setRadius (const double radius) |
Sets the radius for the heatmap. More... | |
void | setRadiusMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for the heatmap's radius. More... | |
void | setRadiusUnit (const QgsSymbolV2::OutputUnit unit) |
Sets the units used for the heatmap's radius. More... | |
void | setRenderQuality (const int quality) |
Sets the render quality used for drawing the heatmap. More... | |
void | setWeightExpression (const QString &expression) |
Sets the expression used for weighting points when generating the heatmap. More... | |
virtual void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
virtual void | stopRender (QgsRenderContext &context) override |
virtual QgsSymbolV2 * | symbolForFeature (QgsFeature &feature) override |
to be overridden More... | |
virtual QgsSymbolV2List | symbols () override |
for symbol levels More... | |
virtual QList< QString > | usedAttributes () override |
QString | weightExpression () const |
Returns the expression used for weighting points when generating the heatmap. More... | |
Public Member Functions inherited from QgsFeatureRendererV2 | |
virtual | ~QgsFeatureRendererV2 () |
virtual int | capabilities () |
returns bitwise OR-ed capabilities of the renderer More... | |
virtual void | checkLegendSymbolItem (QString key, bool state=true) |
item in symbology was checked More... | |
virtual QString | legendClassificationAttribute () const |
If supported by the renderer, return classification attribute for the use in legend. More... | |
virtual bool | legendSymbolItemChecked (QString key) |
items of symbology items in legend is checked More... | |
virtual QgsLegendSymbolList | legendSymbolItems (double scaleDenominator=-1, QString rule="") |
return a list of item text / symbol More... | |
virtual bool | legendSymbolItemsCheckable () const |
items of symbology items in legend should be checkable More... | |
virtual QgsLegendSymbolListV2 | legendSymbolItemsV2 () const |
Return a list of symbology items for the legend. More... | |
virtual QgsLegendSymbologyList | legendSymbologyItems (QSize iconSize) |
return a list of symbology items for the legend More... | |
virtual QgsSymbolV2 * | originalSymbolForFeature (QgsFeature &feature) |
Return symbol for feature. More... | |
virtual QgsSymbolV2List | originalSymbolsForFeature (QgsFeature &feat) |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the renderer. More... | |
virtual QString | rotationField () const |
return rotation field name (or empty string if not set or not supported by renderer) More... | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the renderer. More... | |
virtual void | setRotationField (QString fieldName) |
sets rotation field of renderer (if supported by 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... | |
virtual Q_DECL_DEPRECATED void | startRender (QgsRenderContext &context, const QgsVectorLayer *vlayer) |
virtual QgsSymbolV2List | symbolsForFeature (QgsFeature &feat) |
return list of symbols used for rendering the feature. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element) const |
used from subclasses to create SLD Rule elements following SLD v1.1 specs More... | |
QString | type () const |
bool | usingSymbolLevels () const |
virtual bool | willRenderFeature (QgsFeature &feat) |
return whether the renderer will render a feature or not. More... | |
virtual Q_DECL_DEPRECATED QDomElement | writeSld (QDomDocument &doc, const QgsVectorLayer &layer) const |
create the SLD UserStyle element following the SLD v1.1 specs More... | |
virtual QDomElement | writeSld (QDomDocument &doc, const QString &styleName) const |
create the SLD UserStyle element following the SLD v1.1 specs with the given name More... | |
Static Public Member Functions | |
static QgsHeatmapRenderer * | convertFromRenderer (const QgsFeatureRendererV2 *renderer) |
static QgsFeatureRendererV2 * | create (QDomElement &element) |
Static Public Member Functions inherited from QgsFeatureRendererV2 | |
static QgsFeatureRendererV2 * | defaultRenderer (QGis::GeometryType geomType) |
return a new renderer - used by default in vector layers More... | |
static QgsFeatureRendererV2 * | load (QDomElement &symbologyElem) |
create a renderer from XML element More... | |
static QgsFeatureRendererV2 * | 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 More... | |
Additional Inherited Members | |
Public Types inherited from QgsFeatureRendererV2 | |
enum | Capabilities { SymbolLevels = 1, RotationField = 1 << 1, MoreSymbolsPerFeature = 1 << 2, Filter = 1 << 3, ScaleDependent = 1 << 4 } |
Protected Member Functions inherited from QgsFeatureRendererV2 | |
QgsFeatureRendererV2 (QString type) | |
void | copyPaintEffect (QgsFeatureRendererV2 *destRenderer) const |
Copies paint effect of this renderer to another renderer. More... | |
void | renderFeatureWithSymbol (QgsFeature &feature, QgsSymbolV2 *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... | |
void | setScaleMethodToSymbol (QgsSymbolV2 *symbol, int scaleMethod) |
Static Protected Member Functions inherited from QgsFeatureRendererV2 | |
static const unsigned char * | _getLineString (QPolygonF &pts, QgsRenderContext &context, const unsigned char *wkb, bool clipToExtent=true) |
static const unsigned char * | _getPoint (QPointF &pt, QgsRenderContext &context, const unsigned char *wkb) |
static const unsigned char * | _getPolygon (QPolygonF &pts, QList< QPolygonF > &holes, QgsRenderContext &context, const unsigned char *wkb, bool clipToExtent=true) |
static void | convertSymbolRotation (QgsSymbolV2 *symbol, const QString &field) |
static void | convertSymbolSizeScale (QgsSymbolV2 *symbol, QgsSymbolV2::ScaleMethod method, const QString &field) |
Protected Attributes inherited from QgsFeatureRendererV2 | |
int | mCurrentVertexMarkerSize |
The current size of editing marker. More... | |
int | mCurrentVertexMarkerType |
The current type of editing marker. More... | |
QgsPaintEffect * | mPaintEffect |
QString | mType |
bool | mUsingSymbolLevels |
A renderer which draws points as a live heatmap.
Definition at line 33 of file qgsheatmaprenderer.h.
QgsHeatmapRenderer::QgsHeatmapRenderer | ( | ) |
Definition at line 33 of file qgsheatmaprenderer.cpp.
|
virtual |
Definition at line 51 of file qgsheatmaprenderer.cpp.
|
overridevirtual |
Implements QgsFeatureRendererV2.
Definition at line 284 of file qgsheatmaprenderer.cpp.
|
inline |
Returns the color ramp used for shading the heatmap.
Definition at line 63 of file qgsheatmaprenderer.h.
|
static |
Definition at line 397 of file qgsheatmaprenderer.cpp.
|
static |
Definition at line 327 of file qgsheatmaprenderer.cpp.
|
overridevirtual |
for debugging
Reimplemented from QgsFeatureRendererV2.
Definition at line 279 of file qgsheatmaprenderer.cpp.
|
inline |
Returns whether the ramp is inverted.
Definition at line 75 of file qgsheatmaprenderer.h.
|
inline |
Returns the maximum value used for shading the heatmap.
Definition at line 133 of file qgsheatmaprenderer.h.
|
overridevirtual |
Allows for a renderer to modify the extent of a feature request prior to rendering.
extent | reference to request's filter extent. Modify extent to change the extent of feature request |
context | render context |
Reimplemented from QgsFeatureRendererV2.
Definition at line 303 of file qgsheatmaprenderer.cpp.
|
inline |
Returns the radius for the heatmap.
Definition at line 89 of file qgsheatmaprenderer.h.
|
inline |
Returns the map unit scale used for the heatmap's radius.
Definition at line 119 of file qgsheatmaprenderer.h.
|
inline |
Returns the units used for the heatmap's radius.
Definition at line 104 of file qgsheatmaprenderer.h.
|
overridevirtual |
Reimplemented from QgsFeatureRendererV2.
Definition at line 100 of file qgsheatmaprenderer.cpp.
|
inline |
Returns the render quality used for drawing the heatmap.
Definition at line 146 of file qgsheatmaprenderer.h.
|
overridevirtual |
store renderer info to XML element
Reimplemented from QgsFeatureRendererV2.
Definition at line 346 of file qgsheatmaprenderer.cpp.
void QgsHeatmapRenderer::setColorRamp | ( | QgsVectorColorRampV2 * | ramp | ) |
Sets the color ramp to use for shading the heatmap.
ramp | color ramp for heatmap. Ownership of ramp is transferred to the renderer. |
Definition at line 409 of file qgsheatmaprenderer.cpp.
|
inline |
Sets whether the ramp is inverted.
invert | set to true to invert color ramp |
Definition at line 81 of file qgsheatmaprenderer.h.
|
inline |
Sets the maximum value used for shading the heatmap.
value | maximum value for heatmap shading. Set to 0 for automatic calculation of maximum value. |
Definition at line 139 of file qgsheatmaprenderer.h.
|
inline |
Sets the radius for the heatmap.
radius | heatmap radius |
Definition at line 96 of file qgsheatmaprenderer.h.
|
inline |
Sets the map unit scale used for the heatmap's radius.
scale | map unit scale for heatmap's radius |
Definition at line 126 of file qgsheatmaprenderer.h.
|
inline |
Sets the units used for the heatmap's radius.
unit | units for heatmap radius |
Definition at line 111 of file qgsheatmaprenderer.h.
|
inline |
Sets the render quality used for drawing the heatmap.
quality | render quality. A value of 1 indicates maximum quality, and increasing the value will result in faster drawing but lower quality rendering. |
Definition at line 152 of file qgsheatmaprenderer.h.
|
inline |
Sets the expression used for weighting points when generating the heatmap.
expression | point weight expression. If set to empty, all points are equally weighted. |
Definition at line 164 of file qgsheatmaprenderer.h.
|
overridevirtual |
Implements QgsFeatureRendererV2.
Definition at line 66 of file qgsheatmaprenderer.cpp.
|
overridevirtual |
Implements QgsFeatureRendererV2.
Definition at line 228 of file qgsheatmaprenderer.cpp.
|
overridevirtual |
to be overridden
feature | feature |
Implements QgsFeatureRendererV2.
Definition at line 369 of file qgsheatmaprenderer.cpp.
|
overridevirtual |
for symbol levels
Implements QgsFeatureRendererV2.
Definition at line 375 of file qgsheatmaprenderer.cpp.
Implements QgsFeatureRendererV2.
Definition at line 380 of file qgsheatmaprenderer.cpp.
|
inline |
Returns the expression used for weighting points when generating the heatmap.
Definition at line 158 of file qgsheatmaprenderer.h.