qgsabstractprofilegenerator.h

Go to the documentation of this file.

/***************************************************************************
                         qgsabstractprofilegenerator.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 QGSABSTRACTPROFILEGENERATOR_H
#define QGSABSTRACTPROFILEGENERATOR_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrendercontext.h"
 
#include <QList>
#include <QTransform>
 
class QgsProfileSnapResult;
class QgsProfileSnapContext;
class QgsProfilePoint;
class QgsGeometry;

class CORE_EXPORT QgsProfileRenderContext
{
  public:
    QgsProfileRenderContext( QgsRenderContext &context );

    QgsRenderContext &renderContext() { return mRenderContext; }

    const QTransform &worldTransform() const;

    void setWorldTransform( const QTransform &transform );

    QgsDoubleRange distanceRange() const;

    void setDistanceRange( const QgsDoubleRange &range );

    QgsDoubleRange elevationRange() const;

    void setElevationRange( const QgsDoubleRange &range );
 
  private:
    QgsRenderContext mRenderContext;
 
    QTransform mWorldTransform;
 
    QgsDoubleRange mDistanceRange;
    QgsDoubleRange mElevationRange;
};
 

class CORE_EXPORT QgsProfileIdentifyContext
{
  public:
    double maximumSurfaceDistanceDelta = 0;

    double maximumSurfaceElevationDelta = 0;

    double maximumPointDistanceDelta = 0;

    double maximumPointElevationDelta = 0;

    double displayRatioElevationVsDistance = 1;

    QgsProject *project = nullptr;
};
 
 
class QgsAbstractProfileGenerator;

class CORE_EXPORT QgsProfileIdentifyResults
{
  public:
    QgsProfileIdentifyResults( QgsMapLayer *layer = nullptr, const QVector< QVariantMap> &results = QVector< QVariantMap>() );

    QgsMapLayer *layer() const { return mLayer; }

    QVector<QVariantMap> results() const { return mResults; }
 
  private:
    QPointer< QgsMapLayer > mLayer = nullptr;
 
    QVector<QVariantMap> mResults;
};

class CORE_EXPORT QgsAbstractProfileResults
{
  public:
    struct Feature
    {
        QString layerIdentifier;
        QgsGeometry geometry;
        QVariantMap attributes;
    };
 
    virtual ~QgsAbstractProfileResults();

    virtual QString type() const = 0;

    virtual QMap< double, double > distanceToHeightMap() const = 0;

    virtual QgsPointSequence sampledPoints() const = 0;

    virtual QVector< QgsGeometry > asGeometries() const = 0;

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

    virtual void renderResults( QgsProfileRenderContext &context ) = 0;

    virtual QgsDoubleRange zRange() const = 0;

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

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

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

    virtual void copyPropertiesFromGenerator( const QgsAbstractProfileGenerator *generator );
};

class CORE_EXPORT QgsProfileGenerationContext
{
  public:
    double maximumErrorMapUnits() const { return mMaxErrorMapUnits; }

    void setMaximumErrorMapUnits( double error ) { mMaxErrorMapUnits = error; }

    double mapUnitsPerDistancePixel() const { return mMapUnitsPerDistancePixel; }

    void setMapUnitsPerDistancePixel( double units ) { mMapUnitsPerDistancePixel = units; }

    QgsDoubleRange distanceRange() const { return mDistanceRange; }

    void setDistanceRange( const QgsDoubleRange &range ) { mDistanceRange = range; }

    QgsDoubleRange elevationRange() const { return mElevationRange; }

    void setElevationRange( const QgsDoubleRange &range ) { mElevationRange = range; }

    void setDpi( double dpi ) { mDpi = dpi; }

    double dpi() const { return mDpi; }

    double convertDistanceToPixels( double size, Qgis::RenderUnit unit ) const;
 
    bool operator==( const QgsProfileGenerationContext &other ) const;
    bool operator!=( const QgsProfileGenerationContext &other ) const;
 
  private:
    double mMaxErrorMapUnits = std::numeric_limits< double >::quiet_NaN();
    double mMapUnitsPerDistancePixel = 1;
    QgsDoubleRange mDistanceRange;
    QgsDoubleRange mElevationRange;
    double mDpi = 96;
};

class CORE_EXPORT QgsAbstractProfileGenerator
{
  public:
    virtual ~QgsAbstractProfileGenerator();

    virtual QString sourceId() const = 0;

    virtual Qgis::ProfileGeneratorFlags flags() const;

    virtual bool generateProfile( const QgsProfileGenerationContext &context = QgsProfileGenerationContext() ) = 0;

    virtual QgsFeedback *feedback() const = 0;

    virtual QgsAbstractProfileResults *takeResults() = 0 SIP_TRANSFERBACK;

    virtual QString type() const = 0;
};
 
#endif // QGSABSTRACTPROFILEGENERATOR_H