qgsmultibandcolorrenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmultibandcolorrenderer.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 QGSMULTIBANDCOLORRENDERER_H
#define QGSMULTIBANDCOLORRENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrasterrenderer.h"
 
class QgsContrastEnhancement;
class QDomElement;

class CORE_EXPORT QgsMultiBandColorRenderer : public QgsRasterRenderer
{
  public:
    QgsMultiBandColorRenderer(
      QgsRasterInterface *input,
      int redBand,
      int greenBand,
      int blueBand,
      QgsContrastEnhancement *redEnhancement SIP_TRANSFER = nullptr,
      QgsContrastEnhancement *greenEnhancement SIP_TRANSFER = nullptr,
      QgsContrastEnhancement *blueEnhancement SIP_TRANSFER = nullptr
    );
    ~QgsMultiBandColorRenderer() override;

    QgsMultiBandColorRenderer( const QgsMultiBandColorRenderer & ) = delete;
    const QgsMultiBandColorRenderer &operator=( const QgsMultiBandColorRenderer & ) = delete;
 
    QgsMultiBandColorRenderer *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 redBand() const { return mRedBand; }

    void setRedBand( int band ) { mRedBand = band; }

    int greenBand() const { return mGreenBand; }

    void setGreenBand( int band ) { mGreenBand = band; }

    int blueBand() const { return mBlueBand; }

    void setBlueBand( int band ) { mBlueBand = band; }

    const QgsContrastEnhancement *redContrastEnhancement() const;

    void setRedContrastEnhancement( QgsContrastEnhancement *ce SIP_TRANSFER );

    const QgsContrastEnhancement *greenContrastEnhancement() const;

    void setGreenContrastEnhancement( QgsContrastEnhancement *ce SIP_TRANSFER );

    const QgsContrastEnhancement *blueContrastEnhancement() const;

    void setBlueContrastEnhancement( QgsContrastEnhancement *ce SIP_TRANSFER );
 
    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
 
    QList<int> usesBands() const override;
    QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY 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 refresh( const QgsRectangle &extent, const QList<double> &min, const QList<double> &max, bool forceRefresh = false ) override SIP_SKIP;
 
  private:
#ifdef SIP_RUN
    QgsMultiBandColorRenderer( const QgsMultiBandColorRenderer & );
    const QgsMultiBandColorRenderer &operator=( const QgsMultiBandColorRenderer & );
#endif
 
    int mRedBand = 1;
    int mGreenBand = 1;
    int mBlueBand = 1;
 
    std::unique_ptr< QgsContrastEnhancement > mRedContrastEnhancement;
    std::unique_ptr< QgsContrastEnhancement > mGreenContrastEnhancement;
    std::unique_ptr< QgsContrastEnhancement > mBlueContrastEnhancement;
};
 
#endif // QGSMULTIBANDCOLORRENDERER_H