QGIS API Documentation  2.9.0-Master
Public Slots | Public Member Functions | Protected Attributes | List of all members
QgsMapRendererSequentialJob Class Reference

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

#include <qgsmaprenderersequentialjob.h>

Inheritance diagram for QgsMapRendererSequentialJob:
Inheritance graph
[legend]

Public Slots

void internalFinished ()
 

Public Member Functions

 QgsMapRendererSequentialJob (const QgsMapSettings &settings)
 
 ~QgsMapRendererSequentialJob ()
 
virtual void cancel () override
 Stop the rendering job - does not return until the job has terminated. More...
 
virtual bool isActive () const override
 Tell whether the rendering job is currently running in background. More...
 
virtual QImage renderedImage () override
 Get a preview/resulting image. More...
 
virtual void start () override
 Start the rendering job and immediately return. More...
 
virtual QgsLabelingResultstakeLabelingResults () override
 Get pointer to internal labeling engine (in order to get access to the results) More...
 
virtual 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)
 
virtual ~QgsMapRendererJob ()
 
Errors errors () const
 List of errors that happened during the rendering job - available when the rendering has been finished. 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...
 

Protected Attributes

QImage mImage
 
QgsMapRendererCustomPainterJobmInternalJob
 
QgsLabelingResultsmLabelingResults
 
QPainter * mPainter
 
- Protected Attributes inherited from QgsMapRendererJob
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
 

Additional Inherited Members

- Public Types inherited from QgsMapRendererJob
typedef QList< ErrorErrors
 
- Signals inherited from QgsMapRendererJob
void finished ()
 emitted when asynchronous rendering is finished (or canceled). More...
 
- 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 More...
 
- 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. More...
 

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.

Note
added in 2.4

Definition at line 30 of file qgsmaprenderersequentialjob.h.

Constructor & Destructor Documentation

QgsMapRendererSequentialJob::QgsMapRendererSequentialJob ( const QgsMapSettings settings)

Definition at line 23 of file qgsmaprenderersequentialjob.cpp.

QgsMapRendererSequentialJob::~QgsMapRendererSequentialJob ( )

Definition at line 36 of file qgsmaprenderersequentialjob.cpp.

Member Function Documentation

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 77 of file qgsmaprenderersequentialjob.cpp.

void QgsMapRendererSequentialJob::internalFinished ( )
slot

Definition at line 119 of file qgsmaprenderersequentialjob.cpp.

bool QgsMapRendererSequentialJob::isActive ( ) const
overridevirtual

Tell whether the rendering job is currently running in background.

Implements QgsMapRendererJob.

Definition at line 96 of file qgsmaprenderersequentialjob.cpp.

QImage QgsMapRendererSequentialJob::renderedImage ( )
overridevirtual

Get a preview/resulting image.

Implements QgsMapRendererQImageJob.

Definition at line 109 of file qgsmaprenderersequentialjob.cpp.

void QgsMapRendererSequentialJob::start ( )
overridevirtual

Start the rendering job and immediately return.

Does nothing if the rendering is already in progress.

Implements QgsMapRendererJob.

Definition at line 53 of file qgsmaprenderersequentialjob.cpp.

QgsLabelingResults * QgsMapRendererSequentialJob::takeLabelingResults ( )
overridevirtual

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

Implements QgsMapRendererJob.

Definition at line 101 of file qgsmaprenderersequentialjob.cpp.

void QgsMapRendererSequentialJob::waitForFinished ( )
overridevirtual

Block until the job has finished.

Implements QgsMapRendererJob.

Definition at line 88 of file qgsmaprenderersequentialjob.cpp.

Member Data Documentation

QImage QgsMapRendererSequentialJob::mImage
protected

Definition at line 54 of file qgsmaprenderersequentialjob.h.

QgsMapRendererCustomPainterJob* QgsMapRendererSequentialJob::mInternalJob
protected

Definition at line 53 of file qgsmaprenderersequentialjob.h.

QgsLabelingResults* QgsMapRendererSequentialJob::mLabelingResults
protected

Definition at line 56 of file qgsmaprenderersequentialjob.h.

QPainter* QgsMapRendererSequentialJob::mPainter
protected

Definition at line 55 of file qgsmaprenderersequentialjob.h.


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