#include <qgssinglesymbolrenderer.h>

Inheritance diagram for QgsSingleSymbolRenderer:

Public Member Functions
	QgsSingleSymbolRenderer (QgsSymbol *symbol)
	Constructor for QgsSingleSymbolRenderer.

	~QgsSingleSymbolRenderer () override

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.

QgsSingleSymbolRenderer *	clone () const override
	Create a deep copy of this renderer.

QgsDataDefinedSizeLegend *	dataDefinedSizeLegend () const
	Returns configuration of appearance of legend when using data-defined size for marker symbols.

QString	dump () const override
	Returns debug information about this renderer.

Qgis::FeatureRendererFlags	flags () const override
	Returns flags associated with the renderer.

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.

QgsLegendSymbolList	legendSymbolItems () const override
	Returns a list of symbology items for the legend.

QgsSymbol *	originalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
	Returns symbol for feature.

QDomElement	save (QDomDocument &doc, const QgsReadWriteContext &context) override
	Stores renderer properties to an XML element.

void	setDataDefinedSizeLegend (QgsDataDefinedSizeLegend *settings)
	Configures appearance of legend when renderer is configured to use data-defined size for marker symbols.

void	setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override
	Sets the symbol to be used for a legend symbol item.

void	setSymbol (QgsSymbol *s)
	Sets the symbol which will be rendered for every feature.

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 *	symbol () const
	Returns the symbol which will be rendered for every feature.

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.

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.

Public Member Functions inherited from QgsFeatureRenderer
virtual	~QgsFeatureRenderer ()

virtual bool	canSkipRender ()
	Returns `true` if the renderer can be entirely skipped, i.e.

virtual void	checkLegendSymbolItem (const QString &key, bool state=true)
	Sets whether the legend symbology item with the specified ley should be checked.

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 const QgsFeatureRenderer *	embeddedRenderer () const
	Returns the current embedded renderer (subrenderer) for this feature renderer.

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.

virtual bool	filterNeedsGeometry () const
	Returns `true` if this renderer requires the geometry to apply the filter.

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 bool	legendSymbolItemChecked (const QString &key)
	Returns `true` if the legend symbology item with the specified key is checked.

virtual bool	legendSymbolItemsCheckable () const
	Returns `true` if symbology items in legend are checkable.

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.

virtual QgsSymbolList	originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const
	Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()

QgsPaintEffect *	paintEffect () const
	Returns the current paint effect for the renderer.

double	referenceScale () const
	Returns the symbology reference scale.

virtual bool	renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false)
	Render a feature using this renderer in the given context.

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.

virtual void	setEmbeddedRenderer (QgsFeatureRenderer *subRenderer)
	Sets an embedded renderer (subrenderer) for this feature 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.

virtual QgsSymbolList	symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const
	Returns list of symbols used for rendering the feature.

QString	type () const

virtual bool	usesEmbeddedSymbols () const
	Returns `true` if the renderer uses embedded symbols for features.

bool	usingSymbolLevels () const

virtual bool	willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const
	Returns whether the renderer will render a feature or not.

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

Static Public Member Functions
static QgsSingleSymbolRenderer *	convertFromRenderer (const QgsFeatureRenderer *renderer)
	Creates a new single symbol renderer from an existing renderer.

static QgsFeatureRenderer *	create (QDomElement &element, const QgsReadWriteContext &context)
	Creates a new single symbol renderer from an XML element, using the supplied read/write context.

static QgsFeatureRenderer *	createFromSld (QDomElement &element, Qgis::GeometryType geomType)
	Creates a new single symbol renderer from an SLD element.

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.

Protected Attributes
std::unique_ptr< QgsDataDefinedSizeLegend >	mDataDefinedSizeLegend

std::unique_ptr< QgsSymbol >	mSymbol

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
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...

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.

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)

Detailed Description

Definition at line 29 of file qgssinglesymbolrenderer.h.

Constructor & Destructor Documentation

◆ QgsSingleSymbolRenderer()

QgsSingleSymbolRenderer::QgsSingleSymbolRenderer ( QgsSymbol * symbol )

Constructor for QgsSingleSymbolRenderer.

The same symbol will be used to render every feature. Ownership of symbol is transferred to the renderer.

Definition at line 40 of file qgssinglesymbolrenderer.cpp.

◆ ~QgsSingleSymbolRenderer()

QgsSingleSymbolRenderer::~QgsSingleSymbolRenderer ( )

overridedefault

Member Function Documentation

◆ accept()

bool QgsSingleSymbolRenderer::accept ( QgsStyleEntityVisitorInterface * visitor ) const

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.

Since: QGIS 3.10

Reimplemented from QgsFeatureRenderer.

Definition at line 97 of file qgssinglesymbolrenderer.cpp.

◆ capabilities()

QgsFeatureRenderer::Capabilities QgsSingleSymbolRenderer::capabilities ( )

inlineoverridevirtual

Returns details about internals of this renderer.

E.g. if you only want to deal with visible features:

if not renderer.capabilities().testFlag(QgsFeatureRenderer.Filter) or renderer.willRenderFeature(feature, context):
    deal_with_my_feature()
else:
    skip_the_curren_feature()

Reimplemented from QgsFeatureRenderer.

Definition at line 78 of file qgssinglesymbolrenderer.h.

◆ clone()

QgsSingleSymbolRenderer * QgsSingleSymbolRenderer::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 123 of file qgssinglesymbolrenderer.cpp.

◆ convertFromRenderer()

QgsSingleSymbolRenderer * QgsSingleSymbolRenderer::convertFromRenderer ( const QgsFeatureRenderer * renderer )

static

Creates a new single symbol renderer from an existing renderer.

Returns: a new renderer if the conversion was possible, otherwise nullptr.

Definition at line 358 of file qgssinglesymbolrenderer.cpp.

◆ create()

QgsFeatureRenderer * QgsSingleSymbolRenderer::create	(	QDomElement &	element,
		const QgsReadWriteContext &	context
	)

static

Creates a new single symbol renderer from an XML element, using the supplied read/write context.

The caller takes ownership of the returned renderer.

Definition at line 156 of file qgssinglesymbolrenderer.cpp.

◆ createFromSld()

QgsFeatureRenderer * QgsSingleSymbolRenderer::createFromSld	(	QDomElement &	element,
		Qgis::GeometryType	geomType
	)

static

Creates a new single symbol renderer from an SLD element.

The geometry type for features to be rendered must be specified via the geomType argument.

The caller takes ownership of the returned renderer.

Definition at line 196 of file qgssinglesymbolrenderer.cpp.

◆ dataDefinedSizeLegend()

QgsDataDefinedSizeLegend * QgsSingleSymbolRenderer::dataDefinedSizeLegend ( ) const

Returns configuration of appearance of legend when using data-defined size for marker symbols.

Will return nullptr if the functionality is disabled.

Definition at line 401 of file qgssinglesymbolrenderer.cpp.

◆ dump()

QString QgsSingleSymbolRenderer::dump ( ) const

overridevirtual

Returns debug information about this renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 118 of file qgssinglesymbolrenderer.cpp.

◆ flags()

Qgis::FeatureRendererFlags QgsSingleSymbolRenderer::flags ( ) const

overridevirtual

Returns flags associated with the renderer.

Since: QGIS 3.40

Reimplemented from QgsFeatureRenderer.

Definition at line 47 of file qgssinglesymbolrenderer.cpp.

◆ legendKeysForFeature()

QSet< QString > QgsSingleSymbolRenderer::legendKeysForFeature	(	const QgsFeature &	feature,
		QgsRenderContext &	context
	)		const

overridevirtual

Returns legend keys matching a specified feature.

Reimplemented from QgsFeatureRenderer.

Definition at line 331 of file qgssinglesymbolrenderer.cpp.

◆ legendKeyToExpression()

QString QgsSingleSymbolRenderer::legendKeyToExpression	(	const QString &	key,
		QgsVectorLayer *	layer,
		bool &	ok
	)		const

overridevirtual

Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key.

Parameters

key	legend key
layer	associated vector layer
ok	will be set to `true` if legend key was successfully converted to a filter expression

Returns: QGIS expression string for matching features with the specified key

See also: legendKeys()

Since: QGIS 3.26

Reimplemented from QgsFeatureRenderer.

Definition at line 338 of file qgssinglesymbolrenderer.cpp.

◆ legendSymbolItems()

QgsLegendSymbolList QgsSingleSymbolRenderer::legendSymbolItems ( ) const

overridevirtual

Returns a list of symbology items for the legend.

See also: createLegendNodes(); legendKeys()

Reimplemented from QgsFeatureRenderer.

Definition at line 312 of file qgssinglesymbolrenderer.cpp.

◆ originalSymbolForFeature()

QgsSymbol * QgsSingleSymbolRenderer::originalSymbolForFeature	(	const QgsFeature &	feature,
		QgsRenderContext &	context
	)		const

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 62 of file qgssinglesymbolrenderer.cpp.

◆ save()

QDomElement QgsSingleSymbolRenderer::save	(	QDomDocument &	doc,
		const QgsReadWriteContext &	context
	)

overridevirtual

Stores renderer properties to an XML element.

Subclasses which override this method should call saveRendererData() as part of their implementation in order to store all common base class properties in the returned DOM element.

Reimplemented from QgsFeatureRenderer.

Definition at line 284 of file qgssinglesymbolrenderer.cpp.

◆ setDataDefinedSizeLegend()

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. nullptr is a valid input that disables data-defined size legend.

Definition at line 396 of file qgssinglesymbolrenderer.cpp.

◆ setLegendSymbolItem()

void QgsSingleSymbolRenderer::setLegendSymbolItem	(	const QString &	key,
		QgsSymbol *	symbol
	)

overridevirtual

Sets the symbol to be used for a legend symbol item.

Parameters

key	rule key for legend symbol
symbol	new symbol for legend item. Ownership is transferred to renderer.

See also: legendKeys()

Reimplemented from QgsFeatureRenderer.

Definition at line 352 of file qgssinglesymbolrenderer.cpp.

◆ setSymbol()

void QgsSingleSymbolRenderer::setSymbol ( QgsSymbol * s )

Sets the symbol which will be rendered for every feature.

Ownership of the symbol is transferred to the renderer.

See also: symbol()

Definition at line 112 of file qgssinglesymbolrenderer.cpp.

◆ startRender()

void QgsSingleSymbolRenderer::startRender	(	QgsRenderContext &	context,
		const QgsFields &	fields
	)

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.

Parameters

context	Additional information passed to the renderer about the job which will be rendered
fields	The fields available for rendering

See also: stopRender()

Warning: This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

Reimplemented from QgsFeatureRenderer.

Definition at line 69 of file qgssinglesymbolrenderer.cpp.

◆ stopRender()

void QgsSingleSymbolRenderer::stopRender ( QgsRenderContext & context )

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().

Warning: This method is not thread safe. Before calling startRender() in a non-main thread, the renderer should instead be cloned and startRender()/stopRender() called on the clone.

See also: startRender()

Reimplemented from QgsFeatureRenderer.

Definition at line 79 of file qgssinglesymbolrenderer.cpp.

◆ symbol()

QgsSymbol * QgsSingleSymbolRenderer::symbol ( ) const

Returns the symbol which will be rendered for every feature.

See also: setSymbol()

Definition at line 107 of file qgssinglesymbolrenderer.cpp.

◆ symbolForFeature()

QgsSymbol * QgsSingleSymbolRenderer::symbolForFeature	(	const QgsFeature &	feature,
		QgsRenderContext &	context
	)		const

overridevirtual

To be overridden.

Must be called between startRender() and stopRender() calls.

Parameters

feature	feature
context	render context

Returns: returns pointer to symbol or 0 if symbol was not found

Implements QgsFeatureRenderer.

Definition at line 57 of file qgssinglesymbolrenderer.cpp.

◆ symbols()

QgsSymbolList QgsSingleSymbolRenderer::symbols ( QgsRenderContext & context ) const

overridevirtual

Returns list of symbols used by the renderer.

Parameters

context render context

Reimplemented from QgsFeatureRenderer.

Definition at line 147 of file qgssinglesymbolrenderer.cpp.

◆ toSld()

void QgsSingleSymbolRenderer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props = `QVariantMap()`
	)		const

overridevirtual

used from subclasses to create SLD Rule elements following SLD v1.1 specs

Reimplemented from QgsFeatureRenderer.

Definition at line 131 of file qgssinglesymbolrenderer.cpp.

◆ usedAttributes()

QSet< QString > QgsSingleSymbolRenderer::usedAttributes ( const QgsRenderContext & context ) const

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.

Returns: A set of attributes

Implements QgsFeatureRenderer.

Definition at line 89 of file qgssinglesymbolrenderer.cpp.

Member Data Documentation

◆ mDataDefinedSizeLegend

std::unique_ptr<QgsDataDefinedSizeLegend> QgsSingleSymbolRenderer::mDataDefinedSizeLegend

protected

Definition at line 119 of file qgssinglesymbolrenderer.h.

◆ mSymbol

std::unique_ptr<QgsSymbol> QgsSingleSymbolRenderer::mSymbol

protected

Definition at line 118 of file qgssinglesymbolrenderer.h.

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

/build/qgis-3.40.0+99sid/src/core/symbology/qgssinglesymbolrenderer.h
/build/qgis-3.40.0+99sid/src/core/symbology/qgssinglesymbolrenderer.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSingleSymbolRenderer()

◆ ~QgsSingleSymbolRenderer()

Member Function Documentation

◆ accept()

◆ capabilities()

◆ clone()

◆ convertFromRenderer()

◆ create()

◆ createFromSld()

◆ dataDefinedSizeLegend()

◆ dump()

◆ flags()

◆ legendKeysForFeature()

◆ legendKeyToExpression()

◆ legendSymbolItems()

◆ originalSymbolForFeature()

◆ save()

◆ setDataDefinedSizeLegend()

◆ setLegendSymbolItem()

◆ setSymbol()

◆ startRender()

◆ stopRender()

◆ symbol()

◆ symbolForFeature()

◆ symbols()

◆ toSld()

◆ usedAttributes()

Member Data Documentation

◆ mDataDefinedSizeLegend

◆ mSymbol