QgsMapRendererParallelJob Class Reference

Job implementation that renders all layers in parallel. More...

#include <qgsmaprendererparalleljob.h>

Inheritance diagram for QgsMapRendererParallelJob:

Public Member Functions
	QgsMapRendererParallelJob (const QgsMapSettings &settings)
	~QgsMapRendererParallelJob ()
virtual void	start ()
	Start the rendering job and immediately return.
virtual void	cancel ()
	Stop the rendering job - does not return until the job has terminated.
virtual void	waitForFinished ()
	Block until the job has finished.
virtual bool	isActive () const
	Tell whether the rendering job is currently running in background.
virtual QgsLabelingResults *	takeLabelingResults ()
	Get pointer to internal labeling engine (in order to get access to the results)
virtual QImage	renderedImage ()
	Get a preview/resulting image.
Public Member Functions inherited from QgsMapRendererQImageJob
	QgsMapRendererQImageJob (const QgsMapSettings &settings)
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.
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.
int	renderingTime () const
	Find out how log it took to finish the job (in miliseconds)

Protected Types
enum	{ Idle, RenderingLayers, RenderingLabels }

Protected Slots
void	renderLayersFinished ()
	layers are rendered, labeling is still pending
void	renderingFinished ()
	all rendering is finished, including labeling

Static Protected Member Functions
static void	renderLayerStatic (LayerRenderJob &job)
static void	renderLabelsStatic (QgsMapRendererParallelJob *self)

Protected Attributes
QImage	mFinalImage
enum QgsMapRendererParallelJob:: { ... }	mStatus
QFuture< void >	mFuture
QFutureWatcher< void >	mFutureWatcher
LayerRenderJobs	mLayerJobs
QgsPalLabeling *	mLabelingEngine
QgsRenderContext	mLabelingRenderContext
QFuture< void >	mLabelingFuture
QFutureWatcher< void >	mLabelingFutureWatcher

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 Member Functions inherited from QgsMapRendererJob
LayerRenderJobs	prepareJobs (QPainter *painter, QgsPalLabeling *labelingEngine)
void	cleanupJobs (LayerRenderJobs &jobs)
bool	needTemporaryImage (QgsMapLayer *ml)
void	updateLayerGeometryCaches ()
	called when rendering has finished to update all layers' geometry caches

Detailed Description

Job implementation that renders all layers in parallel.

The resulting map image can be retrieved with renderedImage() function. It is safe to call that function while rendering is active to see preview of the map.

Note

added in 2.4

Member Enumeration Documentation

anonymous enum

protected

Enumerator:

Idle
RenderingLayers
RenderingLabels

Constructor & Destructor Documentation

QgsMapRendererParallelJob::QgsMapRendererParallelJob

(

const QgsMapSettings &

settings

)

QgsMapRendererParallelJob::~QgsMapRendererParallelJob

(

)

Member Function Documentation

void QgsMapRendererParallelJob::cancel ( )

virtual

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

Does nothing if the rendering is not active.

Implements QgsMapRendererJob.

bool QgsMapRendererParallelJob::isActive ( ) const

virtual

Tell whether the rendering job is currently running in background.

Implements QgsMapRendererJob.

QImage QgsMapRendererParallelJob::renderedImage ( )

virtual

Get a preview/resulting image.

Implements QgsMapRendererQImageJob.

void QgsMapRendererParallelJob::renderingFinished ( )

protectedslot

all rendering is finished, including labeling

void QgsMapRendererParallelJob::renderLabelsStatic ( QgsMapRendererParallelJob *  self )

staticprotected

void QgsMapRendererParallelJob::renderLayersFinished ( )

protectedslot

layers are rendered, labeling is still pending

void QgsMapRendererParallelJob::renderLayerStatic ( LayerRenderJob &  job )

staticprotected

void QgsMapRendererParallelJob::start ( )

virtual

Start the rendering job and immediately return.

Does nothing if the rendering is already in progress.

Implements QgsMapRendererJob.

QgsLabelingResults * QgsMapRendererParallelJob::takeLabelingResults ( )

virtual

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

Implements QgsMapRendererJob.

void QgsMapRendererParallelJob::waitForFinished ( )

virtual

Block until the job has finished.

Implements QgsMapRendererJob.

Member Data Documentation

QImage QgsMapRendererParallelJob::mFinalImage

protected

QFuture<void> QgsMapRendererParallelJob::mFuture

protected

QFutureWatcher<void> QgsMapRendererParallelJob::mFutureWatcher

protected

QgsPalLabeling* QgsMapRendererParallelJob::mLabelingEngine

protected

QFuture<void> QgsMapRendererParallelJob::mLabelingFuture

protected

QFutureWatcher<void> QgsMapRendererParallelJob::mLabelingFutureWatcher

protected

QgsRenderContext QgsMapRendererParallelJob::mLabelingRenderContext

protected

LayerRenderJobs QgsMapRendererParallelJob::mLayerJobs

protected

enum { ... } QgsMapRendererParallelJob::mStatus

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgsmaprendererparalleljob.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgsmaprendererparalleljob.cpp