QgsMapRendererCustomPainterJob Class Reference

Job implementation that renders everything sequentially using a custom painter. More...

#include <qgsmaprenderercustompainterjob.h>

Inheritance diagram for QgsMapRendererCustomPainterJob:

Public Member Functions
	QgsMapRendererCustomPainterJob (const QgsMapSettings &settings, QPainter *painter)
	~QgsMapRendererCustomPainterJob ()
virtual void	cancel () override
	Stop the rendering job - does not return until the job has terminated.
virtual bool	isActive () const override
	Tell whether the rendering job is currently running in background.
const LayerRenderJobs &	jobs () const
void	renderSynchronously ()
	Render the map synchronously in this thread.
virtual void	start () override
	Start the rendering job and immediately return.
virtual QgsLabelingResults *	takeLabelingResults () override
	Get pointer to internal labeling engine (in order to get access to the results)
virtual void	waitForFinished () override
	Block until the job has finished.
void	waitForFinishedWithEventLoop (QEventLoop::ProcessEventsFlags flags=QEventLoop::AllEvents)
	Wait for the job to be finished - and keep the thread's event loop running while waiting.
Public Member Functions inherited from QgsMapRendererJob
	QgsMapRendererJob (const QgsMapSettings &settings)
virtual	~QgsMapRendererJob ()
Errors	errors () const
	List of errors that happened during the rendering job - available when the rendering has been finished.
const QgsMapSettings &	mapSettings () const
	Return map settings with which this job was started.
int	renderingTime () const
	Find out how log it took to finish the job (in miliseconds)
void	setCache (QgsMapRendererCache *cache)
	Assign a cache to be used for reading and storing rendered images of individual layers.
void	setRequestedGeometryCacheForLayers (const QStringList &layerIds)
	Set which vector layers should be cached while rendering.

Protected Slots
void	futureFinished ()

Protected Member Functions
void	doRender ()
Protected Member Functions inherited from QgsMapRendererJob
void	cleanupJobs (LayerRenderJobs &jobs)
bool	needTemporaryImage (QgsMapLayer *ml)
LayerRenderJobs	prepareJobs (QPainter *painter, QgsPalLabeling *labelingEngine)
void	updateLayerGeometryCaches ()
	called when rendering has finished to update all layers' geometry caches

Static Protected Member Functions
static void	staticRender (QgsMapRendererCustomPainterJob *self)
Static Protected Member Functions inherited from QgsMapRendererJob
static QImage	composeImage (const QgsMapSettings &settings, const LayerRenderJobs &jobs)
static void	drawLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsPalLabeling *labelingEngine, QPainter *painter)
static void	drawNewLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsPalLabeling *labelingEngine)
static void	drawOldLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext)
static bool	reprojectToLayerExtent (const QgsCoordinateTransform *ct, bool layerCrsGeographic, QgsRectangle &extent, QgsRectangle &r2)
	Convenience function to project an extent into the layer source CRS, but also split it into two extents if it crosses the +/- 180 degree line.

Additional Inherited Members
Public Types inherited from QgsMapRendererJob
typedef QList< Error >	Errors
Signals inherited from QgsMapRendererJob
void	finished ()
	emitted when asynchronous rendering is finished (or canceled).
Protected Attributes inherited from QgsMapRendererJob
QgsMapRendererCache *	mCache
Errors	mErrors
QMap< QString, QgsGeometryCache >	mGeometryCaches
	map of geometry caches
QTime	mRenderingStart
int	mRenderingTime
QStringList	mRequestedGeomCacheForLayers
	list of layer IDs for which the geometry cache should be updated
QgsMapSettings	mSettings

Detailed Description

Job implementation that renders everything sequentially using a custom painter.

Also supports synchronous rendering in main thread for cases when rendering in background is not an option because of some technical limitations (e.g. printing to printer on some platforms).

Note

added in 2.4

Definition at line 31 of file qgsmaprenderercustompainterjob.h.

Constructor & Destructor Documentation

QgsMapRendererCustomPainterJob::QgsMapRendererCustomPainterJob	(	const QgsMapSettings &	settings,
		QPainter *	painter
	)

Definition at line 24 of file qgsmaprenderercustompainterjob.cpp.

QgsMapRendererCustomPainterJob::~QgsMapRendererCustomPainterJob

(

)

Definition at line 34 of file qgsmaprenderercustompainterjob.cpp.

Member Function Documentation

void QgsMapRendererCustomPainterJob::cancel ( )

overridevirtual

Stop the rendering job - does not return until the job has terminated.

Does nothing if the rendering is not active.

Implements QgsMapRendererJob.

Definition at line 100 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererCustomPainterJob::doRender ( )

protected

Definition at line 208 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererCustomPainterJob::futureFinished ( )

protectedslot

Definition at line 175 of file qgsmaprenderercustompainterjob.cpp.

bool QgsMapRendererCustomPainterJob::isActive ( ) const

overridevirtual

Tell whether the rendering job is currently running in background.

Implements QgsMapRendererJob.

Definition at line 146 of file qgsmaprenderercustompainterjob.cpp.

const LayerRenderJobs& QgsMapRendererCustomPainterJob::jobs ( ) const

inline

Note

not available in python bindings

Definition at line 45 of file qgsmaprenderercustompainterjob.h.

void QgsMapRendererCustomPainterJob::renderSynchronously

(

)

Render the map synchronously in this thread.

The function does not return until the map is completely rendered.

This is an alternative to ordinary API (using start() + waiting for finished() signal). Users are discouraged to use this method unless they have a strong reason for doing it. The synchronous rendering blocks the main thread, making the application unresponsive. Also, it is not possible to cancel rendering while it is in progress.

Definition at line 166 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererCustomPainterJob::start ( )

overridevirtual

Start the rendering job and immediately return.

Does nothing if the rendering is already in progress.

Implements QgsMapRendererJob.

Definition at line 44 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererCustomPainterJob::staticRender ( QgsMapRendererCustomPainterJob *  self )

staticprotected

Definition at line 188 of file qgsmaprenderercustompainterjob.cpp.

QgsLabelingResults * QgsMapRendererCustomPainterJob::takeLabelingResults ( )

overridevirtual

Get pointer to internal labeling engine (in order to get access to the results)

Implements QgsMapRendererJob.

Definition at line 152 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererCustomPainterJob::waitForFinished ( )

overridevirtual

Block until the job has finished.

Implements QgsMapRendererJob.

Definition at line 129 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererCustomPainterJob::waitForFinishedWithEventLoop

(

QEventLoop::ProcessEventsFlags

flags = QEventLoop::AllEvents

)

Wait for the job to be finished - and keep the thread's event loop running while waiting.

With a call to waitForFinished(), the waiting is done with a synchronization primitive and does not involve processing of messages. That may cause issues to code which requires some events to be handled in the main thread. Some plugins hooking into the rendering pipeline may require this in order to work properly - for example, OpenLayers plugin which uses a QWebPage in the main thread.

Ideally the "wait for finished" method should not be used at all. The code triggering rendering should not need to actively wait for rendering to finish.

Definition at line 158 of file qgsmaprenderercustompainterjob.cpp.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsmaprenderercustompainterjob.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsmaprenderercustompainterjob.cpp