qgsprofilerenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprofilerenderer.h
                         ---------------
    begin                : March 2022
    copyright            : (C) 2022 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 QGSPROFILERENDERER_H
#define QGSPROFILERENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractprofilegenerator.h"
#include "qgslinesymbol.h"
#include "qgsprofilerequest.h"
#include "qgsrange.h"
 
#include <QFutureWatcher>
#include <QObject>
 
class QgsAbstractProfileSource;
class QgsAbstractProfileGenerator;
class QgsAbstractProfileResults;
class QgsFeedback;
class QgsRenderContext;
class QgsProfileSnapResult;
class QgsProfileSnapContext;
class QgsProfilePoint;

class CORE_EXPORT QgsProfilePlotRenderer : public QObject
{
    Q_OBJECT
 
  public:
    QgsProfilePlotRenderer( const QList< QgsAbstractProfileSource * > &sources, const QgsProfileRequest &request );

    QgsProfilePlotRenderer( std::vector<std::unique_ptr<QgsAbstractProfileGenerator> > generators, const QgsProfileRequest &request ) SIP_SKIP;
 
    ~QgsProfilePlotRenderer() override;

    QStringList sourceIds() const;

    void startGeneration();

    void generateSynchronously();

    void cancelGeneration();

    void cancelGenerationWithoutBlocking();

    void waitForFinished();

    bool isActive() const;

    void setContext( const QgsProfileGenerationContext &context );

    void invalidateAllRefinableSources();

    void replaceSource( QgsAbstractProfileSource *source );

    bool invalidateResults( QgsAbstractProfileSource *source );

    void regenerateInvalidatedResults();

    QgsDoubleRange zRange() const;

    QImage renderToImage( int width, int height, double distanceMin, double distanceMax, double zMin, double zMax, const QString &sourceId = QString(), double devicePixelRatio = 1.0 );

    void render( QgsRenderContext &context, double width, double height, double distanceMin, double distanceMax, double zMin, double zMax, const QString &sourceId = QString() );

    static std::unique_ptr<QgsLineSymbol> defaultSubSectionsSymbol() SIP_FACTORY;

    QgsLineSymbol *subsectionsSymbol();

    void setSubsectionsSymbol( QgsLineSymbol *symbol SIP_TRANSFER );

    void renderSubsectionsIndicator( QgsRenderContext &context, const QRectF &plotArea, double distanceMin, double distanceMax, double zMin, double zMax );

    QgsProfileSnapResult snapPoint( const QgsProfilePoint &point, const QgsProfileSnapContext &context );

    QVector<QgsProfileIdentifyResults> identify( const QgsProfilePoint &point, const QgsProfileIdentifyContext &context );

    QVector<QgsProfileIdentifyResults> identify( const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context );

    QVector< QgsAbstractProfileResults::Feature > asFeatures( Qgis::ProfileExportType type, QgsFeedback *feedback = nullptr );
 
  signals:

    void generationFinished();
 
  private slots:
 
    void onGeneratingFinished();
 
  private:
    static QTransform computeRenderTransform( double width, double height, double distanceMin, double distanceMax, double zMin, double zMax );
 
    struct ProfileJob
    {
        QgsAbstractProfileGenerator *generator = nullptr;
        QgsProfileGenerationContext context;
        std::unique_ptr< QgsAbstractProfileResults > results;
        std::unique_ptr< QgsAbstractProfileResults > invalidatedResults;
        bool complete = false;
        QMutex mutex;
    };
 
    static void generateProfileStatic( std::unique_ptr< ProfileJob > &job );
    bool replaceSourceInternal( QgsAbstractProfileSource *source, bool clearPreviousResults );
 
    std::vector< std::unique_ptr< QgsAbstractProfileGenerator > > mGenerators;
    QgsProfileRequest mRequest;
    QgsProfileGenerationContext mContext;
 
    std::vector< std::unique_ptr< ProfileJob > > mJobs;
 
    QFuture<void> mFuture;
    QFutureWatcher<void> mFutureWatcher;
 
    enum
    {
      Idle,
      Generating
    } mStatus
      = Idle;
 
    std::unique_ptr<QgsLineSymbol> mSubsectionsSymbol;
};
 
#endif // QGSPROFILERENDERER_H