qgslayoutitemelevationprofile.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutitemelevationprofile.h
                             -------------------------------
    begin                : January 2023
    copyright            : (C) 2023 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 QGSLAYOUTITEMELEVATIONPROFILE_H
#define QGSLAYOUTITEMELEVATIONPROFILE_H
 
#include "qgis_core.h"
#include "qgslayoutitem.h"
#include "qgsmaplayerref.h"
 
class QgsLayoutItemElevationProfilePlot;
class Qgs2DXyPlot;
class QgsProfileRequest;
class QgsProfilePlotRenderer;
class QgsLineSymbol;

class CORE_EXPORT QgsLayoutItemElevationProfile : public QgsLayoutItem
{
    Q_OBJECT
 
  public:
    QgsLayoutItemElevationProfile( QgsLayout *layout );
 
    ~QgsLayoutItemElevationProfile() override;

    static QgsLayoutItemElevationProfile *create( QgsLayout *layout ) SIP_FACTORY;
 
    int type() const override;
    QIcon icon() const override;
    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::DataDefinedProperty::AllProperties ) override;
    QgsLayoutItem::Flags itemFlags() const override;
    bool requiresRasterization() const override;
    bool containsAdvancedEffects() const override;

    Qgs2DXyPlot *plot();

    const Qgs2DXyPlot *plot() const SIP_SKIP;

    QList< QgsMapLayer * > layers() const;

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

    QList<QgsAbstractProfileSource *> sources() const;

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

    void setProfileCurve( QgsCurve *curve SIP_TRANSFER );

    QgsCurve *profileCurve() const;

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    QgsCoordinateReferenceSystem crs() const;

    void setTolerance( double tolerance );

    double tolerance() const;

    bool atlasDriven() const { return mAtlasDriven; }

    void setAtlasDriven( bool enabled );

    QgsProfileRequest profileRequest() const;
 
    void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override;

    Qgis::DistanceUnit distanceUnit() const;

    void setDistanceUnit( Qgis::DistanceUnit unit );

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

    void setSubsectionsSymbol( QgsLineSymbol *symbol SIP_TRANSFER );
 
  public slots:
 
    void refresh() override;
    void invalidateCache() override;
 
  signals:

    void previewRefreshed();
 
  protected:
    void draw( QgsLayoutItemRenderContext &context ) override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private slots:
 
    void recreateCachedImageInBackground();
    void profileGenerationFinished();
    void setSourcesPrivate();
 
  private:
    std::unique_ptr< QgsLayoutItemElevationProfilePlot > mPlot;
 
    QList< QgsMapLayerRef > mLayers;
    QList< std::variant< QgsMapLayerRef, QgsAbstractProfileSource * > > mSources;
 
    QgsCoordinateReferenceSystem mCrs;
    Qgis::DistanceUnit mDistanceUnit = Qgis::DistanceUnit::Unknown;
    std::unique_ptr< QgsCurve> mCurve;
    bool mAtlasDriven = false;
 
    double mTolerance = 0;
 
    std::unique_ptr<QgsLineSymbol> mSubsectionsSymbol;
 
    // render job handling
 
    // see note in QgsLayoutItemMap about these!
    std::unique_ptr< QImage > mCacheFinalImage;
    std::unique_ptr< QImage > mCacheRenderingImage;
    bool mUpdatesEnabled = true;
    bool mCacheInvalidated = true;
    bool mDrawing = false;
    bool mDrawingPreview = false;
    QTimer *mBackgroundUpdateTimer = nullptr;
    double mPreviewScaleFactor = 0;
    std::unique_ptr< QPainter > mPainter;
    std::unique_ptr< QgsProfilePlotRenderer > mRenderJob;
};
 
#endif //QGSLAYOUTITEMELEVATIONPROFILE_H