QgsVectorLayerRenderer Class Reference

Implementation of threaded rendering for vector layers. More...

#include <qgsvectorlayerrenderer.h>

Inheritance diagram for QgsVectorLayerRenderer:

Public Member Functions
	QgsVectorLayerRenderer (QgsVectorLayer *layer, QgsRenderContext &context)
	~QgsVectorLayerRenderer () override
QgsFeatureRenderer *	featureRenderer ()
	Returns the feature renderer. More...
QgsFeedback *	feedback () const override
	Access to feedback object of the layer renderer (may be nullptr) More...
bool	render () override
	Do the rendering (based on data stored in the class) More...
Public Member Functions inherited from QgsMapLayerRenderer
	QgsMapLayerRenderer (const QString &layerID, QgsRenderContext *context=nullptr)
	Constructor for QgsMapLayerRenderer, with the associated layerID and render context. More...
virtual	~QgsMapLayerRenderer ()=default
QStringList	errors () const
	Returns list of errors (problems) that happened during the rendering. More...
QString	layerId () const
	Gets access to the ID of the layer rendered by this class. More...
QgsRenderContext *	renderContext ()
	Returns the render context associated with the renderer. More...

Protected Attributes
bool	mApplyClipFilter = false
bool	mApplyClipGeometries = false
bool	mApplyLabelClipGeometries = false
QSet< QString >	mAttrNames
QgsGeometry	mClipFeatureGeom
QgsGeometry	mClipFilterGeom
QList< QgsMapClippingRegion >	mClippingRegions
QgsVectorLayerDiagramProvider *	mDiagramProvider = nullptr
	used with new labeling engine (QgsLabelingEngine): provider for diagrams. More...
bool	mDiagrams
	used with new labeling engine (QgsPalLabeling): whether diagrams are enabled More...
bool	mDrawVertexMarkers
QPainter::CompositionMode	mFeatureBlendMode
QgsFields	mFields
QgsWkbTypes::GeometryType	mGeometryType
std::unique_ptr< QgsVectorLayerRendererInterruptionChecker >	mInterruptionChecker
QgsGeometry	mLabelClipFeatureGeom
bool	mLabeling
	used with old labeling engine (QgsPalLabeling): whether labeling is enabled More...
QgsVectorLayerLabelProvider *	mLabelProvider = nullptr
	used with new labeling engine (QgsLabelingEngine): provider for labels. More...
QgsVectorLayer *	mLayer = nullptr
	The rendered layer. More...
QgsFeatureRenderer *	mRenderer = nullptr
QgsFeatureIds	mSelectedFeatureIds
bool	mSimplifyGeometry
QgsVectorSimplifyMethod	mSimplifyMethod
QgsVectorLayerFeatureSource *	mSource = nullptr
QString	mTemporalFilter
bool	mVertexMarkerOnlyForSelection
double	mVertexMarkerSize = 2.0
int	mVertexMarkerStyle = 0
Protected Attributes inherited from QgsMapLayerRenderer
QStringList	mErrors
QString	mLayerID

Detailed Description

Implementation of threaded rendering for vector layers.

Note

not available in Python bindings

Since

QGIS 2.4

Definition at line 75 of file qgsvectorlayerrenderer.h.

Constructor & Destructor Documentation

QgsVectorLayerRenderer()

QgsVectorLayerRenderer::QgsVectorLayerRenderer	(	QgsVectorLayer *	layer,
		QgsRenderContext &	context
	)

Definition at line 47 of file qgsvectorlayerrenderer.cpp.

~QgsVectorLayerRenderer()

QgsVectorLayerRenderer::~QgsVectorLayerRenderer ( )

override

Definition at line 132 of file qgsvectorlayerrenderer.cpp.

Member Function Documentation

featureRenderer()

QgsFeatureRenderer* QgsVectorLayerRenderer::featureRenderer ( )

inline

Returns the feature renderer.

This may be used for tweaking it before the actual rendering of the layer.

Since

QGIS 3.12

Definition at line 87 of file qgsvectorlayerrenderer.h.

feedback()

QgsFeedback * QgsVectorLayerRenderer::feedback ( ) const

overridevirtual

Access to feedback object of the layer renderer (may be nullptr)

Since

QGIS 3.0

Reimplemented from QgsMapLayerRenderer.

Definition at line 138 of file qgsvectorlayerrenderer.cpp.

render()

bool QgsVectorLayerRenderer::render ( )

overridevirtual

Do the rendering (based on data stored in the class)

Implements QgsMapLayerRenderer.

Definition at line 143 of file qgsvectorlayerrenderer.cpp.

Member Data Documentation

mApplyClipFilter

bool QgsVectorLayerRenderer::mApplyClipFilter = false

protected

Definition at line 165 of file qgsvectorlayerrenderer.h.

mApplyClipGeometries

bool QgsVectorLayerRenderer::mApplyClipGeometries = false

protected

Definition at line 167 of file qgsvectorlayerrenderer.h.

mApplyLabelClipGeometries

bool QgsVectorLayerRenderer::mApplyLabelClipGeometries = false

protected

Definition at line 169 of file qgsvectorlayerrenderer.h.

mAttrNames

QSet<QString> QgsVectorLayerRenderer::mAttrNames

protected

Definition at line 139 of file qgsvectorlayerrenderer.h.

mClipFeatureGeom

QgsGeometry QgsVectorLayerRenderer::mClipFeatureGeom

protected

Definition at line 166 of file qgsvectorlayerrenderer.h.

mClipFilterGeom

QgsGeometry QgsVectorLayerRenderer::mClipFilterGeom

protected

Definition at line 164 of file qgsvectorlayerrenderer.h.

mClippingRegions

QList< QgsMapClippingRegion > QgsVectorLayerRenderer::mClippingRegions

protected

Definition at line 163 of file qgsvectorlayerrenderer.h.

mDiagramProvider

QgsVectorLayerDiagramProvider* QgsVectorLayerRenderer::mDiagramProvider = nullptr

protected

used with new labeling engine (QgsLabelingEngine): provider for diagrams.

may be nullptr. no need to delete: if exists it is owned by labeling engine

Definition at line 156 of file qgsvectorlayerrenderer.h.

mDiagrams

bool QgsVectorLayerRenderer::mDiagrams

protected

used with new labeling engine (QgsPalLabeling): whether diagrams are enabled

Definition at line 144 of file qgsvectorlayerrenderer.h.

mDrawVertexMarkers

bool QgsVectorLayerRenderer::mDrawVertexMarkers

protected

Definition at line 132 of file qgsvectorlayerrenderer.h.

mFeatureBlendMode

QPainter::CompositionMode QgsVectorLayerRenderer::mFeatureBlendMode

protected

Definition at line 158 of file qgsvectorlayerrenderer.h.

mFields

QgsFields QgsVectorLayerRenderer::mFields

protected

Definition at line 122 of file qgsvectorlayerrenderer.h.

mGeometryType

QgsWkbTypes::GeometryType QgsVectorLayerRenderer::mGeometryType

protected

Definition at line 137 of file qgsvectorlayerrenderer.h.

mInterruptionChecker

std::unique_ptr< QgsVectorLayerRendererInterruptionChecker > QgsVectorLayerRenderer::mInterruptionChecker

protected

Definition at line 117 of file qgsvectorlayerrenderer.h.

mLabelClipFeatureGeom

QgsGeometry QgsVectorLayerRenderer::mLabelClipFeatureGeom

protected

Definition at line 168 of file qgsvectorlayerrenderer.h.

mLabeling

bool QgsVectorLayerRenderer::mLabeling

protected

used with old labeling engine (QgsPalLabeling): whether labeling is enabled

Definition at line 142 of file qgsvectorlayerrenderer.h.

mLabelProvider

QgsVectorLayerLabelProvider* QgsVectorLayerRenderer::mLabelProvider = nullptr

protected

used with new labeling engine (QgsLabelingEngine): provider for labels.

may be nullptr. no need to delete: if exists it is owned by labeling engine

Definition at line 150 of file qgsvectorlayerrenderer.h.

mLayer

QgsVectorLayer* QgsVectorLayerRenderer::mLayer = nullptr

protected

The rendered layer.

Definition at line 120 of file qgsvectorlayerrenderer.h.

mRenderer

QgsFeatureRenderer* QgsVectorLayerRenderer::mRenderer = nullptr

protected

Definition at line 130 of file qgsvectorlayerrenderer.h.

mSelectedFeatureIds

QgsFeatureIds QgsVectorLayerRenderer::mSelectedFeatureIds

protected

Definition at line 124 of file qgsvectorlayerrenderer.h.

mSimplifyGeometry

bool QgsVectorLayerRenderer::mSimplifyGeometry

protected

Definition at line 161 of file qgsvectorlayerrenderer.h.

mSimplifyMethod

QgsVectorSimplifyMethod QgsVectorLayerRenderer::mSimplifyMethod

protected

Definition at line 160 of file qgsvectorlayerrenderer.h.

mSource

QgsVectorLayerFeatureSource* QgsVectorLayerRenderer::mSource = nullptr

protected

Definition at line 128 of file qgsvectorlayerrenderer.h.

mTemporalFilter

QString QgsVectorLayerRenderer::mTemporalFilter

protected

Definition at line 126 of file qgsvectorlayerrenderer.h.

mVertexMarkerOnlyForSelection

bool QgsVectorLayerRenderer::mVertexMarkerOnlyForSelection

protected

Definition at line 133 of file qgsvectorlayerrenderer.h.

mVertexMarkerSize

double QgsVectorLayerRenderer::mVertexMarkerSize = 2.0

protected

Definition at line 135 of file qgsvectorlayerrenderer.h.

mVertexMarkerStyle

int QgsVectorLayerRenderer::mVertexMarkerStyle = 0

protected

Definition at line 134 of file qgsvectorlayerrenderer.h.

---

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

• /build/qgis-3.16.0+99unstable/src/core/qgsvectorlayerrenderer.h
• /build/qgis-3.16.0+99unstable/src/core/qgsvectorlayerrenderer.cpp