QGIS API Documentation 3.29.0-Master (8c80f25a4f)
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"
27
28class QDomElement;
29
30class QPainter;
35
40class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface
41{
42
43 Q_DECLARE_TR_FUNCTIONS( QgsRasterRenderer )
44
45 public:
46
47 static const QRgb NODATA_COLOR;
48
52 QgsRasterRenderer( QgsRasterInterface *input = nullptr, const QString &type = QString() );
53 ~QgsRasterRenderer() override;
54
58 const QgsRasterRenderer &operator=( const QgsRasterRenderer & ) = delete;
59
60 QgsRasterRenderer *clone() const override = 0 SIP_FACTORY;
61
62 int bandCount() const override;
63
64 Qgis::DataType dataType( int bandNo ) const override;
65
69 virtual QString type() const { return mType; }
70
76 virtual Qgis::RasterRendererFlags flags() const;
77
84 virtual bool canCreateRasterAttributeTable( ) const;
85
86 bool setInput( QgsRasterInterface *input ) override;
87
88 QgsRasterBlock *block( int bandNo,
89 const QgsRectangle &extent,
90 int width,
91 int height,
92 QgsRasterBlockFeedback *feedback = nullptr ) override = 0 SIP_FACTORY;
93
94 bool usesTransparency() const;
95
101 void setOpacity( double opacity ) { mOpacity = opacity; }
102
108 double opacity() const { return mOpacity; }
109
120 QColor nodataColor() const { return mNodataColor; }
121
131 void setNodataColor( const QColor &color ) { mNodataColor = color; }
132
133 void setRasterTransparency( QgsRasterTransparency *t SIP_TRANSFER );
134 const QgsRasterTransparency *rasterTransparency() const { return mRasterTransparency; }
135
136 void setAlphaBand( int band ) { mAlphaBand = band; }
137 int alphaBand() const { return mAlphaBand; }
138
144 virtual QList< QPair< QString, QColor > > legendSymbologyItems() const;
145
156 virtual QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) SIP_FACTORY;
157
159 void readXml( const QDomElement &rendererElem ) override;
160
166 void copyCommonProperties( const QgsRasterRenderer *other, bool copyMinMaxOrigin = true );
167
169 virtual QList<int> usesBands() const { return QList<int>(); }
170
172 const QgsRasterMinMaxOrigin &minMaxOrigin() const { return mMinMaxOrigin; }
173
175 void setMinMaxOrigin( const QgsRasterMinMaxOrigin &origin ) { mMinMaxOrigin = origin; }
176
181 virtual void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const;
182
192 virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
193
194 protected:
195
197 void _writeXml( QDomDocument &doc, QDomElement &rasterRendererElem ) const;
198
199 QString mType;
200
202 double mOpacity = 1.0;
204 QgsRasterTransparency *mRasterTransparency = nullptr;
205
210 int mAlphaBand = -1;
211
214
223 QRgb renderColorForNodataPixel() const;
224
225 private:
226
227 QColor mNodataColor;
228
229#ifdef SIP_RUN
231 const QgsRasterRenderer &operator=( const QgsRasterRenderer & );
232#endif
233
234};
235
236#endif // QGSRASTERRENDERER_H
DataType
Raster data types.
Definition: qgis.h:129
Layer tree node points to a map layer.
The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegen...
Feedback object tailored for raster block reading.
Raster data container.
Base class for processing filters like renderers, reprojector, resampler etc.
virtual Qgis::DataType dataType(int bandNo) const =0
Returns data type for the band specified by number.
virtual int bandCount() const =0
Gets number of bands.
virtual void readXml(const QDomElement &filterElem)
Sets base class members from xml. Usually called from create() methods of subclasses.
virtual bool setInput(QgsRasterInterface *input)
Set input.
This class describes the origin of min/max values.
Raster renderer pipe that applies colors to a raster.
QColor nodataColor() const
Returns the color to use for shading nodata pixels.
virtual QString type() const
Returns a unique string representation of the renderer type.
void setMinMaxOrigin(const QgsRasterMinMaxOrigin &origin)
Sets origin of min/max values.
const QgsRasterTransparency * rasterTransparency() const
const QgsRasterMinMaxOrigin & minMaxOrigin() const
Returns const reference to origin of min/max values.
double opacity() const
Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1....
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.
virtual QList< int > usesBands() const
Returns a list of band numbers used by the renderer.
void setAlphaBand(int band)
void setOpacity(double opacity)
Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1....
QgsRasterMinMaxOrigin mMinMaxOrigin
Origin of min/max values.
QgsRasterRenderer(const QgsRasterRenderer &)=delete
QgsRasterRenderer cannot be copied. Use clone() instead.
static const QRgb NODATA_COLOR
void setNodataColor(const QColor &color)
Sets the color to use for shading nodata pixels.
const QgsRasterRenderer & operator=(const QgsRasterRenderer &)=delete
QgsRasterRenderer cannot be copied. Use clone() instead.
QgsRasterRenderer * clone() const override=0
Clone itself, create deep copy.
Defines the list of pixel values to be considered as transparent or semi transparent when rendering r...
A rectangle specified with double values.
Definition: qgsrectangle.h:42
An interface for classes which can visit style entity (e.g.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76