qgsrasterrenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgsrasterrenderer.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 QGSRASTERRENDERER_H
#define QGSRASTERRENDERER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrasterinterface.h"
#include "qgsrasterminmaxorigin.h"
#include "qgsrectangle.h"
 
#include <QPair>
 
class QDomElement;
 
class QPainter;
class QgsRasterTransparency;
class QgsStyleEntityVisitorInterface;
class QgsLayerTreeModelLegendNode;
class QgsLayerTreeLayer;

class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface
{
    Q_DECLARE_TR_FUNCTIONS( QgsRasterRenderer ) // cppcheck-suppress duplInheritedMember
 
  public:
    static const QRgb NODATA_COLOR;

    QgsRasterRenderer( QgsRasterInterface *input = nullptr, const QString &type = QString() );
    ~QgsRasterRenderer() override;

    QgsRasterRenderer( const QgsRasterRenderer & ) = delete;
    const QgsRasterRenderer &operator=( const QgsRasterRenderer & ) = delete;
 
    QgsRasterRenderer *clone() const override = 0 SIP_FACTORY;
 
    int bandCount() const override;
 
    Qgis::DataType dataType( int bandNo ) const override;

    virtual QString type() const { return mType; }

    virtual Qgis::RasterRendererFlags flags() const;

    virtual bool canCreateRasterAttributeTable() const;
 
    bool setInput( QgsRasterInterface *input ) override;

    virtual int inputBand() const;

    virtual bool setInputBand( int band );
 
    QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override = 0 SIP_FACTORY;
 
    bool usesTransparency() const;

    void setOpacity( double opacity ) { mOpacity = opacity; }

    double opacity() const { return mOpacity; }

    QColor nodataColor() const { return mNodataColor; }

    void setNodataColor( const QColor &color ) { mNodataColor = color; }
 
    void setRasterTransparency( QgsRasterTransparency *t SIP_TRANSFER );
    const QgsRasterTransparency *rasterTransparency() const { return mRasterTransparency.get(); }
 
    void setAlphaBand( int band ) { mAlphaBand = band; }
    int alphaBand() const { return mAlphaBand; }

    virtual QList< QPair< QString, QColor > > legendSymbologyItems() const;

    virtual QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY;

    void readXml( const QDomElement &rendererElem ) override;

    void copyCommonProperties( const QgsRasterRenderer *other, bool copyMinMaxOrigin = true );

    virtual QList<int> usesBands() const { return QList<int>(); }

    const QgsRasterMinMaxOrigin &minMaxOrigin() const { return mMinMaxOrigin; }

    void setMinMaxOrigin( const QgsRasterMinMaxOrigin &origin ) { mMinMaxOrigin = origin; }

    Q_DECL_DEPRECATED virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const SIP_DEPRECATED;

    virtual bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const;

    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;

    bool needsRefresh( const QgsRectangle &extent ) const SIP_SKIP;

    virtual bool refresh( const QgsRectangle &extent, const QList<double> &min, const QList<double> &max, bool forceRefresh = false ) SIP_SKIP;
 
  protected:
    void _writeXml( QDomDocument &doc, QDomElement &rasterRendererElem ) const;
 
    QString mType;

    double mOpacity = 1.0;
    std::unique_ptr<QgsRasterTransparency> mRasterTransparency;

    int mAlphaBand = -1;

    QgsRasterMinMaxOrigin mMinMaxOrigin;

    QRgb renderColorForNodataPixel() const;

    QgsRectangle mLastRectangleUsedByRefreshContrastEnhancementIfNeeded;
 
  private:
    QColor mNodataColor;
 
#ifdef SIP_RUN
    QgsRasterRenderer( const QgsRasterRenderer & );
    const QgsRasterRenderer &operator=( const QgsRasterRenderer & );
#endif
};
 
#endif // QGSRASTERRENDERER_H