Abstract base class for map rendering implementations. More...

#include <qgsmaprendererjob.h>

Inheritance diagram for QgsMapRendererJob:

Classes
struct	Error

Public Types
typedef QList< Error >	Errors

Signals
void	finished ()
	emitted when asynchronous rendering is finished (or canceled).

Public Member Functions
	QgsMapRendererJob (const QgsMapSettings &settings)
virtual	~QgsMapRendererJob ()
virtual void	cancel ()=0
	Stop the rendering job - does not return until the job has terminated.
Errors	errors () const
	List of errors that happened during the rendering job - available when the rendering has been finished.
virtual bool	isActive () const =0
	Tell whether the rendering job is currently running in background.
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.
virtual void	start ()=0
	Start the rendering job and immediately return.
virtual QgsLabelingResults *	takeLabelingResults ()=0
	Get pointer to internal labeling engine (in order to get access to the results)
virtual void	waitForFinished ()=0
	Block until the job has finished.

Protected Member Functions
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 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.

Protected Attributes
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

Abstract base class for map rendering implementations.

The API is designed in a way that rendering is done asynchronously, therefore the caller is not blocked while the rendering is in progress. Non-blocking operation is quite important because the rendering can take considerable amount of time.

Common use case: 0. prepare QgsMapSettings with rendering configuration (extent, layer, map size, ...)

create QgsMapRendererJob subclass with QgsMapSettings instance
connect to job's finished() signal
call start(). Map rendering will start in background, the function immediately returns
at some point, slot connected to finished() signal is called, map rendering is done

It is possible to cancel the rendering job while it is active by calling cancel() function.

The following subclasses are available:

QgsMapRendererSequentialJob - renders map in one background thread to an image
QgsMapRendererParallelJob - renders map in multiple background threads to an image
QgsMapRendererCustomPainterJob - renders map with given QPainter in one background thread

Note: added in 2.4

Definition at line 78 of file qgsmaprendererjob.h.

Member Typedef Documentation

typedef QList<Error> QgsMapRendererJob::Errors

Definition at line 112 of file qgsmaprendererjob.h.

Constructor & Destructor Documentation

QgsMapRendererJob::QgsMapRendererJob ( const QgsMapSettings & settings )

Definition at line 36 of file qgsmaprendererjob.cpp.

virtual QgsMapRendererJob::~QgsMapRendererJob ( )

inlinevirtual

Definition at line 85 of file qgsmaprendererjob.h.

Member Function Documentation

virtual void QgsMapRendererJob::cancel ( )

pure virtual

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

Does nothing if the rendering is not active.

Implemented in QgsMapRendererCustomPainterJob, QgsMapRendererSequentialJob, and QgsMapRendererParallelJob.

void QgsMapRendererJob::cleanupJobs ( LayerRenderJobs & jobs )

protected

Note: not available in python bindings

Definition at line 281 of file qgsmaprendererjob.cpp.

QImage QgsMapRendererJob::composeImage	(	const QgsMapSettings &	settings,
		const LayerRenderJobs &	jobs
	)

staticprotected

Definition at line 317 of file qgsmaprendererjob.cpp.

void QgsMapRendererJob::drawLabeling	(	const QgsMapSettings &	settings,
		QgsRenderContext &	renderContext,
		QgsPalLabeling *	labelingEngine,
		QPainter *	painter
	)

staticprotected

Definition at line 248 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererJob::drawNewLabeling	(	const QgsMapSettings &	settings,
		QgsRenderContext &	renderContext,
		QgsPalLabeling *	labelingEngine
	)

staticprotected

Definition at line 314 of file qgsmaprenderercustompainterjob.cpp.

void QgsMapRendererJob::drawOldLabeling	(	const QgsMapSettings &	settings,
		QgsRenderContext &	renderContext
	)

staticprotected

Definition at line 272 of file qgsmaprenderercustompainterjob.cpp.

QgsMapRendererJob::Errors QgsMapRendererJob::errors ( ) const

List of errors that happened during the rendering job - available when the rendering has been finished.

Definition at line 50 of file qgsmaprendererjob.cpp.

void QgsMapRendererJob::finished ( )

signal

emitted when asynchronous rendering is finished (or canceled).

virtual bool QgsMapRendererJob::isActive ( ) const

pure virtual

Tell whether the rendering job is currently running in background.

Implemented in QgsMapRendererCustomPainterJob, QgsMapRendererSequentialJob, and QgsMapRendererParallelJob.

const QgsMapSettings & QgsMapRendererJob::mapSettings ( ) const

Return map settings with which this job was started.

Returns: A QgsMapSettings instance with render settings

Note: added in 2.8

Definition at line 60 of file qgsmaprendererjob.cpp.

bool QgsMapRendererJob::needTemporaryImage ( QgsMapLayer * ml )

protected

Definition at line 339 of file qgsmaprenderercustompainterjob.cpp.

LayerRenderJobs QgsMapRendererJob::prepareJobs	(	QPainter *	painter,
		QgsPalLabeling *	labelingEngine
	)

protected

Note: not available in python bindings

Definition at line 138 of file qgsmaprendererjob.cpp.

int QgsMapRendererJob::renderingTime ( ) const

inline

Find out how log it took to finish the job (in miliseconds)

Definition at line 127 of file qgsmaprendererjob.h.

bool QgsMapRendererJob::reprojectToLayerExtent	(	const QgsCoordinateTransform *	ct,
		bool	layerCrsGeographic,
		QgsRectangle &	extent,
		QgsRectangle &	r2
	)

staticprotected

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.

Modifies the given extent to be in the source CRS coordinates, and if it was split, returns true, and also sets the contents of the r2 parameter

Definition at line 66 of file qgsmaprendererjob.cpp.

void QgsMapRendererJob::setCache ( QgsMapRendererCache * cache )

Assign a cache to be used for reading and storing rendered images of individual layers.

Does not take ownership of the object.

Definition at line 55 of file qgsmaprendererjob.cpp.

void QgsMapRendererJob::setRequestedGeometryCacheForLayers ( const QStringList & layerIds )

inline

Set which vector layers should be cached while rendering.

Note: The way how geometries are cached is really suboptimal - this method may be removed in future releases

Definition at line 124 of file qgsmaprendererjob.h.

virtual void QgsMapRendererJob::start ( )

pure virtual

Start the rendering job and immediately return.

Does nothing if the rendering is already in progress.

Implemented in QgsMapRendererCustomPainterJob, QgsMapRendererSequentialJob, and QgsMapRendererParallelJob.

virtual QgsLabelingResults* QgsMapRendererJob::takeLabelingResults ( )

pure virtual

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

Implemented in QgsMapRendererCustomPainterJob, QgsMapRendererSequentialJob, and QgsMapRendererParallelJob.

void QgsMapRendererJob::updateLayerGeometryCaches ( )

protected

called when rendering has finished to update all layers' geometry caches

Definition at line 327 of file qgsmaprenderercustompainterjob.cpp.

virtual void QgsMapRendererJob::waitForFinished ( )

pure virtual

Block until the job has finished.

Implemented in QgsMapRendererCustomPainterJob, QgsMapRendererSequentialJob, and QgsMapRendererParallelJob.

Member Data Documentation

QgsMapRendererCache* QgsMapRendererJob::mCache

protected

Definition at line 171 of file qgsmaprendererjob.h.

Errors QgsMapRendererJob::mErrors

protected

Definition at line 169 of file qgsmaprendererjob.h.

QMap<QString, QgsGeometryCache> QgsMapRendererJob::mGeometryCaches

protected

map of geometry caches

Definition at line 176 of file qgsmaprendererjob.h.

QTime QgsMapRendererJob::mRenderingStart

protected

Definition at line 178 of file qgsmaprendererjob.h.

int QgsMapRendererJob::mRenderingTime

protected

Definition at line 179 of file qgsmaprendererjob.h.

QStringList QgsMapRendererJob::mRequestedGeomCacheForLayers

protected

list of layer IDs for which the geometry cache should be updated

Definition at line 174 of file qgsmaprendererjob.h.

QgsMapSettings QgsMapRendererJob::mSettings

protected

Definition at line 168 of file qgsmaprendererjob.h.

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

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

Classes

Public Types

Signals

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation