QGIS API Documentation  2.99.0-Master (7d4f81d)
qgssinglebandpseudocolorrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgssinglebandpseudocolorrenderer.h
3  ----------------------------------
4  begin : January 2012
5  copyright : (C) 2012 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 QGSSINGLEBANDPSEUDOCOLORRENDERER_H
19 #define QGSSINGLEBANDPSEUDOCOLORRENDERER_H
20 
21 #include "qgis_core.h"
22 #include "qgis.h"
23 #include "qgscolorramp.h"
24 #include "qgscolorrampshader.h"
25 #include "qgsrasterrenderer.h"
26 #include "qgsrectangle.h"
27 
28 class QDomElement;
29 class QgsRasterShader;
30 
35 {
36 
37  public:
38 
40  QgsSingleBandPseudoColorRenderer( QgsRasterInterface *input, int band = -1, QgsRasterShader *shader SIP_TRANSFER = nullptr );
41 
46 
48 
49  static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) SIP_FACTORY;
50 
51  QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
52 
54  void setShader( QgsRasterShader *shader SIP_TRANSFER );
55 
57  QgsRasterShader *shader() { return mShader.get(); }
58 
60  const QgsRasterShader *shader() const SIP_PYNAME( constShader ) { return mShader.get(); }
61 
70  void createShader( QgsColorRamp *colorRamp = nullptr,
73  int classes = 0,
74  bool clip = false,
75  const QgsRectangle &extent = QgsRectangle() );
76 
77  void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
78 
79  void legendSymbologyItems( QList< QPair< QString, QColor > > &symbolItems SIP_OUT ) const override;
80 
81  QList<int> usesBands() const override;
82 
86  int band() const { return mBand; }
87 
92  void setBand( int bandNo );
93 
94  double classificationMin() const { return mClassificationMin; }
95  double classificationMax() const { return mClassificationMax; }
96  void setClassificationMin( double min );
97  void setClassificationMax( double max );
98 
99  private:
100 #ifdef SIP_RUN
103 #endif
104 
105  std::unique_ptr< QgsRasterShader > mShader;
106  int mBand;
107 
108  // Minimum and maximum values used for automatic classification, these
109  // values are not used by renderer in rendering process
110  double mClassificationMin;
111  double mClassificationMax;
112 
113 };
114 
115 #endif // QGSSINGLEBANDPSEUDOCOLORRENDERER_H
A rectangle specified with double values.
Definition: qgsrectangle.h:38
Interface for all raster shaders.
virtual QList< int > usesBands() const
Returns a list of band numbers used by the renderer.
Abstract base class for color ramps.
Definition: qgscolorramp.h:30
QgsRasterShader * shader()
Returns the raster shader.
Type
Supported methods for color interpolation.
Raster data container.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
Raster renderer pipe for single band pseudocolor.
#define SIP_FACTORY
Definition: qgis_sip.h:69
double ANALYSIS_EXPORT min(double x, double y)
Returns the minimum of two doubles or the first argument if both are equal.
Definition: MathUtils.cc:452
Base class for processing filters like renderers, reprojector, resampler etc.
double ANALYSIS_EXPORT max(double x, double y)
Returns the maximum of two doubles or the first argument if both are equal.
Definition: MathUtils.cc:437
const QgsRasterRenderer & operator=(const QgsRasterRenderer &)=delete
QgsRasterRenderer cannot be copied. Use clone() instead.
Uses breaks from color palette.
#define SIP_OUT
Definition: qgis_sip.h:51
QgsRasterRenderer * clone() const override=0
Clone itself, create deep copy.
Interpolates the color between two class breaks linearly.
ClassificationMode
Classification modes used to create the color ramp shader.
virtual void legendSymbologyItems(QList< QPair< QString, QColor > > &symbolItems) const
Get symbology items if provided by renderer.
virtual void writeXml(QDomDocument &doc, QDomElement &parentElem) const
Write base class members to xml.
Feedback object tailored for raster block reading.
Raster renderer pipe that applies colors to a raster.
int band() const
Returns the band used by the renderer.
virtual QgsRasterBlock * block(int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override=0
Read block of data using given extent and size.
#define SIP_PYNAME(name)
Definition: qgis_sip.h:74