qgspalettedrasterrenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgspalettedrasterrenderer.h
                         ---------------------------
    begin                : December 2011
    copyright            : (C) 2011 by Marco Hugentobler
    email                : marco at sourcepole dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSPALETTEDRASTERRENDERER_H
#define QGSPALETTEDRASTERRENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgscolorrampshader.h"
#include "qgsrasterrenderer.h"
 
#include <QVector>
 
class QColor;
class QDomElement;
class QgsRasterAttributeTable;

class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer
{
  public:

    struct CORE_EXPORT Class
    {
      Class( double value, const QColor &color = QColor(), const QString &label = QString() )
        : value( value )
        , color( color )
        , label( label )
      {}

      double value;

      QColor color;
      QString label;
    };

    class CORE_EXPORT MultiValueClass
    {
 
      public:

        MultiValueClass( const QVector< QVariant > &values, const QColor &color = QColor(), const QString &label = QString() );

        QVector< QVariant > values;

        QColor color;

        QString label;
    };
 

    typedef QList< QgsPalettedRasterRenderer::Class > ClassData;

    typedef QList< QgsPalettedRasterRenderer::MultiValueClass > MultiValueClassData;

    QgsPalettedRasterRenderer( QgsRasterInterface *input, int bandNumber, const ClassData &classes );

    QgsPalettedRasterRenderer( QgsRasterInterface *input, int bandNumber, const MultiValueClassData &classes ) SIP_SKIP;

    QgsPalettedRasterRenderer( const QgsPalettedRasterRenderer & ) = delete;
    const QgsPalettedRasterRenderer &operator=( const QgsPalettedRasterRenderer & ) = delete;
 
    QgsPalettedRasterRenderer *clone() const override SIP_FACTORY;
    Qgis::RasterRendererFlags flags() const override;
 
    static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) SIP_FACTORY;
 
    QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;

    int nColors() const;

    ClassData classes() const;

    MultiValueClassData multiValueClasses( ) const;
 
    bool canCreateRasterAttributeTable( ) const override;

    void setMultiValueClasses( const MultiValueClassData &classes );

    QString label( double idx ) const;

    void setLabel( double idx, const QString &label );

    Q_DECL_DEPRECATED int band() const SIP_DEPRECATED { return mBand; }
 
    int inputBand() const override;
    bool setInputBand( int band ) override;
 
    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
    QList< QPair< QString, QColor > > legendSymbologyItems() const override;
    QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
    QList<int> usesBands() const override;
    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override SIP_DEPRECATED;
    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER );

    QgsColorRamp *sourceColorRamp() const;

    static QgsPalettedRasterRenderer::ClassData colorTableToClassData( const QList<QgsColorRampShader::ColorRampItem> &table );

    static QgsPalettedRasterRenderer::MultiValueClassData rasterAttributeTableToClassData( const QgsRasterAttributeTable *attributeTable, int classificationColumn = -1, QgsColorRamp *ramp = nullptr );

    static QgsPalettedRasterRenderer::ClassData classDataFromString( const QString &string );

    static QgsPalettedRasterRenderer::ClassData classDataFromFile( const QString &path );

    static QString classDataToString( const QgsPalettedRasterRenderer::ClassData &classes );

    static QgsPalettedRasterRenderer::ClassData classDataFromRaster( QgsRasterInterface *raster, int bandNumber, QgsColorRamp *ramp = nullptr,
        QgsRasterBlockFeedback *feedback = nullptr );
 
 
  private:
#ifdef SIP_RUN
    QgsPalettedRasterRenderer( const QgsPalettedRasterRenderer & );
    const QgsPalettedRasterRenderer &operator=( const QgsPalettedRasterRenderer & );
#endif
 
 
    int mBand;
    MultiValueClassData mMultiValueClassData;
 
    ClassData classData() const;

    std::unique_ptr<QgsColorRamp> mSourceColorRamp;

    QMap< double, QRgb > mColors;
    void updateArrays();
 
    // Maximum number of allowed classes for float rasters
    static const int MAX_FLOAT_CLASSES;
};
 
#endif // QGSPALETTEDRASTERRENDERER_H