Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsrastercontourrenderer.h
       3                 :            :   --------------------------------------
       4                 :            :   Date                 : March 2020
       5                 :            :   Copyright            : (C) 2020 by Martin Dobias
       6                 :            :   Email                : wonder dot sk at gmail dot com
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSRASTERCONTOURRENDERER_H
      17                 :            : #define QGSRASTERCONTOURRENDERER_H
      18                 :            : 
      19                 :            : 
      20                 :            : #include "qgsrasterrenderer.h"
      21                 :            : 
      22                 :            : class QgsLineSymbol;
      23                 :            : 
      24                 :            : /**
      25                 :            :  * \ingroup core
      26                 :            :  * \brief Raster renderer that generates contours on the fly for a source raster band.
      27                 :            :  *
      28                 :            :  * \since QGIS 3.14
      29                 :            :  */
      30                 :            : class CORE_EXPORT QgsRasterContourRenderer : public QgsRasterRenderer
      31                 :            : {
      32                 :            :   public:
      33                 :            :     //! Creates a contour renderer
      34                 :            :     explicit QgsRasterContourRenderer( QgsRasterInterface *input );
      35                 :            :     ~QgsRasterContourRenderer() override;
      36                 :            : 
      37                 :            :     //! QgsRasterContourRenderer cannot be copied. Use clone() instead.
      38                 :            :     QgsRasterContourRenderer( const QgsRasterContourRenderer & ) = delete;
      39                 :            :     //! QgsRasterContourRenderer cannot be copied. Use clone() instead.
      40                 :            :     const QgsRasterContourRenderer &operator=( const QgsRasterContourRenderer & ) = delete;
      41                 :            : 
      42                 :            :     QgsRasterContourRenderer *clone() const override SIP_FACTORY;
      43                 :            : 
      44                 :            :     //! Creates an instance of the renderer based on definition from XML (used by renderer registry)
      45                 :            :     static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) SIP_FACTORY;
      46                 :            : 
      47                 :            :     void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
      48                 :            : 
      49                 :            :     QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
      50                 :            : 
      51                 :            :     QList<int> usesBands() const override;
      52                 :            :     QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY override;
      53                 :            : 
      54                 :            :     //
      55                 :            : 
      56                 :            :     //! Returns the number of the input raster band
      57                 :            :     int inputBand() const { return mInputBand; }
      58                 :            :     //! Sets the number of the input raster band
      59                 :          0 :     void setInputBand( int band ) { mInputBand = band; }
      60                 :            : 
      61                 :            :     //! Returns the interval of contour lines generation
      62                 :            :     double contourInterval() const { return mContourInterval; }
      63                 :            :     //! Sets the interval of contour lines generation
      64                 :          0 :     void setContourInterval( double interval ) { mContourInterval = interval; }
      65                 :            : 
      66                 :            :     //! Returns the symbol used for contour lines
      67                 :            :     QgsLineSymbol *contourSymbol() const { return mContourSymbol.get(); }
      68                 :            :     //! Sets the symbol used for contour lines. Takes ownership of the passed symbol
      69                 :            :     void setContourSymbol( QgsLineSymbol *symbol SIP_TRANSFER );
      70                 :            : 
      71                 :            :     //! Returns the interval of index contour lines (index contour lines are typical further apart and with a wider line symbol)
      72                 :            :     double contourIndexInterval() const { return mContourIndexInterval; }
      73                 :            :     //! Sets the interval of index contour lines (index contour lines are typical further apart and with a wider line symbol)
      74                 :          0 :     void setContourIndexInterval( double interval ) { mContourIndexInterval = interval; }
      75                 :            : 
      76                 :            :     //! Returns the symbol of index contour lines
      77                 :            :     QgsLineSymbol *contourIndexSymbol() const { return mContourIndexSymbol.get(); }
      78                 :            :     //! Sets the symbol of index contour lines
      79                 :            :     void setContourIndexSymbol( QgsLineSymbol *symbol SIP_TRANSFER );
      80                 :            : 
      81                 :            :     /**
      82                 :            :      * Returns by how much the renderer will scale down the request to the data provider.
      83                 :            :      * For example, for a raster block 1000x500 with downscale 10, the renderer will request raster 100x50 from provider.
      84                 :            :      * Higher downscale makes contour lines more simplified (at the expense of losing some detail).
      85                 :            :      * The value of one means there will be no downscaling.
      86                 :            :      */
      87                 :            :     double downscale() const { return mDownscale; }
      88                 :            : 
      89                 :            :     /**
      90                 :            :      * Sets by how much the renderer will scale down the request to the data provider.
      91                 :            :      * \see downscale()
      92                 :            :      */
      93                 :          0 :     void setDownscale( double scale ) { mDownscale = scale; }
      94                 :            : 
      95                 :            :   private:
      96                 :            : 
      97                 :            : #ifdef SIP_RUN
      98                 :            :     QgsRasterContourRenderer( const QgsRasterContourRenderer & );
      99                 :            :     const QgsRasterContourRenderer &operator=( const QgsRasterContourRenderer & );
     100                 :            : #endif
     101                 :            : 
     102                 :            :     std::unique_ptr<QgsLineSymbol> mContourSymbol;   // should not be null
     103                 :            :     std::unique_ptr<QgsLineSymbol> mContourIndexSymbol;  // may be null
     104                 :            :     double mDownscale = 8.;
     105                 :            :     double mContourInterval = 100.;
     106                 :            :     double mContourIndexInterval = 0.;
     107                 :            :     int mInputBand = 1;
     108                 :            : };
     109                 :            : 
     110                 :            : 
     111                 :            : #endif // QGSRASTERCONTOURRENDERER_H