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 = Flags() );
    ~QgsMapRendererStagedRenderJob() 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() const;

    QString currentLayerId() const;

    double currentLayerOpacity() const;

    QPainter::CompositionMode currentLayerCompositionMode() const;

    RenderStage currentStage() const;
 
  private:
 
    void startPrivate() override;
 
    std::unique_ptr< QgsLabelingEngine > mLabelingEngineV2;
 
    std::vector< LayerRenderJob > mLayerJobs;
    LabelRenderJob mLabelJob;
    std::vector< LayerRenderJob >::iterator mJobIt;
 
    bool mNextIsLabel = false;
    bool mExportedLabels = false;
    Flags mFlags = Flags();
    bool mPreparedStagedLabelJob = false;
    QStringList mLabelingLayers;
    QStringList::iterator mLabelLayerIt;
};
 
#endif // QGSMAPRENDERERSTAGEDRENDERJOB_H