QGIS API Documentation  2.99.0-Master (c558d51)
Classes | Public Types | Signals | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
QgsMapRendererJob Class Referenceabstract

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

#include <qgsmaprendererjob.h>

Inheritance diagram for QgsMapRendererJob:
Inheritance graph
[legend]

Classes

struct  Error
 

Public Types

typedef QList< ErrorErrors
 

Signals

void finished ()
 emitted when asynchronous rendering is finished (or canceled). More...
 
void renderingLayersFinished ()
 Emitted when the layers are rendered. More...
 

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. More...
 
Errors errors () const
 List of errors that happened during the rendering job - available when the rendering has been finished. More...
 
virtual bool isActive () const =0
 Tell whether the rendering job is currently running in background. More...
 
const QgsMapSettingsmapSettings () const
 Return map settings with which this job was started. More...
 
int renderingTime () const
 Find out how log it took to finish the job (in miliseconds) More...
 
void setCache (QgsMapRendererCache *cache)
 Assign a cache to be used for reading and storing rendered images of individual layers. More...
 
void setRequestedGeometryCacheForLayers (const QStringList &layerIds)
 Set which vector layers should be cached while rendering. More...
 
virtual void start ()=0
 Start the rendering job and immediately return. More...
 
virtual QgsLabelingResultstakeLabelingResults ()=0
 Get pointer to internal labeling engine (in order to get access to the results) More...
 
virtual void waitForFinished ()=0
 Block until the job has finished. More...
 

Protected Member Functions

void cleanupJobs (LayerRenderJobs &jobs)
 
void logRenderingTime (const LayerRenderJobs &jobs)
 
bool needTemporaryImage (QgsMapLayer *ml)
 
LayerRenderJobs prepareJobs (QPainter *painter, QgsLabelingEngine *labelingEngine2)
 
void updateLayerGeometryCaches ()
 called when rendering has finished to update all layers' geometry caches More...
 

Static Protected Member Functions

static QImage composeImage (const QgsMapSettings &settings, const LayerRenderJobs &jobs)
 
static void drawLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter)
 
static bool reprojectToLayerExtent (const QgsMapLayer *ml, const QgsCoordinateTransform &ct, 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. More...
 

Protected Attributes

QgsMapRendererCachemCache
 
Errors mErrors
 
QMap< QString, QgsGeometryCachemGeometryCaches
 map of geometry caches More...
 
QTime mRenderingStart
 
int mRenderingTime
 
QStringList mRequestedGeomCacheForLayers
 list of layer IDs for which the geometry cache should be updated More...
 
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, ...)

  1. create QgsMapRendererJob subclass with QgsMapSettings instance
  2. connect to job's finished() signal
  3. call start(). Map rendering will start in background, the function immediately returns
  4. 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:

Note
added in 2.4

Definition at line 82 of file qgsmaprendererjob.h.

Member Typedef Documentation

Definition at line 119 of file qgsmaprendererjob.h.

Constructor & Destructor Documentation

QgsMapRendererJob::QgsMapRendererJob ( const QgsMapSettings settings)

Definition at line 37 of file qgsmaprendererjob.cpp.

virtual QgsMapRendererJob::~QgsMapRendererJob ( )
inlinevirtual

Definition at line 89 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 319 of file qgsmaprendererjob.cpp.

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

Definition at line 355 of file qgsmaprendererjob.cpp.

void QgsMapRendererJob::drawLabeling ( const QgsMapSettings settings,
QgsRenderContext renderContext,
QgsLabelingEngine labelingEngine2,
QPainter *  painter 
)
staticprotected
Note
not available in Python bindings

Definition at line 274 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 51 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.

void QgsMapRendererJob::logRenderingTime ( const LayerRenderJobs jobs)
protected
Note
not available in python bindings

Definition at line 378 of file qgsmaprendererjob.cpp.

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 61 of file qgsmaprendererjob.cpp.

bool QgsMapRendererJob::needTemporaryImage ( QgsMapLayer ml)
protected

Definition at line 314 of file qgsmaprenderercustompainterjob.cpp.

LayerRenderJobs QgsMapRendererJob::prepareJobs ( QPainter *  painter,
QgsLabelingEngine labelingEngine2 
)
protected
Note
not available in python bindings

Definition at line 171 of file qgsmaprendererjob.cpp.

void QgsMapRendererJob::renderingLayersFinished ( )
signal

Emitted when the layers are rendered.

Rendering labels is not yet done. If the fully rendered layer including labels is required use finished() instead.

Note
Added in QGIS 3.0
int QgsMapRendererJob::renderingTime ( ) const
inline

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

Definition at line 134 of file qgsmaprendererjob.h.

bool QgsMapRendererJob::reprojectToLayerExtent ( const QgsMapLayer ml,
const QgsCoordinateTransform ct,
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 67 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 56 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 131 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 301 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 189 of file qgsmaprendererjob.h.

Errors QgsMapRendererJob::mErrors
protected

Definition at line 187 of file qgsmaprendererjob.h.

QMap<QString, QgsGeometryCache> QgsMapRendererJob::mGeometryCaches
protected

map of geometry caches

Definition at line 194 of file qgsmaprendererjob.h.

QTime QgsMapRendererJob::mRenderingStart
protected

Definition at line 196 of file qgsmaprendererjob.h.

int QgsMapRendererJob::mRenderingTime
protected

Definition at line 197 of file qgsmaprendererjob.h.

QStringList QgsMapRendererJob::mRequestedGeomCacheForLayers
protected

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

Definition at line 192 of file qgsmaprendererjob.h.

QgsMapSettings QgsMapRendererJob::mSettings
protected

Definition at line 186 of file qgsmaprendererjob.h.


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