QGIS API Documentation
3.0.2-Girona (307d082)
|
#include <qgssinglesymbolrenderer.h>
Public Member Functions | |
QgsSingleSymbolRenderer (QgsSymbol *symbol) | |
QgsFeatureRenderer::Capabilities | capabilities () override |
Returns details about internals of this renderer. More... | |
QgsSingleSymbolRenderer * | clone () const override |
Create a deep copy of this renderer. More... | |
QgsDataDefinedSizeLegend * | dataDefinedSizeLegend () const |
Returns configuration of appearance of legend when using data-defined size for marker symbols. More... | |
QString | dump () const override |
Returns debug information about this renderer. More... | |
QSet< QString > | legendKeysForFeature (QgsFeature &feature, QgsRenderContext &context) override |
Return legend keys matching a specified feature. More... | |
QgsLegendSymbolList | legendSymbolItems () const override |
Returns a list of symbology items for the legend. More... | |
QgsSymbol * | originalSymbolForFeature (QgsFeature &feature, QgsRenderContext &context) override |
Return symbol for feature. More... | |
QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) override |
store renderer info to XML element More... | |
void | setDataDefinedSizeLegend (QgsDataDefinedSizeLegend *settings) |
Configures appearance of legend when renderer is configured to use data-defined size for marker symbols. More... | |
void | setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override |
Sets the symbol to be used for a legend symbol item. More... | |
void | setSymbol (QgsSymbol *s) |
void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
Must be called when a new render cycle is started. More... | |
void | stopRender (QgsRenderContext &context) override |
Must be called when a render cycle has finished, to allow the renderer to clean up. More... | |
QgsSymbol * | symbol () const |
QgsSymbol * | symbolForFeature (QgsFeature &feature, QgsRenderContext &context) override |
To be overridden. More... | |
QgsSymbolList | symbols (QgsRenderContext &context) override |
Returns list of symbols used by the renderer. More... | |
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... | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Return a list of attributes required by this renderer. More... | |
Public Member Functions inherited from QgsFeatureRenderer | |
virtual | ~QgsFeatureRenderer () |
virtual void | checkLegendSymbolItem (const QString &key, bool state=true) |
item in symbology was checked More... | |
virtual const QgsFeatureRenderer * | embeddedRenderer () const |
Returns the current embedded renderer (subrenderer) for this feature renderer. More... | |
virtual QString | filter (const QgsFields &fields=QgsFields()) |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause. 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 bool | legendSymbolItemChecked (const QString &key) |
items of symbology items in legend is checked More... | |
virtual bool | legendSymbolItemsCheckable () const |
items of symbology items in legend should be checkable 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... | |
virtual QgsSymbolList | originalSymbolsForFeature (QgsFeature &feat, QgsRenderContext &context) |
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 bool | renderFeature (QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) |
Render a feature using this renderer in the given context. More... | |
virtual void | setEmbeddedRenderer (QgsFeatureRenderer *subRenderer) |
Sets an embedded renderer (subrenderer) for this feature 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... | |
virtual QgsSymbolList | symbolsForFeature (QgsFeature &feat, QgsRenderContext &context) |
Returns list of symbols used for rendering the feature. More... | |
QString | type () const |
bool | usingSymbolLevels () const |
virtual bool | willRenderFeature (QgsFeature &feat, QgsRenderContext &context) |
Returns whether the renderer will render a feature or not. More... | |
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 QgsSingleSymbolRenderer * | convertFromRenderer (const QgsFeatureRenderer *renderer) |
creates a QgsSingleSymbolRenderer from an existing renderer. More... | |
static QgsFeatureRenderer * | create (QDomElement &element, const QgsReadWriteContext &context) |
create renderer from XML element More... | |
static QgsFeatureRenderer * | createFromSld (QDomElement &element, QgsWkbTypes::GeometryType geomType) |
Static Public Member Functions inherited from QgsFeatureRenderer | |
static QgsFeatureRenderer * | defaultRenderer (QgsWkbTypes::GeometryType geomType) |
return a new renderer - used by default in vector layers More... | |
static QgsFeatureRenderer * | load (QDomElement &symbologyElem, const QgsReadWriteContext &context) |
create a renderer from XML element More... | |
static QgsFeatureRenderer * | loadSld (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... | |
Protected Attributes | |
std::unique_ptr< QgsDataDefinedSizeLegend > | mDataDefinedSizeLegend |
std::unique_ptr< QgsSymbol > | mSymbol |
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 |
QgsPaintEffect * | mPaintEffect = nullptr |
QString | mType |
bool | mUsingSymbolLevels |
Additional Inherited Members | |
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... | |
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 QgsPoint &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) |
Definition at line 29 of file qgssinglesymbolrenderer.h.
QgsSingleSymbolRenderer::QgsSingleSymbolRenderer | ( | QgsSymbol * | symbol | ) |
Definition at line 36 of file qgssinglesymbolrenderer.cpp.
|
inlineoverridevirtual |
Returns details about internals of this renderer.
E.g. if you only want to deal with visible features:
Reimplemented from QgsFeatureRenderer.
Definition at line 51 of file qgssinglesymbolrenderer.h.
|
overridevirtual |
Create a deep copy of this renderer.
Should be implemented by all subclasses and generate a proper subclass.
Implements QgsFeatureRenderer.
Definition at line 99 of file qgssinglesymbolrenderer.cpp.
|
static |
creates a QgsSingleSymbolRenderer from an existing renderer.
Definition at line 332 of file qgssinglesymbolrenderer.cpp.
|
static |
create renderer from XML element
Definition at line 133 of file qgssinglesymbolrenderer.cpp.
|
static |
Definition at line 173 of file qgssinglesymbolrenderer.cpp.
QgsDataDefinedSizeLegend * QgsSingleSymbolRenderer::dataDefinedSizeLegend | ( | ) | const |
Returns configuration of appearance of legend when using data-defined size for marker symbols.
Will return null if the functionality is disabled.
Definition at line 376 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
Returns debug information about this renderer.
Reimplemented from QgsFeatureRenderer.
Definition at line 94 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
Return legend keys matching a specified feature.
Reimplemented from QgsFeatureRenderer.
Definition at line 319 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
Returns a list of symbology items for the legend.
Reimplemented from QgsFeatureRenderer.
Definition at line 300 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
Return 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 48 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
store renderer info to XML element
Reimplemented from QgsFeatureRenderer.
Definition at line 261 of file qgssinglesymbolrenderer.cpp.
void QgsSingleSymbolRenderer::setDataDefinedSizeLegend | ( | QgsDataDefinedSizeLegend * | settings | ) |
Configures appearance of legend when renderer is configured to use data-defined size for marker symbols.
This allows configuring which values (symbol sizes) should be shown in the legend, whether to display different symbol sizes collapsed in one legend node or separated across multiple legend nodes etc.
When renderer does not use data-defined size or does not use marker symbols, these settings will be ignored. Takes ownership of the passed settings objects. Null pointer is a valid input that disables data-defined size legend.
Definition at line 371 of file qgssinglesymbolrenderer.cpp.
|
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 326 of file qgssinglesymbolrenderer.cpp.
void QgsSingleSymbolRenderer::setSymbol | ( | QgsSymbol * | s | ) |
Definition at line 88 of file qgssinglesymbolrenderer.cpp.
|
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 55 of file qgssinglesymbolrenderer.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 65 of file qgssinglesymbolrenderer.cpp.
QgsSymbol * QgsSingleSymbolRenderer::symbol | ( | ) | const |
Definition at line 83 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
To be overridden.
Must be called between startRender() and stopRender() calls.
feature | feature |
context | render context |
Implements QgsFeatureRenderer.
Definition at line 43 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
Returns list of symbols used by the renderer.
context | render context |
Reimplemented from QgsFeatureRenderer.
Definition at line 124 of file qgssinglesymbolrenderer.cpp.
|
overridevirtual |
used from subclasses to create SLD Rule elements following SLD v1.1 specs
Reimplemented from QgsFeatureRenderer.
Definition at line 108 of file qgssinglesymbolrenderer.cpp.
|
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.
Implements QgsFeatureRenderer.
Definition at line 75 of file qgssinglesymbolrenderer.cpp.
|
protected |
Definition at line 89 of file qgssinglesymbolrenderer.h.
|
protected |
Definition at line 88 of file qgssinglesymbolrenderer.h.