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.h"
#include "qgis_core.h"
#include "qgsannotation.h"
#include "qgsannotationmanager.h"
#include "qgsmapsettings.h"
#include "qgsmapdecoration.h"
#include "qgstaskmanager.h"
#include "qgsmaprenderercustompainterjob.h"

#include <QPainter>
class QgsMapRendererCustomPainterJob;

class CORE_EXPORT QgsMapRendererTask : public QgsTask
{
    Q_OBJECT

  public:

    enum ErrorType
    {
      ImageAllocationFail = 1,  // Image allocation failure
      ImageSaveFail             // Image save failure
    };

    QgsMapRendererTask( const QgsMapSettings &ms,
                        const QString &fileName,
                        const QString &fileFormat = QString( "PNG" ),
                        const bool forceRaster = false );

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

    void addAnnotations( QList< QgsAnnotation * > annotations );

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

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

    void cancel() override;

  signals:

    void renderingComplete();

    void errorOccurred( int error );

  protected:

    bool run() override;
    void finished( bool result ) override;

  private:

    QgsMapSettings mMapSettings;

    QMutex mJobMutex;
    std::unique_ptr< QgsMapRendererCustomPainterJob > mJob;

    QPainter *mPainter = nullptr;

    QString mFileName;
    QString mFileFormat;
    bool mForceRaster = false;
    bool mSaveWorldFile = false;

    QList< QgsAnnotation * > mAnnotations;
    QList< QgsMapDecoration * > mDecorations;

    int mError = 0;
};

// clazy:excludeall=qstring-allocations

#endif