QGIS API Documentation  3.15.0-Master (dbe1ef8aa2)
qgsrasterrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrasterrenderer.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 QGSRASTERRENDERER_H
19 #define QGSRASTERRENDERER_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include <QPair>
24 
25 #include "qgsrasterinterface.h"
26 #include "qgsrasterminmaxorigin.h"
27 
28 class QDomElement;
29 
30 class QPainter;
33 
38 class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface
39 {
40 
41  Q_DECLARE_TR_FUNCTIONS( QgsRasterRenderer )
42 
43  public:
44 
45  static const QRgb NODATA_COLOR;
46 
50  QgsRasterRenderer( QgsRasterInterface *input = nullptr, const QString &type = QString() );
51  ~QgsRasterRenderer() override;
52 
54  QgsRasterRenderer( const QgsRasterRenderer & ) = delete;
56  const QgsRasterRenderer &operator=( const QgsRasterRenderer & ) = delete;
57 
58  QgsRasterRenderer *clone() const override = 0 SIP_FACTORY;
59 
60  int bandCount() const override;
61 
62  Qgis::DataType dataType( int bandNo ) const override;
63 
64  virtual QString type() const { return mType; }
65 
66  bool setInput( QgsRasterInterface *input ) override;
67 
68  QgsRasterBlock *block( int bandNo,
69  const QgsRectangle &extent,
70  int width,
71  int height,
72  QgsRasterBlockFeedback *feedback = nullptr ) override = 0 SIP_FACTORY;
73 
74  bool usesTransparency() const;
75 
81  void setOpacity( double opacity ) { mOpacity = opacity; }
82 
88  double opacity() const { return mOpacity; }
89 
100  QColor nodataColor() const { return mNodataColor; }
101 
111  void setNodataColor( const QColor &color ) { mNodataColor = color; }
112 
113  void setRasterTransparency( QgsRasterTransparency *t SIP_TRANSFER );
114  const QgsRasterTransparency *rasterTransparency() const { return mRasterTransparency; }
115 
116  void setAlphaBand( int band ) { mAlphaBand = band; }
117  int alphaBand() const { return mAlphaBand; }
118 
120  virtual void legendSymbologyItems( QList< QPair< QString, QColor > > &symbolItems SIP_OUT ) const { Q_UNUSED( symbolItems ) }
121 
123  void readXml( const QDomElement &rendererElem ) override;
124 
129  void copyCommonProperties( const QgsRasterRenderer *other, bool copyMinMaxOrigin = true );
130 
132  virtual QList<int> usesBands() const { return QList<int>(); }
133 
135  const QgsRasterMinMaxOrigin &minMaxOrigin() const { return mMinMaxOrigin; }
136 
138  void setMinMaxOrigin( const QgsRasterMinMaxOrigin &origin ) { mMinMaxOrigin = origin; }
139 
143  virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props = QgsStringMap() ) const;
144 
154  virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
155 
156  protected:
157 
159  void _writeXml( QDomDocument &doc, QDomElement &rasterRendererElem ) const;
160 
161  QString mType;
162 
164  double mOpacity = 1.0;
166  QgsRasterTransparency *mRasterTransparency = nullptr;
167 
171  int mAlphaBand = -1;
172 
175 
184  QRgb renderColorForNodataPixel() const;
185 
186  private:
187 
188  QColor mNodataColor;
189 
190 #ifdef SIP_RUN
192  const QgsRasterRenderer &operator=( const QgsRasterRenderer & );
193 #endif
194 
195 };
196 
197 #endif // QGSRASTERRENDERER_H
virtual int bandCount() const =0
Gets number of bands.
A rectangle specified with double values.
Definition: qgsrectangle.h:41
virtual void readXml(const QDomElement &filterElem)
Sets base class members from xml. Usually called from create() methods of subclasses.
QColor nodataColor() const
Returns the color to use for shading nodata pixels.
virtual QList< int > usesBands() const
Returns a list of band numbers used by the renderer.
double opacity() const
Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1...
virtual QString type() const
DataType
Raster data types.
Definition: qgis.h:101
QgsRasterMinMaxOrigin mMinMaxOrigin
Origin of min/max values.
const QgsRasterMinMaxOrigin & minMaxOrigin() const
Returns const reference to origin of min/max values.
virtual Qgis::DataType dataType(int bandNo) const =0
Returns data type for the band specified by number.
An interface for classes which can visit style entity (e.g.
QMap< QString, QString > QgsStringMap
Definition: qgis.h:742
const QgsRasterTransparency * rasterTransparency() const
static const QRgb NODATA_COLOR
This class describes the origin of min/max values.
Raster data container.
virtual QgsRasterBlock * block(int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)=0
Read block of data using given extent and size.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76
void setAlphaBand(int band)
Base class for processing filters like renderers, reprojector, resampler etc.
void setMinMaxOrigin(const QgsRasterMinMaxOrigin &origin)
Sets origin of min/max values.
virtual bool setInput(QgsRasterInterface *input)
Set input.
void setNodataColor(const QColor &color)
Sets the color to use for shading nodata pixels.
virtual QgsRasterInterface * clone() const =0
Clone itself, create deep copy.
#define SIP_OUT
Definition: qgis_sip.h:58
Defines the list of pixel values to be considered as transparent or semi transparent when rendering r...
void setOpacity(double opacity)
Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1...
virtual void legendSymbologyItems(QList< QPair< QString, QColor > > &symbolItems) const
Gets symbology items if provided by renderer.
Feedback object tailored for raster block reading.
Raster renderer pipe that applies colors to a raster.