qgsmaprenderertask.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmaprenderertask.h
                          -------------------------
    begin                : Apr 2017
    copyright            : (C) 2017 by Mathieu Pellerin
    email                : nirvn dot asia at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSMAPRENDERERTASK_H
#define QGSMAPRENDERERTASK_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractgeopdfexporter.h"
#include "qgsannotation.h"
#include "qgsannotationmanager.h"
#include "qgsmapdecoration.h"
#include "qgsmaprenderercustompainterjob.h"
#include "qgsmapsettings.h"
#include "qgstaskmanager.h"
 
#include <QPainter>
#include <QPdfWriter>
 
class QgsMapRendererCustomPainterJob;
class QgsAbstractGeospatialPdfExporter;

class CORE_EXPORT QgsMapRendererTask : public QgsTask
{
    Q_OBJECT
 
  public:

    enum ErrorType
    {
      ImageAllocationFail = 1, 
      ImageSaveFail, 
      ImageUnsupportedFormat 
    };
 
#ifndef SIP_RUN

    QgsMapRendererTask( const QgsMapSettings &ms,
                        const QString &fileName,
                        const QString &fileFormat = QString( "PNG" ),
                        bool forceRaster = false,
                        QgsTask::Flags flags = QgsTask::CanCancel, bool geospatialPdf = false, const QgsAbstractGeospatialPdfExporter::ExportDetails &geospatialPdfExportDetails = QgsAbstractGeospatialPdfExporter::ExportDetails()
                      );
#else

    QgsMapRendererTask( const QgsMapSettings &ms,
                        const QString &fileName,
                        const QString &fileFormat = QString( "PNG" ),
                        bool forceRaster = false,
                        QgsTask::Flags flags = QgsTask::CanCancel );
#endif

    QgsMapRendererTask( const QgsMapSettings &ms,
                        QPainter *p );
 
    ~QgsMapRendererTask() override;

    void addAnnotations( const QList<QgsAnnotation *> &annotations );

    void addDecorations( const QList<QgsMapDecoration *> &decorations );

    void setSaveWorldFile( bool save ) { mSaveWorldFile = save; }

    void setExportMetadata( bool exportMetadata ) { mExportMetadata = exportMetadata; }
 
    void cancel() override;
 
  signals:

    void renderingComplete();

    void errorOccurred( int error );
 
  protected:
 
    bool run() override;
    void finished( bool result ) override;
 
  private:

    void prepare();
    bool mErrored = false;
 
    QgsMapSettings mMapSettings;
 
    QMutex mJobMutex;
    std::unique_ptr< QgsMapRendererJob > mJob;
 
    std::unique_ptr< QgsAbstractGeospatialPdfExporter > mGeospatialPdfExporter;
    std::unique_ptr< QgsRenderedFeatureHandlerInterface > mRenderedFeatureHandler;
 
    QPainter *mPainter = nullptr;
    QPainter *mDestPainter = nullptr;
    QImage mImage;
    std::unique_ptr< QPdfWriter > mPdfWriter;
 
    std::unique_ptr< QPainter > mTempPainter;
 
    QString mFileName;
    QString mFileFormat;
    bool mForceRaster = false;
    bool mSaveWorldFile = false;
    bool mExportMetadata = false;
    bool mGeospatialPDF = false;
    QgsAbstractGeospatialPdfExporter::ExportDetails mGeospatialPdfExportDetails;
 
    QList< QgsAnnotation * > mAnnotations;
    QList< QgsMapDecoration * > mDecorations;
    QMap< QString, QString> mLayerIdToLayerNameMap;
    QStringList mMapLayerOrder;
 
    int mError = 0;
 
 
};
 
// clazy:excludeall=qstring-allocations
 
#endif