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

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

#include <qgsmaprendererjob.h>

Inheritance diagram for QgsMapRendererQImageJob:
Inheritance graph

Public Member Functions

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

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

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 188 of file qgsmaprendererjob.h.

Constructor & Destructor Documentation

QgsMapRendererQImageJob::QgsMapRendererQImageJob ( const QgsMapSettings settings)

Definition at line 44 of file qgsmaprendererjob.cpp.

Member Function Documentation

virtual QImage QgsMapRendererQImageJob::renderedImage ( )
pure virtual

Get a preview/resulting image.

Implemented in QgsMapRendererSequentialJob, and QgsMapRendererParallelJob.

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