QGIS API Documentation  2.4.0-Chugiak
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsMapRendererQImageJob Class Referenceabstract

Intermediate base class adding functionality that allows client to query the rendered image. More...

#include <qgsmaprendererjob.h>

Inheritance diagram for QgsMapRendererQImageJob:
Inheritance graph
Collaboration diagram for QgsMapRendererQImageJob:
Collaboration graph

Public Member Functions

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

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
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 More...
- Static Protected Member Functions inherited from QgsMapRendererJob
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...
static QImage composeImage (const QgsMapSettings &settings, const LayerRenderJobs &jobs)
static void drawLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsPalLabeling *labelingEngine, QPainter *painter)
static void drawOldLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext)
static void drawNewLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsPalLabeling *labelingEngine)
- Protected Attributes inherited from QgsMapRendererJob
QgsMapSettings mSettings
Errors mErrors
QStringList mRequestedGeomCacheForLayers
 list of layer IDs for which the geometry cache should be updated More...
QMap< QString, QgsGeometryCachemGeometryCaches
 map of geometry caches More...
QTime mRenderingStart
int mRenderingTime

Detailed Description

Intermediate base class adding functionality that allows client to query the rendered image.

The image can be queried even while the rendering is still in progress to get intermediate result

added in 2.4

Definition at line 181 of file qgsmaprendererjob.h.

Constructor & Destructor Documentation

QgsMapRendererQImageJob::QgsMapRendererQImageJob ( const QgsMapSettings settings)

Definition at line 43 of file qgsmaprendererjob.cpp.

Member Function Documentation

virtual QImage QgsMapRendererQImageJob::renderedImage ( )
pure virtual

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