QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsmaprendererparalleljob.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaprendererparalleljob.h
3  --------------------------------------
4  Date : December 2013
5  Copyright : (C) 2013 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSMAPRENDERERPARALLELJOB_H
17 #define QGSMAPRENDERERPARALLELJOB_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 #include "qgsmaprendererjob.h"
22 
33 {
34  Q_OBJECT
35  public:
36  QgsMapRendererParallelJob( const QgsMapSettings &settings );
37  ~QgsMapRendererParallelJob() override;
38 
39  void start() override;
40  void cancel() override;
41  void cancelWithoutBlocking() override;
42  void waitForFinished() override;
43  bool isActive() const override;
44 
45  bool usedCachedLabels() const override;
47 
48  // from QgsMapRendererJobWithPreview
49  QImage renderedImage() override;
50 
51  private slots:
53  void renderLayersFinished();
55  void renderLayersSecondPassFinished();
57  void renderingFinished();
58 
59  private:
60 
62  static void renderLayerStatic( LayerRenderJob &job ) SIP_SKIP;
64  static void renderLabelsStatic( QgsMapRendererParallelJob *self ) SIP_SKIP;
65 
66  QImage mFinalImage;
67 
69  enum { Idle, RenderingLayers, RenderingSecondPass, RenderingLabels } mStatus SIP_SKIP;
70 
71  QFuture<void> mFuture;
72  QFutureWatcher<void> mFutureWatcher;
73 
74  LayerRenderJobs mLayerJobs;
75  LabelRenderJob mLabelJob;
76 
77  LayerRenderJobs mSecondPassLayerJobs;
78  QFuture<void> mSecondPassFuture;
79  QFutureWatcher<void> mSecondPassFutureWatcher;
80 
82  std::unique_ptr< QgsLabelingEngine > mLabelingEngineV2;
83  QFuture<void> mLabelingFuture;
84  QFutureWatcher<void> mLabelingFutureWatcher;
85 
86 };
87 
88 
89 #endif // QGSMAPRENDERERPARALLELJOB_H
QgsMapRendererJob::usedCachedLabels
virtual bool usedCachedLabels() const =0
Returns true if the render job was able to use a cached labeling solution.
QgsMapRendererJob::isActive
virtual bool isActive() const =0
Tell whether the rendering job is currently running in background.
QgsMapRendererQImageJob::renderedImage
virtual QImage renderedImage()=0
Gets a preview/resulting image.
QgsLabelingResults
Class that stores computed placement from labeling engine.
Definition: qgspallabeling.h:1224
QgsMapRendererParallelJob
Job implementation that renders all layers in parallel.
Definition: qgsmaprendererparalleljob.h:33
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
QgsMapRendererJob::waitForFinished
virtual void waitForFinished()=0
Block until the job has finished.
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition: qgis_sip.h:36
qgsmaprendererjob.h
QgsMapRendererJob::start
virtual void start()=0
Start the rendering job and immediately return.
QgsMapRendererQImageJob
Intermediate base class adding functionality that allows client to query the rendered image.
Definition: qgsmaprendererjob.h:440
QgsMapRendererJob::cancelWithoutBlocking
virtual void cancelWithoutBlocking()=0
Triggers cancellation of the rendering job without blocking.
QgsMapRendererJob::takeLabelingResults
virtual QgsLabelingResults * takeLabelingResults()=0
Gets pointer to internal labeling engine (in order to get access to the results).
QgsMapRendererJob::cancel
virtual void cancel()=0
Stop the rendering job - does not return until the job has terminated.
QgsMapSettings
The QgsMapSettings class contains configuration for rendering of the map.
Definition: qgsmapsettings.h:88