QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
|
Job implementation that renders everything sequentially in one thread. More...
#include <qgsmaprenderersequentialjob.h>
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. | |
void | cancelWithoutBlocking () override |
Triggers cancellation of the rendering job without blocking. | |
bool | isActive () const override |
Tell whether the rendering job is currently running in background. | |
QImage | renderedImage () override |
Gets a preview/resulting image. | |
QgsLabelingResults * | takeLabelingResults () override |
Gets pointer to internal labeling engine (in order to get access to the results). | |
bool | usedCachedLabels () const override |
Returns true if the render job was able to use a cached labeling solution. | |
void | waitForFinished () override |
Block until the job has finished. | |
![]() | |
QgsMapRendererQImageJob (const QgsMapSettings &settings) | |
![]() | |
QgsMapRendererJob (const QgsMapSettings &settings) | |
~QgsMapRendererJob () override | |
Errors | errors () const |
List of errors that happened during the rendering job - available when the rendering has been finished. | |
const QgsFeatureFilterProvider * | featureFilterProvider () const |
Returns the feature filter provider used by the QgsRenderContext of each LayerRenderJob. | |
QgsLabelingEngineFeedback * | labelingEngineFeedback () |
Returns the associated labeling engine feedback object. | |
QgsLabelSink * | labelSink () const |
Returns the label sink associated to this rendering job. | |
QStringList | layersRedrawnFromCache () const |
Returns a list of the layer IDs for all layers which were redrawn from cached images. | |
const QgsMapSettings & | mapSettings () const |
Returns map settings with which this job was started. | |
QHash< QgsMapLayer *, int > | perLayerRenderingTime () const |
Returns the render time (in ms) per layer. | |
int | renderingTime () const |
Returns the total time it took to finish the job (in milliseconds). | |
void | setCache (QgsMapRendererCache *cache) |
Assign a cache to be used for reading and storing rendered images of individual layers. | |
void | setFeatureFilterProvider (const QgsFeatureFilterProvider *f) |
Set the feature filter provider used by the QgsRenderContext of each LayerRenderJob. | |
void | setLabelSink (QgsLabelSink *sink) |
Assigns the label sink which will take over responsibility for handling labels during the rendering job. | |
void | setLayerRenderingTimeHints (const QHash< QString, int > &hints) |
Sets approximate render times (in ms) for map layers. | |
void | start () |
Start the rendering job and immediately return. | |
QgsRenderedItemResults * | takeRenderedItemResults () |
Takes the rendered item results from the map render job and returns them. | |
Additional Inherited Members | |
![]() | |
typedef QList< QgsMapRendererJob::Error > | Errors |
![]() | |
void | finished () |
emitted when asynchronous rendering is finished (or canceled). | |
void | layerRendered (const QString &layerId) |
Emitted when a layer has completed rendering. | |
void | layerRenderingStarted (const QString &layerId) |
Emitted just before rendering starts for a particular layer. | |
void | renderingLayersFinished () |
Emitted when the layers are rendered. | |
![]() | |
static const QString | ELEVATION_MAP_CACHE_PREFIX |
QgsMapRendererCache prefix string for cached elevation map image. | |
static const QString | LABEL_CACHE_ID |
QgsMapRendererCache ID string for cached label image. | |
static const QString | LABEL_PREVIEW_CACHE_ID |
QgsMapRendererCache ID string for cached label image during preview compositions only. | |
static const QgsSettingsEntryBool * | settingsLogCanvasRefreshEvent = new QgsSettingsEntryBool( QStringLiteral( "logCanvasRefreshEvent" ), QgsSettingsTree::sTreeMap, false ) |
Settings entry log canvas refresh event. | |
![]() | |
void | cleanupJobs (std::vector< LayerRenderJob > &jobs) |
void | cleanupLabelJob (LabelRenderJob &job) |
Handles clean up tasks for a label job, including deletion of images and storing cached label results. | |
void | cleanupSecondPassJobs (std::vector< LayerRenderJob > &jobs) |
void | initSecondPassJobs (std::vector< LayerRenderJob > &secondPassJobs, LabelRenderJob &labelJob) const |
Initialize secondPassJobs according to what have been rendered (mask clipping path e.g.) in first pass jobs and labelJob. | |
void | logRenderingTime (const std::vector< LayerRenderJob > &jobs, const std::vector< LayerRenderJob > &secondPassJobs, const LabelRenderJob &labelJob) |
std::vector< LayerRenderJob > | prepareJobs (QPainter *painter, QgsLabelingEngine *labelingEngine2, bool deferredPainterSet=false) |
Creates a list of layer rendering jobs and prepares them for later render. | |
bool | prepareLabelCache () const |
Prepares the cache for storing the result of labeling. | |
LabelRenderJob | prepareLabelingJob (QPainter *painter, QgsLabelingEngine *labelingEngine2, bool canUseLabelCache=true) |
Prepares a labeling job. | |
std::vector< LayerRenderJob > | prepareSecondPassJobs (std::vector< LayerRenderJob > &firstPassJobs, LabelRenderJob &labelJob) |
Prepares jobs for a second pass, if selective masks exist (from labels or symbol layers). | |
![]() | |
static QImage | composeImage (const QgsMapSettings &settings, const std::vector< LayerRenderJob > &jobs, const LabelRenderJob &labelJob, const QgsMapRendererCache *cache=nullptr) |
static void | composeSecondPass (std::vector< LayerRenderJob > &secondPassJobs, LabelRenderJob &labelJob, bool forceVector=false) |
Compose second pass images into first pass images. | |
static Q_DECL_DEPRECATED void | drawLabeling (const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter) |
static void | drawLabeling (QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter) |
static QgsElevationMap | layerElevationToBeComposed (const QgsMapSettings &settings, const LayerRenderJob &job, const QgsMapRendererCache *cache) |
static QImage | layerImageToBeComposed (const QgsMapSettings &settings, const LayerRenderJob &job, const QgsMapRendererCache *cache) |
![]() | |
QgsMapRendererCache * | mCache = nullptr |
Errors | mErrors |
QHash< QString, int > | mLayerRenderingTimeHints |
Approximate expected layer rendering time per layer, by layer ID. | |
QStringList | mLayersRedrawnFromCache |
QHash< QgsWeakMapLayerPointer, int > | mPerLayerRenderingTime |
Render time (in ms) per layer, by layer ID. | |
bool | mRecordRenderingTime = true |
true if layer rendering time should be recorded. | |
std::unique_ptr< QgsRenderedItemResults > | mRenderedItemResults |
QElapsedTimer | mRenderingStart |
int | mRenderingTime = 0 |
QgsMapSettings | mSettings |
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.
Definition at line 32 of file qgsmaprenderersequentialjob.h.
QgsMapRendererSequentialJob::QgsMapRendererSequentialJob | ( | const QgsMapSettings & | settings | ) |
Definition at line 24 of file qgsmaprenderersequentialjob.cpp.
|
override |
Definition at line 37 of file qgsmaprenderersequentialjob.cpp.
|
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 80 of file qgsmaprenderersequentialjob.cpp.
|
overridevirtual |
Triggers cancellation 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 92 of file qgsmaprenderersequentialjob.cpp.
|
slot |
Definition at line 135 of file qgsmaprenderersequentialjob.cpp.
|
overridevirtual |
Tell whether the rendering job is currently running in background.
Implements QgsMapRendererJob.
Definition at line 109 of file qgsmaprenderersequentialjob.cpp.
|
overridevirtual |
Gets a preview/resulting image.
Implements QgsMapRendererQImageJob.
Definition at line 125 of file qgsmaprenderersequentialjob.cpp.
|
overridevirtual |
Gets pointer to internal labeling engine (in order to get access to the results).
This should not be used if cached labeling was redrawn - see usedCachedLabels().
Implements QgsMapRendererJob.
Definition at line 119 of file qgsmaprenderersequentialjob.cpp.
|
overridevirtual |
Returns true
if the render job was able to use a cached labeling solution.
If so, any previously stored labeling results (see takeLabelingResults()) should be retained.
Implements QgsMapRendererJob.
Definition at line 114 of file qgsmaprenderersequentialjob.cpp.
|
overridevirtual |
Block until the job has finished.
Implements QgsMapRendererJob.
Definition at line 101 of file qgsmaprenderersequentialjob.cpp.