#include <qgssinglesymbolrenderer.h>

Inheritance diagram for QgsSingleSymbolRenderer:

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

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 (const QgsFeature &feature, QgsRenderContext &context) const override
	Returns legend keys matching a specified feature. More...

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

QgsSymbol *	originalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
	Returns 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)
	Sets the symbol which will be rendered for every feature. More...

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
	Returns the symbol which will be rendered for every feature. More...

QgsSymbol *	symbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override
	To be overridden. More...

QgsSymbolList	symbols (QgsRenderContext &context) const 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
	Returns 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
	Gets 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 (const QgsFeature &feature, QgsRenderContext &context) const
	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 (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException)
	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, double size)
	Sets type and size of editing vertex markers for subsequent rendering. More...

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

QString	type () const

bool	usingSymbolLevels () const

virtual bool	willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const
	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 new single symbol renderer from an existing renderer. More...

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

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

Static Public Member Functions inherited from QgsFeatureRenderer
static QgsFeatureRenderer *	defaultRenderer (QgsWkbTypes::GeometryType geomType)
	Returns 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
double	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 (const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker) SIP_THROW(QgsCsException)
	Render the feature with the symbol using context. More...

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)

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

Member Function Documentation

◆ 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 75 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 99 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.

Since: QGIS 2.5

Definition at line 332 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 133 of file qgssinglesymbolrenderer.cpp.

◆ createFromSld()

QgsFeatureRenderer * QgsSingleSymbolRenderer::createFromSld	(	QDomElement &	element,
		QgsWkbTypes::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 173 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.

Since: QGIS 3.0

Definition at line 376 of file qgssinglesymbolrenderer.cpp.

◆ dump()

QString QgsSingleSymbolRenderer::dump ( ) const

overridevirtual

Returns debug information about this renderer.

Reimplemented from QgsFeatureRenderer.

Definition at line 94 of file qgssinglesymbolrenderer.cpp.

◆ legendKeysForFeature()

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

overridevirtual

Returns legend keys matching a specified feature.

Since: QGIS 2.14

Reimplemented from QgsFeatureRenderer.

Definition at line 319 of file qgssinglesymbolrenderer.cpp.

◆ legendSymbolItems()

QgsLegendSymbolList QgsSingleSymbolRenderer::legendSymbolItems ( ) const

overridevirtual

Returns a list of symbology items for the legend.

Since: QGIS 2.6

Reimplemented from QgsFeatureRenderer.

Definition at line 300 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.

Since: QGIS 2.12

Reimplemented from QgsFeatureRenderer.

Definition at line 48 of file qgssinglesymbolrenderer.cpp.

◆ save()

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

overridevirtual

store renderer info to XML element

Reimplemented from QgsFeatureRenderer.

Definition at line 261 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.

Since: QGIS 3.0

Definition at line 371 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.

Since: QGIS 2.14

Reimplemented from QgsFeatureRenderer.

Definition at line 326 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 88 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 55 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 65 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 83 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

Since: QGIS 2.12

Implements QgsFeatureRenderer.

Definition at line 43 of file qgssinglesymbolrenderer.cpp.

◆ symbols()

QgsSymbolList QgsSingleSymbolRenderer::symbols ( QgsRenderContext & context ) const

overridevirtual

Returns list of symbols used by the renderer.

Parameters

context render context

Since: QGIS 2.12

Reimplemented from QgsFeatureRenderer.

Definition at line 124 of file qgssinglesymbolrenderer.cpp.

◆ toSld()

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

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.

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

Member Data Documentation

◆ mDataDefinedSizeLegend

std::unique_ptr<QgsDataDefinedSizeLegend> QgsSingleSymbolRenderer::mDataDefinedSizeLegend

protected

Definition at line 118 of file qgssinglesymbolrenderer.h.

◆ mSymbol

std::unique_ptr<QgsSymbol> QgsSingleSymbolRenderer::mSymbol

protected

Definition at line 117 of file qgssinglesymbolrenderer.h.

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

/tmp/buildd/qgis-3.8.0+99unstable/src/core/symbology/qgssinglesymbolrenderer.h
/tmp/buildd/qgis-3.8.0+99unstable/src/core/symbology/qgssinglesymbolrenderer.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSingleSymbolRenderer()

Member Function Documentation

◆ capabilities()

◆ clone()

◆ convertFromRenderer()

◆ create()

◆ createFromSld()

◆ dataDefinedSizeLegend()

◆ dump()

◆ legendKeysForFeature()

◆ legendSymbolItems()

◆ originalSymbolForFeature()

◆ save()

◆ setDataDefinedSizeLegend()

◆ setLegendSymbolItem()

◆ setSymbol()

◆ startRender()

◆ stopRender()

◆ symbol()

◆ symbolForFeature()

◆ symbols()

◆ toSld()

◆ usedAttributes()

Member Data Documentation

◆ mDataDefinedSizeLegend

◆ mSymbol