Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgssinglebandgrayrenderer.h
       3                 :            :                          ---------------------------
       4                 :            :     begin                : December 2011
       5                 :            :     copyright            : (C) 2011 by Marco Hugentobler
       6                 :            :     email                : marco at sourcepole dot ch
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSSINGLEBANDGRAYRENDERER_H
      19                 :            : #define QGSSINGLEBANDGRAYRENDERER_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include "qgsrasterrenderer.h"
      24                 :            : #include "qgscolorramplegendnodesettings.h"
      25                 :            : 
      26                 :            : #include <memory>
      27                 :            : 
      28                 :            : class QgsContrastEnhancement;
      29                 :            : class QDomElement;
      30                 :            : 
      31                 :            : /**
      32                 :            :  * \ingroup core
      33                 :            :   * \brief Raster renderer pipe for single band gray.
      34                 :            :   */
      35                 :          0 : class CORE_EXPORT QgsSingleBandGrayRenderer: public QgsRasterRenderer
      36                 :            : {
      37                 :            :   public:
      38                 :            :     enum Gradient
      39                 :            :     {
      40                 :            :       BlackToWhite,
      41                 :            :       WhiteToBlack
      42                 :            :     };
      43                 :            : 
      44                 :            :     QgsSingleBandGrayRenderer( QgsRasterInterface *input, int grayBand );
      45                 :            : 
      46                 :            :     //! QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.
      47                 :            :     QgsSingleBandGrayRenderer( const QgsSingleBandGrayRenderer & ) = delete;
      48                 :            :     //! QgsSingleBandGrayRenderer cannot be copied. Use clone() instead.
      49                 :            :     const QgsSingleBandGrayRenderer &operator=( const QgsSingleBandGrayRenderer & ) = delete;
      50                 :            : 
      51                 :            :     QgsSingleBandGrayRenderer *clone() const override SIP_FACTORY;
      52                 :            : 
      53                 :            :     static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) SIP_FACTORY;
      54                 :            : 
      55                 :            :     QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
      56                 :            : 
      57                 :          0 :     int grayBand() const { return mGrayBand; }
      58                 :            :     void setGrayBand( int band ) { mGrayBand = band; }
      59                 :          0 :     const QgsContrastEnhancement *contrastEnhancement() const { return mContrastEnhancement.get(); }
      60                 :            :     //! Takes ownership
      61                 :            :     void setContrastEnhancement( QgsContrastEnhancement *ce SIP_TRANSFER );
      62                 :            : 
      63                 :          0 :     void setGradient( Gradient gradient ) { mGradient = gradient; }
      64                 :            :     Gradient gradient() const { return mGradient; }
      65                 :            : 
      66                 :            :     void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
      67                 :            : 
      68                 :            :     QList< QPair< QString, QColor > > legendSymbologyItems() const override;
      69                 :            :     QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
      70                 :            : 
      71                 :            :     QList<int> usesBands() const override;
      72                 :            : 
      73                 :            :     void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override;
      74                 :            : 
      75                 :            :     /**
      76                 :            :      * Returns the color ramp shader legend settings.
      77                 :            :      *
      78                 :            :      * \see setLegendSettings()
      79                 :            :      * \since QGIS 3.18
      80                 :            :      */
      81                 :            :     const QgsColorRampLegendNodeSettings *legendSettings() const;
      82                 :            : 
      83                 :            :     /**
      84                 :            :      * Sets the color ramp shader legend \a settings.
      85                 :            :      *
      86                 :            :      * Ownership of \a settings is transferred.
      87                 :            :      *
      88                 :            :      * \see legendSettings()
      89                 :            :      * \since QGIS 3.18
      90                 :            :      */
      91                 :            :     void setLegendSettings( QgsColorRampLegendNodeSettings *settings SIP_TRANSFER );
      92                 :            : 
      93                 :            :   private:
      94                 :            : #ifdef SIP_RUN
      95                 :            :     QgsSingleBandGrayRenderer( const QgsSingleBandGrayRenderer & );
      96                 :            :     const QgsSingleBandGrayRenderer &operator=( const QgsSingleBandGrayRenderer & );
      97                 :            : #endif
      98                 :            : 
      99                 :            :     int mGrayBand;
     100                 :            :     Gradient mGradient;
     101                 :            :     std::unique_ptr< QgsContrastEnhancement > mContrastEnhancement;
     102                 :            :     std::unique_ptr< QgsColorRampLegendNodeSettings > mLegendSettings;
     103                 :            : };
     104                 :            : 
     105                 :            : #endif // QGSSINGLEBANDGRAYRENDERER_H