qgsrasterlayer.h

Go to the documentation of this file.

/***************************************************************************
                        qgsrasterlayer.h  -  description
                              -------------------
 begin                : Fri Jun 28 2002
 copyright            : (C) 2004 by T.Sutton, Gary E.Sherman, Steve Halasz
 email                : tim@linfiniti.com
***************************************************************************/
/*
 * Peter J. Ersts - contributed to the refactoring and maintenance of this class
 * B. Morley - added functions to convert this class to a data provider interface
 * Frank Warmerdam - contributed bug fixes and migrated class to use all GDAL_C_API calls
 */
/***************************************************************************
 *                                                                         *
 *   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 QGSRASTERLAYER_H
#define QGSRASTERLAYER_H

#include <QColor>
#include <QDateTime>
#include <QList>
#include <QMap>
#include <QPair>
#include <QVector>

#include "qgis.h"
#include "qgsbrightnesscontrastfilter.h"
#include "qgscolorrampshader.h"
#include "qgscontrastenhancement.h"
#include "qgshuesaturationfilter.h"
#include "qgsmaplayer.h"
#include "qgspoint.h"
#include "qgsraster.h"
#include "qgsrasterdataprovider.h"
#include "qgsrasterinterface.h"
#include "qgsrasterpipe.h"
#include "qgsrasterresamplefilter.h"
#include "qgsrastershaderfunction.h"
#include "qgsrastershader.h"
#include "qgsrastertransparency.h"
#include "qgsrasterviewport.h"

class QgsMapToPixel;
class QgsRasterRenderer;
class QgsRectangle;
class QImage;
class QLibrary;
class QPixmap;
class QSlider;

typedef QList < QPair< QString, QColor > > QgsLegendColorList;

class CORE_EXPORT QgsRasterLayer : public QgsMapLayer
{
    Q_OBJECT
  public:
    static const double CUMULATIVE_CUT_LOWER;

    static const double CUMULATIVE_CUT_UPPER;

    static const double SAMPLE_SIZE;

    QgsRasterLayer();

    QgsRasterLayer( const QString &path,
                    const QString &baseName = QString::null,
                    bool loadDefaultStyleFlag = true );

    //TODO - QGIS 3.0
    //This constructor is confusing if used with string literals for providerKey,
    //as the previous constructor will be called with the literal for providerKey
    //implicitly converted to a bool.
    //for QGIS 3.0, make either constructor explicit or alter the signatures
    QgsRasterLayer( const QString &uri,
                    const QString &baseName,
                    const QString &providerKey,
                    bool loadDefaultStyleFlag = true );

    ~QgsRasterLayer();

    enum ColorShadingAlgorithm
    {
      UndefinedShader,
      PseudoColorShader,
      FreakOutShader,
      ColorRampShader,
      UserDefinedShader
    };

    enum LayerType
    {
      GrayOrUndefined,
      Palette,
      Multiband,
      ColorLayer
    };

    static bool isValidRasterFileName( const QString & theFileNameQString, QString &retError );
    static bool isValidRasterFileName( const QString & theFileNameQString );

    static QDateTime lastModified( const QString &  name );

    void setDataProvider( const QString & provider );

    LayerType rasterType() { return mRasterType; }

    void setRenderer( QgsRasterRenderer* theRenderer );
    QgsRasterRenderer* renderer() const { return mPipe.renderer(); }

    QgsRasterResampleFilter * resampleFilter() const { return mPipe.resampleFilter(); }

    QgsBrightnessContrastFilter * brightnessFilter() const { return mPipe.brightnessFilter(); }
    QgsHueSaturationFilter * hueSaturationFilter() const { return mPipe.hueSaturationFilter(); }

    QgsRasterPipe * pipe() { return &mPipe; }

    int width() const;

    int height() const;

    int bandCount() const;

    const  QString bandName( int theBandNoInt );

    QgsRasterDataProvider* dataProvider();

    const QgsRasterDataProvider* dataProvider() const;

    virtual void reload() override;

    virtual QgsMapLayerRenderer* createMapRenderer( QgsRenderContext& rendererContext ) override;

    bool draw( QgsRenderContext& rendererContext ) override;

    void draw( QPainter * theQPainter,
               QgsRasterViewPort * myRasterViewPort,
               const QgsMapToPixel* theQgsMapToPixel = nullptr );

    QgsLegendColorList legendSymbologyItems() const;

    QString metadata() override;

    QPixmap paletteAsPixmap( int theBandNumber = 1 );

    QString providerType() const;

    double rasterUnitsPerPixelX();
    double rasterUnitsPerPixelY();

    void setContrastEnhancement( QgsContrastEnhancement::ContrastEnhancementAlgorithm theAlgorithm,
                                 QgsRaster::ContrastEnhancementLimits theLimits = QgsRaster::ContrastEnhancementMinMax,
                                 const QgsRectangle& theExtent = QgsRectangle(),
                                 int theSampleSize = SAMPLE_SIZE,
                                 bool theGenerateLookupTableFlag = true );

    void setDefaultContrastEnhancement();

    Q_DECL_DEPRECATED void setDrawingStyle( const QString & theDrawingStyleQString );

    void showProgress( int theValue );

    virtual QStringList subLayers() const override;

    Q_DECL_DEPRECATED QPixmap previewAsPixmap( QSize size, const QColor& bgColor = Qt::white );

    QImage previewAsImage( QSize size, const QColor& bgColor = Qt::white,
                           QImage::Format format = QImage::Format_ARGB32_Premultiplied );

    virtual void setLayerOrder( const QStringList &layers ) override;

    virtual void setSubLayerVisibility( const QString& name, bool vis ) override;

    virtual QDateTime timestamp() const override { return mDataProvider->timestamp() ; }

  public slots:
    void showStatusMessage( const QString & theMessage );

    Q_DECL_DEPRECATED void updateProgress( int, int );

    void onProgress( int, double, const QString& );

  signals:
    void progressUpdate( int theValue );

  protected:
    bool readSymbology( const QDomNode& node, QString& errorMessage ) override;

    bool readXml( const QDomNode& layer_node ) override;

    bool writeSymbology( QDomNode&, QDomDocument& doc, QString& errorMessage ) const override;

    bool writeXml( QDomNode & layer_node, QDomDocument & doc ) override;

  private:
    void init();

    void closeDataProvider();

    bool update();

    void setRendererForDrawingStyle( QgsRaster::DrawingStyle theDrawingStyle );

    const QString QSTRING_NOT_SET;
    const QString TRSTRING_NOT_SET;

    QgsRasterDataProvider* mDataProvider;

    QDateTime mLastModified;

    QgsRasterViewPort mLastViewPort;

    QString mProviderKey;

    LayerType mRasterType;

    QgsRasterPipe mPipe;
};

#endif