26#include <QtConcurrentRun>
48 QPaintDevice *paintDevice = painter->device();
49 const QString errMsg = QStringLiteral(
"pre-set DPI not equal to painter's DPI (%1 vs %2)" )
50 .arg( paintDevice->logicalDpiX() )
53 "Job::startRender()", errMsg.toLatin1().data() );
66 , mRenderSynchronously( false )
74 Q_ASSERT( !mFutureWatcher.isRunning() );
78void QgsMapRendererCustomPainterJob::startPrivate()
92 QgsDebugMsgLevel( QStringLiteral(
"Preparing list of layer jobs for rendering" ), 5 );
93 QElapsedTimer prepareTime;
98 mLabelingEngineV2.reset();
103 mLabelingEngineV2->setMapSettings(
mSettings );
107 mLayerJobs =
prepareJobs( mPainter, mLabelingEngineV2.get() );
108 mLabelJob =
prepareLabelingJob( mPainter, mLabelingEngineV2.get(), canUseLabelCache );
111 QgsDebugMsgLevel( QStringLiteral(
"Rendering prepared in (seconds): %1" ).arg( prepareTime.elapsed() / 1000.0 ), 4 );
113 if ( mRenderSynchronously )
124 connect( &mFutureWatcher, &QFutureWatcher<void>::finished,
this, &QgsMapRendererCustomPainterJob::futureFinished );
126 mFuture = QtConcurrent::run( staticRender,
this );
127 mFutureWatcher.setFuture( mFuture );
140 disconnect( &mFutureWatcher, &QFutureWatcher<void>::finished,
this, &QgsMapRendererCustomPainterJob::futureFinished );
146 mFutureWatcher.waitForFinished();
148 QgsDebugMsgLevel( QStringLiteral(
"QPAINER cancel waited %1 ms" ).arg( t.elapsed() / 1000.0 ), 5 );
163 mLabelJob.context.setRenderingStopped(
true );
164 for ( LayerRenderJob &job : mLayerJobs )
166 job.context()->setRenderingStopped(
true );
167 if ( job.renderer && job.renderer->feedback() )
168 job.renderer->feedback()->cancel();
177 disconnect( &mFutureWatcher, &QFutureWatcher<void>::finished,
this, &QgsMapRendererCustomPainterJob::futureFinished );
182 mFutureWatcher.waitForFinished();
184 QgsDebugMsgLevel( QStringLiteral(
"waitForFinished: %1 ms" ).arg( t.elapsed() / 1000.0 ), 4 );
196 return mLabelJob.cached;
201 if ( mLabelingEngineV2 )
202 return mLabelingEngineV2->takeResults();
211 connect( &mFutureWatcher, &QFutureWatcher<void>::finished, &loop, &QEventLoop::quit );
218 mRenderSynchronously =
true;
221 mRenderSynchronously =
false;
226 mRenderSynchronously =
true;
239 mRenderSynchronously =
false;
240 mPrepareOnly =
false;
244void QgsMapRendererCustomPainterJob::futureFinished()
274 catch ( std::exception &e )
277 QgsDebugError(
"Caught unhandled std::exception: " + QString::fromLatin1( e.what() ) );
281 QgsDebugError( QStringLiteral(
"Caught unhandled unknown exception" ) );
285void QgsMapRendererCustomPainterJob::doRender()
287 const bool hasSecondPass = ! mSecondPassLayerJobs.empty();
289 QElapsedTimer renderTime;
293 std::unique_ptr<QgsElevationMap> mainElevationMap;
294 if ( mapShadingRenderer.
isActive() )
297 for ( LayerRenderJob &job : mLayerJobs )
299 if ( job.context()->renderingStopped() )
304 if ( ! hasSecondPass && job.context()->useAdvancedEffects() )
308 mPainter->setCompositionMode( job.blendMode );
313 QElapsedTimer layerTime;
316 if ( job.previewRenderImage && !job.previewRenderImageInitialized )
318 job.previewRenderImage->fill( 0 );
319 job.previewRenderImageInitialized =
true;
325 job.imageInitialized =
true;
328 job.completed = job.renderer->render();
332 job.renderer->renderContext()->painter()->end();
335 job.renderingTime += layerTime.elapsed();
338 if ( ! hasSecondPass && job.img )
341 mPainter->setOpacity( job.opacity );
342 mPainter->drawImage( 0, 0, *job.img );
343 mPainter->setOpacity( 1.0 );
346 if ( mainElevationMap && job.context()->elevationMap() )
348 const QgsElevationMap &layerElevationMap = *job.context()->elevationMap();
349 if ( layerElevationMap.
isValid() )
359 if ( mapShadingRenderer.
isActive() && mainElevationMap )
361 QImage image( mainElevationMap->rawElevationImage().size(), QImage::Format_RGB32 );
363 image.fill( Qt::white );
366 mPainter->setCompositionMode( QPainter::CompositionMode_Multiply );
367 mPainter->drawImage( 0, 0, image );
373 if ( !mLabelJob.cached )
375 QElapsedTimer labelTime;
381 mLabelJob.img->fill( 0 );
382 painter.begin( mLabelJob.img );
383 mLabelJob.context.setPainter( &painter );
384 drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), &painter );
387 else if ( mLabelJob.picture )
390 painter.begin( mLabelJob.picture.get() );
391 mLabelJob.context.setPainter( &painter );
392 drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), &painter );
397 drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), mPainter );
400 mLabelJob.complete =
true;
401 mLabelJob.renderingTime = labelTime.elapsed();
406 if ( ! hasSecondPass )
408 if ( mLabelJob.img && mLabelJob.complete )
410 mPainter->setCompositionMode( QPainter::CompositionMode_SourceOver );
411 mPainter->setOpacity( 1.0 );
412 mPainter->drawImage( 0, 0, *mLabelJob.img );
419 for ( LayerRenderJob &job : mSecondPassLayerJobs )
421 if ( job.context()->renderingStopped() )
426 QElapsedTimer layerTime;
429 if ( job.previewRenderImage && !job.previewRenderImageInitialized )
431 job.previewRenderImage->fill( 0 );
432 job.previewRenderImageInitialized =
true;
438 job.imageInitialized =
true;
441 job.completed = job.renderer->render();
445 job.renderer->renderContext()->painter()->end();
448 job.renderingTime += layerTime.elapsed();
459 mPainter->setCompositionMode( QPainter::CompositionMode_SourceOver );
460 mPainter->setOpacity( 1.0 );
461 mPainter->drawImage( 0, 0, finalImage );
466 for ( LayerRenderJob &job : mLayerJobs )
474 mPainter->drawImage( 0, 0, *job.img );
477 if ( mLabelJob.picture )
484 QgsDebugMsgLevel( QStringLiteral(
"Rendering completed in (seconds): %1" ).arg( renderTime.elapsed() / 1000.0 ), 2 );
@ ForceVectorOutput
Vector graphics should not be cached and drawn as raster images.
@ ForceRasterMasks
Force symbol masking to be applied using a raster method. This is considerably faster when compared t...
@ LosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ Antialiasing
Enable anti-aliasing for map rendering.
@ DrawLabeling
Enable drawing of labels on top of the map.
@ HighQualityImageTransforms
Enable high quality image transformations, which results in better appearance of scaled or rotated ra...
Default QgsLabelingEngine implementation, which completes the whole labeling operation (including lab...
Stores digital elevation model in a raster image which may get updated as a part of map layer renderi...
void combine(const QgsElevationMap &otherElevationMap, Qgis::ElevationMapCombineMethod method)
Combines this elevation map with otherElevationMap.
bool isValid() const
Returns whether the elevation map is valid.
This class can render elevation shading on an image with different methods (eye dome lighting,...
Qgis::ElevationMapCombineMethod combinedElevationMethod() const
Returns the method used when conbining different elevation sources.
bool isActive() const
Returns whether this shading renderer is active.
void renderShading(const QgsElevationMap &elevation, QImage &image, const QgsRenderContext &context) const
Render shading on image condidering the elevation map elevation and the renderer context context If e...
Defines a QGIS exception class.
Class that stores computed placement from labeling engine.
Abstract base class for map renderer jobs which use custom painters.
void preparePainter(QPainter *painter, const QColor &backgroundColor=Qt::transparent)
Prepares the given painter ready for a map render.
QgsMapRendererAbstractCustomPainterJob(const QgsMapSettings &settings)
Constructor for QgsMapRendererAbstractCustomPainterJob, using the given map settings.
Job implementation that renders everything sequentially using a custom painter.
QgsMapRendererCustomPainterJob(const QgsMapSettings &settings, QPainter *painter)
~QgsMapRendererCustomPainterJob() override
void renderSynchronously()
Render the map synchronously in this thread.
void cancel() override
Stop the rendering job - does not return until the job has terminated.
void waitForFinishedWithEventLoop(QEventLoop::ProcessEventsFlags flags=QEventLoop::AllEvents)
Wait for the job to be finished - and keep the thread's event loop running while waiting.
void renderPrepared()
Render a pre-prepared job.
QgsLabelingResults * takeLabelingResults() override
Gets pointer to internal labeling engine (in order to get access to the results).
void cancelWithoutBlocking() override
Triggers cancellation of the rendering job without blocking.
void prepare()
Prepares the job for rendering synchronously in a background thread.
void waitForFinished() override
Block until the job has finished.
bool isActive() const override
Tell whether the rendering job is currently running in background.
bool usedCachedLabels() const override
Returns true if the render job was able to use a cached labeling solution.
Abstract base class for map rendering implementations.
void logRenderingTime(const std::vector< LayerRenderJob > &jobs, const std::vector< LayerRenderJob > &secondPassJobs, const LabelRenderJob &labelJob)
QList< QPointer< QgsMapLayer > > participatingLabelLayers(QgsLabelingEngine *engine)
Returns a list of the layers participating in the map labeling.
static QImage composeImage(const QgsMapSettings &settings, const std::vector< LayerRenderJob > &jobs, const LabelRenderJob &labelJob, const QgsMapRendererCache *cache=nullptr)
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....
static Q_DECL_DEPRECATED void drawLabeling(const QgsMapSettings &settings, QgsRenderContext &renderContext, QgsLabelingEngine *labelingEngine2, QPainter *painter)
void layerRendered(const QString &layerId)
Emitted when a layer has completed rendering.
std::vector< LayerRenderJob > prepareJobs(QPainter *painter, QgsLabelingEngine *labelingEngine2, bool deferredPainterSet=false)
Creates a list of layer rendering jobs and prepares them for later render.
void renderingLayersFinished()
Emitted when the layers are rendered.
void cleanupJobs(std::vector< LayerRenderJob > &jobs)
QElapsedTimer mRenderingStart
void finished()
emitted when asynchronous rendering is finished (or canceled).
void start()
Start the rendering job and immediately return.
void layerRenderingStarted(const QString &layerId)
Emitted just before rendering starts for a particular layer.
static void composeSecondPass(std::vector< LayerRenderJob > &secondPassJobs, LabelRenderJob &labelJob, bool forceVector=false)
Compose second pass images into first pass images.
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).
LabelRenderJob prepareLabelingJob(QPainter *painter, QgsLabelingEngine *labelingEngine2, bool canUseLabelCache=true)
Prepares a labeling job.
void cleanupLabelJob(LabelRenderJob &job)
Handles clean up tasks for a label job, including deletion of images and storing cached label results...
bool prepareLabelCache() const
Prepares the cache for storing the result of labeling.
The QgsMapSettings class contains configuration for rendering of the map.
QSize deviceOutputSize() const
Returns the device output size of the map render.
QColor backgroundColor() const
Returns the background color of the map.
float devicePixelRatio() const
Returns the device pixel ratio.
const QgsElevationShadingRenderer & elevationShadingRenderer() const
Returns the shading renderer used to render shading on the entire map.
double outputDpi() const
Returns the DPI (dots per inch) used for conversion between real world units (e.g.
bool testFlag(Qgis::MapSettingsFlag flag) const
Check whether a particular flag is enabled.
static void drawPicture(QPainter *painter, const QPointF &point, const QPicture &picture)
Draws a picture onto a painter, correctly applying workarounds to avoid issues with incorrect scaling...
static QgsRenderContext fromMapSettings(const QgsMapSettings &mapSettings)
create initialized QgsRenderContext instance from given QgsMapSettings
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)