QgsMapLayerRenderer Class Reference

Base class for utility classes that encapsulate information necessary for rendering of map layers. More...

#include <qgsmaplayerrenderer.h>

Inheritance diagram for QgsMapLayerRenderer:

Public Member Functions
	QgsMapLayerRenderer (const QString &layerID)
virtual	~QgsMapLayerRenderer ()=default
QStringList	errors () const
	Return list of errors (problems) that happened during the rendering. More...
virtual QgsFeedback *	feedback () const
	Access to feedback object of the layer renderer (may be null) More...
QString	layerId () const
	Get access to the ID of the layer rendered by this class. More...
virtual bool	render ()=0
	Do the rendering (based on data stored in the class) More...

Protected Attributes
QStringList	mErrors
QString	mLayerID

Detailed Description

Base class for utility classes that encapsulate information necessary for rendering of map layers.

The rendering is typically done in a background thread, so it is necessary to keep all structures required for rendering away from the original map layer because it may change any time.

Because the data needs to be copied (to avoid the need for locking), it is highly desirable to use copy-on-write where possible. This way, the overhead of copying (both memory and CPU) will be kept low. Qt containers and various Qt classes use implicit sharing.

The scenario will be:

1. renderer job (doing preparation in the GUI thread) calls QgsMapLayer::createMapRenderer() and gets instance of this class. The instance is initialized at that point and should not need additional calls to QgsVectorLayer.
2. renderer job (still in GUI thread) stores the renderer for later use.
3. renderer job (in worker thread) calls QgsMapLayerRenderer::render()
4. renderer job (again in GUI thread) will check errors() and report them

Since

QGIS 2.4

Definition at line 48 of file qgsmaplayerrenderer.h.

Constructor & Destructor Documentation

QgsMapLayerRenderer()

QgsMapLayerRenderer::QgsMapLayerRenderer ( const QString &  layerID )

inline

Definition at line 51 of file qgsmaplayerrenderer.h.

~QgsMapLayerRenderer()

virtual QgsMapLayerRenderer::~QgsMapLayerRenderer ( )

virtualdefault

Member Function Documentation

errors()

QStringList QgsMapLayerRenderer::errors ( ) const

inline

Return list of errors (problems) that happened during the rendering.

Definition at line 64 of file qgsmaplayerrenderer.h.

feedback()

virtual QgsFeedback* QgsMapLayerRenderer::feedback ( ) const

inlinevirtual

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

Since

QGIS 3.0

Reimplemented in QgsRasterLayerRenderer.

Definition at line 61 of file qgsmaplayerrenderer.h.

layerId()

QString QgsMapLayerRenderer::layerId ( ) const

inline

Get access to the ID of the layer rendered by this class.

Definition at line 67 of file qgsmaplayerrenderer.h.

render()

virtual bool QgsMapLayerRenderer::render ( )

pure virtual

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

Implemented in QgsVectorLayerRenderer, and QgsRasterLayerRenderer.

Member Data Documentation

mErrors

QStringList QgsMapLayerRenderer::mErrors

protected

Definition at line 70 of file qgsmaplayerrenderer.h.

mLayerID

QString QgsMapLayerRenderer::mLayerID

protected

Definition at line 71 of file qgsmaplayerrenderer.h.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsmaplayerrenderer.h