Job implementation that renders everything sequentially in one thread. More...

#include <qgsmaprenderersequentialjob.h>

Inheritance diagram for QgsMapRendererSequentialJob:

Public Slots
void	internalFinished ()

Public Member Functions
	QgsMapRendererSequentialJob (const QgsMapSettings &settings)

	~QgsMapRendererSequentialJob () override

void	cancel () override
	Stop the rendering job - does not return until the job has terminated. More...

void	cancelWithoutBlocking () override
	Triggers cancelation of the rendering job without blocking. More...

bool	isActive () const override
	Tell whether the rendering job is currently running in background. More...

QImage	renderedImage () override
	Get a preview/resulting image. More...

void	start () override
	Start the rendering job and immediately return. More...

QgsLabelingResults *	takeLabelingResults () override
	Get pointer to internal labeling engine (in order to get access to the results). More...

bool	usedCachedLabels () const override
	Returns true if the render job was able to use a cached labeling solution. More...

void	waitForFinished () override
	Block until the job has finished. More...

Public Member Functions inherited from QgsMapRendererQImageJob
	QgsMapRendererQImageJob (const QgsMapSettings &settings)

Public Member Functions inherited from QgsMapRendererJob
	QgsMapRendererJob (const QgsMapSettings &settings)

Errors	errors () const
	List of errors that happened during the rendering job - available when the rendering has been finished. More...

const QgsFeatureFilterProvider *	featureFilterProvider () const

const QgsMapSettings &	mapSettings () const
	Return map settings with which this job was started. More...

QHash< QgsMapLayer *, int >	perLayerRenderingTime () const
	Returns the render time (in ms) per layer. More...

int	renderingTime () const
	Returns the total time it took to finish the job (in milliseconds). More...

void	setCache (QgsMapRendererCache *cache)
	Assign a cache to be used for reading and storing rendered images of individual layers. More...

void	setFeatureFilterProvider (const QgsFeatureFilterProvider *f)

Additional Inherited Members
Public Types inherited from QgsMapRendererJob
typedef QList< QgsMapRendererJob::Error >	Errors

Signals inherited from QgsMapRendererJob
void	finished ()
	emitted when asynchronous rendering is finished (or canceled). More...

void	renderingLayersFinished ()
	Emitted when the layers are rendered. More...

Static Public Attributes inherited from QgsMapRendererJob
static const QString	LABEL_CACHE_ID
	QgsMapRendererCache ID string for cached label image. More...

Protected Member Functions inherited from QgsMapRendererJob
void	cleanupJobs (LayerRenderJobs &jobs)

void	cleanupLabelJob (LabelRenderJob &job)
	Handles clean up tasks for a label job, including deletion of images and storing cached label results. More...

void	logRenderingTime (const LayerRenderJobs &jobs, const LabelRenderJob &labelJob)

LayerRenderJobs	prepareJobs (QPainter painter, QgsLabelingEngine labelingEngine2)

bool	prepareLabelCache () const
	Prepares the cache for storing the result of labeling. More...

LabelRenderJob	prepareLabelingJob (QPainter painter, QgsLabelingEngine labelingEngine2, bool canUseLabelCache=true)
	Prepares a labeling job. More...

Static Protected Member Functions inherited from QgsMapRendererJob
static QImage	composeImage (const QgsMapSettings &settings, const LayerRenderJobs &jobs, const LabelRenderJob &labelJob)

static void	drawLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine labelingEngine2, QPainter painter)

Protected Attributes inherited from QgsMapRendererJob
QgsMapRendererCache *	mCache = nullptr

Errors	mErrors

QHash< QgsWeakMapLayerPointer, int >	mPerLayerRenderingTime
	Render time (in ms) per layer, by layer ID. More...

QTime	mRenderingStart

int	mRenderingTime = 0

QgsMapSettings	mSettings

Detailed Description

Job implementation that renders everything sequentially in one thread.

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.

Since: QGIS 2.4

Definition at line 33 of file qgsmaprenderersequentialjob.h.

Constructor & Destructor Documentation

◆ QgsMapRendererSequentialJob()

QgsMapRendererSequentialJob::QgsMapRendererSequentialJob ( const QgsMapSettings & settings )

Definition at line 22 of file qgsmaprenderersequentialjob.cpp.

◆ ~QgsMapRendererSequentialJob()

QgsMapRendererSequentialJob::~QgsMapRendererSequentialJob ( )

override

Definition at line 34 of file qgsmaprenderersequentialjob.cpp.

Member Function Documentation

◆ cancel()

void QgsMapRendererSequentialJob::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 74 of file qgsmaprenderersequentialjob.cpp.

◆ cancelWithoutBlocking()

void QgsMapRendererSequentialJob::cancelWithoutBlocking ( )

overridevirtual

Triggers cancelation of the rendering job without blocking.

The render job will continue to operate until it is able to cancel, at which stage the finished() signal will be emitted. Does nothing if the rendering is not active.

Implements QgsMapRendererJob.

Definition at line 85 of file qgsmaprenderersequentialjob.cpp.