qgselevationprofile.h

Go to the documentation of this file.

/***************************************************************************
    qgselevationprofile.h
    ------------------
    Date                 : July 2025
    Copyright            : (C) 2025 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 QGSELEVATIONPROFILE_H
#define QGSELEVATIONPROFILE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsmaplayerref.h"
 
#include <QObject>
#include <QPointer>
 
class QgsProject;
class QgsReadWriteContext;
class QDomDocument;
class QDomElement;
class QgsMapLayer;
class QgsCurve;
class QgsLineSymbol;
class QgsLayerTree;

class CORE_EXPORT QgsElevationProfile : public QObject
{
    Q_OBJECT
 
  public:
    Q_PROPERTY( bool useProjectLayerTree READ useProjectLayerTree WRITE setUseProjectLayerTree NOTIFY useProjectLayerTreeChanged )
 
    
    explicit QgsElevationProfile( QgsProject *project );
    ~QgsElevationProfile() override;

    QString name() const { return mName; }

    QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;

    bool readXml( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );

    void resolveReferences( const QgsProject *project );

    QIcon icon() const;

    QgsLayerTree *layerTree();

    bool useProjectLayerTree() { return mUseProjectLayerTree; }

    QgsCoordinateReferenceSystem crs() const;

    void setProfileCurve( QgsCurve *curve SIP_TRANSFER );

    QgsCurve *profileCurve() const;

    double tolerance() const;

    bool lockAxisScales() const;

    Qgis::DistanceUnit distanceUnit() const;

    QgsLineSymbol *subsectionsSymbol();

    void setSubsectionsSymbol( QgsLineSymbol *symbol SIP_TRANSFER );
 
  public slots:

    void setName( const QString &name );

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    void setTolerance( double tolerance );

    void setLockAxisScales( bool lock );

    void setDistanceUnit( Qgis::DistanceUnit unit );
 

    void setUseProjectLayerTree( bool useProjectTree );
 
  signals:

    void nameChanged( const QString &newName );

    void useProjectLayerTreeChanged( bool useProjectTree );

    void profileCurveChanged();

    void toleranceChanged( double tolerance );
 
  private slots:
 
    void dirtyProject();
 
  private:
    void setupLayerTreeConnections();
 
    QPointer< QgsProject > mProject;
    QString mName;
    QgsCoordinateReferenceSystem mCrs;
    bool mLockAxisScales = false;
    Qgis::DistanceUnit mDistanceUnit = Qgis::DistanceUnit::Unknown;
    std::unique_ptr<QgsLayerTree> mLayerTree;
    bool mUseProjectLayerTree = false;
    std::unique_ptr<QgsCurve> mProfileCurve;
    double mTolerance = 0;
    std::unique_ptr<QgsLineSymbol> mSubsectionsSymbol;
};
 
#endif // QGSELEVATIONPROFILE_H