qgsrasterlayerelevationproperties.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrasterlayerelevationproperties.h
                         ---------------
    begin                : February 2022
    copyright            : (C) 2022 by Nyall Dawson
    email                : nyall dot dawson 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 QGSRASTERLAYERELEVATIONPROPERTIES_H
#define QGSRASTERLAYERELEVATIONPROPERTIES_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslinesymbol.h"
#include "qgsmaplayerelevationproperties.h"
 
class QgsRasterLayer;

class CORE_EXPORT QgsRasterLayerElevationProperties : public QgsMapLayerElevationProperties
{
    Q_OBJECT
 
  public:
    QgsRasterLayerElevationProperties( QObject *parent SIP_TRANSFERTHIS );
    ~QgsRasterLayerElevationProperties() override;
 
    bool hasElevation() const override;
    QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) override;
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QgsRasterLayerElevationProperties *clone() const override SIP_FACTORY;
    QString htmlSummary() const override;
    bool isVisibleInZRange( const QgsDoubleRange &range, QgsMapLayer *layer = nullptr ) const override;
    QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const override;
    QList< double > significantZValues( QgsMapLayer *layer ) const override;
    bool showByDefaultInElevationProfilePlots() const override;
    QgsMapLayerElevationProperties::Flags flags() const override;

    bool isEnabled() const { return mEnabled; }

    void setEnabled( bool enabled );

    Qgis::RasterElevationMode mode() const;

    void setMode( Qgis::RasterElevationMode mode );

    int bandNumber() const { return mBandNumber; }

    void setBandNumber( int band );

    QgsDoubleRange fixedRange() const;

    void setFixedRange( const QgsDoubleRange &range );

    QMap<int, QgsDoubleRange> fixedRangePerBand() const;

    void setFixedRangePerBand( const QMap<int, QgsDoubleRange> &ranges );

    QgsDoubleRange elevationRangeForPixelValue( QgsRasterLayer *layer, int band, double pixelValue ) const;

    int bandForElevationRange( QgsRasterLayer *layer, const QgsDoubleRange &range ) const;

    QgsLineSymbol *profileLineSymbol() const;

    void setProfileLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER );

    QgsFillSymbol *profileFillSymbol() const;

    void setProfileFillSymbol( QgsFillSymbol *symbol SIP_TRANSFER );

    Qgis::ProfileSurfaceSymbology profileSymbology() const { return mSymbology; }

    void setProfileSymbology( Qgis::ProfileSurfaceSymbology symbology );

    double elevationLimit() const;

    void setElevationLimit( double limit );

    static bool layerLooksLikeDem( QgsRasterLayer *layer );
 
  private:
    void setDefaultProfileLineSymbol( const QColor &color );
    void setDefaultProfileFillSymbol( const QColor &color );
 
    bool mEnabled = false;
 
    Qgis::RasterElevationMode mMode = Qgis::RasterElevationMode::RepresentsElevationSurface;
 
    std::unique_ptr< QgsLineSymbol > mProfileLineSymbol;
    std::unique_ptr< QgsFillSymbol > mProfileFillSymbol;
    Qgis::ProfileSurfaceSymbology mSymbology = Qgis::ProfileSurfaceSymbology::Line;
    double mElevationLimit = std::numeric_limits< double >::quiet_NaN();
    int mBandNumber = 1;
 
    QgsDoubleRange mFixedRange;
    QMap< int, QgsDoubleRange > mRangePerBand;
};
 
#endif // QGSRASTERLAYERELEVATIONPROPERTIES_H