qgselevationprofilecanvas.h

Go to the documentation of this file.

/***************************************************************************
                          qgselevationprofilecanvas.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 QGSELEVATIONPROFILECANVAS_H
#define QGSELEVATIONPROFILECANVAS_H
 
#include "qgsconfig.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgslinesymbol.h"
#include "qgsmaplayer.h"
#include "qgsplotcanvas.h"
#include "qgsprofilepoint.h"
 
class QgsElevationProfilePlotItem;
class QgsElevationProfileCrossHairsItem;
class QgsAbstractProfileResults;
class QgsProfilePlotRenderer;
class QgsCurve;
class Qgs2DXyPlot;
class QgsProfileSnapContext;
class QgsProfileIdentifyContext;
class QgsProfileIdentifyResults;
class QgsScreenHelper;

class GUI_EXPORT QgsElevationProfileCanvas : public QgsPlotCanvas
{
    Q_OBJECT
 
  public:

    QgsElevationProfileCanvas( QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsElevationProfileCanvas() override;
    QgsCoordinateReferenceSystem crs() const override;
    QgsPoint toMapCoordinates( const QgsPointXY &point ) const override;
    QgsPointXY toCanvasCoordinates( const QgsPoint &point ) const override;
    void resizeEvent( QResizeEvent *event ) override;
    void paintEvent( QPaintEvent *event ) override;
    void cancelJobs() override SIP_SKIP;
    void panContentsBy( double dx, double dy ) override;
    void centerPlotOn( double x, double y ) override;
    void scalePlot( double factor ) override;
    QgsPointXY snapToPlot( QPoint point ) override;

    void scalePlot( double xFactor, double yFactor );
 
    void zoomToRect( const QRectF &rect ) override;
    void wheelZoom( QWheelEvent *event ) override;
    void mouseMoveEvent( QMouseEvent *e ) override;

    QRectF plotArea() const;

    void refresh() override;

    void invalidateCurrentPlotExtent();

    void setProject( QgsProject *project );

    void setLayers( const QList<QgsMapLayer *> &layers );

    QList<QgsMapLayer *> layers() const;

    void setSources( const QList<QgsAbstractProfileSource *> &sources );

    QList<QgsAbstractProfileSource *> sources() const;

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    void setProfileCurve( QgsCurve *curve SIP_TRANSFER );

    QgsCurve *profileCurve() const;

    void setTolerance( double tolerance );

    double tolerance() const { return mTolerance; }

    void setVisiblePlotRange( double minimumDistance, double maximumDistance, double minimumElevation, double maximumElevation );

    QgsDoubleRange visibleDistanceRange() const;

    QgsDoubleRange visibleElevationRange() const;

    const Qgs2DXyPlot &plot() const SIP_SKIP;

    void render( QgsRenderContext &context, double width, double height, const Qgs2DXyPlot &plotSettings );

    QVector<QgsProfileIdentifyResults> identify( QPointF point );

    QVector<QgsProfileIdentifyResults> identify( const QRectF &rect );

    QgsProfilePoint canvasPointToPlotPoint( QPointF point ) const;

    QgsPointXY plotPointToCanvasPoint( const QgsProfilePoint &point ) const;

    bool lockAxisScales() const;

    void setLockAxisScales( bool lock );

    double axisScaleRatio() const;

    void setAxisScaleRatio( double scale );

    Qgis::DistanceUnit distanceUnit() const;

    void setDistanceUnit( Qgis::DistanceUnit unit );

    void setBackgroundColor( const QColor &color );

    QgsLineSymbol *subsectionsSymbol()
    {
      return mSubsectionsSymbol.get();
    }

    void setSubsectionsSymbol( QgsLineSymbol *symbol SIP_TRANSFER );
 
  signals:

    void activeJobCountChanged( int count );

    void canvasPointHovered( const QgsPointXY &point, const QgsProfilePoint &profilePoint );

    void scaleChanged();
 
  public slots:

    void zoomFull();

    void clear();

    void setSnappingEnabled( bool enabled );
 
  private slots:
 
    void generationFinished();
    void onLayerProfileGenerationPropertyChanged();
    void onLayerProfileRendererPropertyChanged();
    void regenerateResultsForLayer();
    void scheduleDeferredRegeneration();
    void scheduleDeferredRedraw();
    void startDeferredRegeneration();
    void startDeferredRedraw();
    void refineResults();
    void setSourcesPrivate();
 
  private:
    void updateChartFromPalette();
    QgsProfileSnapContext snapContext() const;
    QgsProfileIdentifyContext identifyContext() const;
 
    void setupLayerConnections( QgsMapLayer *layer, bool isDisconnect );
 
    void adjustRangeForAxisScaleLock( double &xMinimum, double &xMaximum, double &yMinimum, double &yMaximum ) const;
 
    QgsScreenHelper *mScreenHelper = nullptr;
 
    bool mLockAxisScales = false;
    double mLockedAxisScale = 1;
 
    QgsCoordinateReferenceSystem mCrs;
    QgsProject *mProject = nullptr;
    Qgis::DistanceUnit mDistanceUnit = Qgis::DistanceUnit::Unknown;
 
    QgsWeakMapLayerPointerList mLayers;
    QList< QgsAbstractProfileSource * > mSources;
 
    QgsElevationProfilePlotItem *mPlotItem = nullptr;
    QgsElevationProfileCrossHairsItem *mCrossHairsItem = nullptr;
 
    QgsProfilePlotRenderer *mCurrentJob = nullptr;
    QTimer *mDeferredRegenerationTimer = nullptr;
    bool mDeferredRegenerationScheduled = false;
    QTimer *mDeferredRedrawTimer = nullptr;
    bool mDeferredRedrawScheduled = false;
 
    std::unique_ptr<QgsCurve> mProfileCurve;
    double mTolerance = 0;
 
    bool mFirstDrawOccurred = false;
 
    bool mSnappingEnabled = true;
 
    bool mZoomFullWhenJobFinished = true;
 
    bool mForceRegenerationAfterCurrentJobCompletes = false;
 
    static constexpr double MAX_ERROR_PIXELS = 2;
 
    std::unique_ptr<QgsLineSymbol> mSubsectionsSymbol;
};
 
#endif // QGSELEVATIONPROFILECANVAS_H