qgsmaprendererstagedrenderjob.h

Go to the documentation of this file.

/***************************************************************************
  qgsmaprendererstagedrenderjob.h
  --------------------------------------
  Date                 : August 2019
  Copyright            : (C) 2019 by Nyall Dawson
  Email                : nyall dot dawson 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 QGSMAPRENDERERSTAGEDRENDERJOB_H
#define QGSMAPRENDERERSTAGEDRENDERJOB_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsmaprenderercustompainterjob.h"

#define SIP_NO_FILE

class CORE_EXPORT QgsMapRendererStagedRenderJob : public QgsMapRendererAbstractCustomPainterJob
{
    Q_OBJECT
  public:

    enum Flag
    {
      RenderLabelsByMapLayer = 0x01, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )

    
    enum RenderStage
    {
      Symbology, 
      Labels, 
      Finished, 
    };

    QgsMapRendererStagedRenderJob( const QgsMapSettings &settings, Flags flags = nullptr );
    ~QgsMapRendererStagedRenderJob() override;

    void start() override;
    void cancel() override;
    void cancelWithoutBlocking() override;
    void waitForFinished() override;
    bool isActive() const override;
    bool usedCachedLabels() const override;
    QgsLabelingResults *takeLabelingResults() SIP_TRANSFER override;

    bool renderCurrentPart( QPainter *painter );

    bool nextPart();

    bool isFinished();

    QString currentLayerId();

    RenderStage currentStage() const;

  private:

    std::unique_ptr< QgsLabelingEngine > mLabelingEngineV2;

    LayerRenderJobs mLayerJobs;
    LabelRenderJob mLabelJob;
    LayerRenderJobs::iterator mJobIt;

    bool mNextIsLabel = false;
    bool mExportedLabels = false;
    Flags mFlags = nullptr;
    bool mPreparedStagedLabelJob = false;
    QStringList mLabelingLayers;
    QStringList::iterator mLabelLayerIt;
};

#endif // QGSMAPRENDERERSTAGEDRENDERJOB_H