QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgspalettedrasterrenderer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgspalettedrasterrenderer.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 QGSPALETTEDRASTERRENDERER_H
19 #define QGSPALETTEDRASTERRENDERER_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include <QVector>
24 
25 #include "qgsrasterrenderer.h"
26 #include "qgscolorrampshader.h"
27 
28 class QColor;
29 class QDomElement;
30 
36 {
37  public:
38 
40  struct Class
41  {
43  Class( int value, const QColor &color = QColor(), const QString &label = QString() )
44  : value( value )
45  , color( color )
46  , label( label )
47  {}
48 
50  int value;
51 
53  QColor color;
55  QString label;
56  };
57 
59  typedef QList< QgsPalettedRasterRenderer::Class > ClassData;
60 
64  QgsPalettedRasterRenderer( QgsRasterInterface *input, int bandNumber, const ClassData &classes );
65 
70 
72  static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) SIP_FACTORY;
73 
74  QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
75 
77  int nColors() const { return mClassData.size(); }
78 
82  ClassData classes() const;
83 
87  QString label( int idx ) const;
88 
92  void setLabel( int idx, const QString &label );
93 
98  int band() const { return mBand; }
99 
100  void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
101  void legendSymbologyItems( QList< QPair< QString, QColor > > &symbolItems SIP_OUT ) const override;
102  QList<int> usesBands() const override;
103  void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props = QgsStringMap() ) const override;
104  bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
105 
111  void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER );
112 
118  QgsColorRamp *sourceColorRamp() const;
119 
124  static QgsPalettedRasterRenderer::ClassData colorTableToClassData( const QList<QgsColorRampShader::ColorRampItem> &table );
125 
132  static QgsPalettedRasterRenderer::ClassData classDataFromString( const QString &string );
133 
139  static QgsPalettedRasterRenderer::ClassData classDataFromFile( const QString &path );
140 
146  static QString classDataToString( const QgsPalettedRasterRenderer::ClassData &classes );
147 
153  static QgsPalettedRasterRenderer::ClassData classDataFromRaster( QgsRasterInterface *raster, int bandNumber, QgsColorRamp *ramp = nullptr,
154  QgsRasterBlockFeedback *feedback = nullptr );
155 
156  private:
157 #ifdef SIP_RUN
160 #endif
161 
162 
163  int mBand;
164  ClassData mClassData;
165 
167  std::unique_ptr<QgsColorRamp> mSourceColorRamp;
168 
170  QMap< int, QRgb > mColors;
171  void updateArrays();
172 };
173 
174 #endif // QGSPALETTEDRASTERRENDERER_H
QgsPalettedRasterRenderer::ClassData
QList< QgsPalettedRasterRenderer::Class > ClassData
Map of value to class properties.
Definition: qgspalettedrasterrenderer.h:59
QgsColorRamp
Abstract base class for color ramps.
Definition: qgscolorramp.h:31
QgsRasterInterface::writeXml
virtual void writeXml(QDomDocument &doc, QDomElement &parentElem) const
Write base class members to xml.
Definition: qgsrasterinterface.h:461
QgsPalettedRasterRenderer::Class::color
QColor color
Color to render value.
Definition: qgspalettedrasterrenderer.h:53
SIP_OUT
#define SIP_OUT
Definition: qgis_sip.h:58
QgsRasterRenderer::accept
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
Definition: qgsrasterrenderer.cpp:189
QgsPalettedRasterRenderer::Class::label
QString label
Label for value.
Definition: qgspalettedrasterrenderer.h:55
qgscolorrampshader.h
QgsStyleEntityVisitorInterface
Definition: qgsstyleentityvisitor.h:33
qgsrasterrenderer.h
QgsRasterRenderer::toSld
virtual void toSld(QDomDocument &doc, QDomElement &element, const QgsStringMap &props=QgsStringMap()) const
Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
Definition: qgsrasterrenderer.cpp:175
QgsRasterRenderer::usesBands
virtual QList< int > usesBands() const
Returns a list of band numbers used by the renderer.
Definition: qgsrasterrenderer.h:132
QgsRectangle
Definition: qgsrectangle.h:41
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsRasterRenderer
Definition: qgsrasterrenderer.h:38
qgis_sip.h
SIP_TRANSFER
#define SIP_TRANSFER
Definition: qgis_sip.h:36
QgsPalettedRasterRenderer::band
int band() const
Returns the raster band used for rendering the raster.
Definition: qgspalettedrasterrenderer.h:98
QgsPalettedRasterRenderer::Class
Properties of a single value class.
Definition: qgspalettedrasterrenderer.h:40
QgsPalettedRasterRenderer
Definition: qgspalettedrasterrenderer.h:35
QgsRasterRenderer::clone
QgsRasterRenderer * clone() const override=0
Clone itself, create deep copy.
QgsStringMap
QMap< QString, QString > QgsStringMap
Definition: qgis.h:714
QgsRasterInterface
Definition: qgsrasterinterface.h:116
QgsRasterRenderer::legendSymbologyItems
virtual void legendSymbologyItems(QList< QPair< QString, QColor > > &symbolItems) const
Gets symbology items if provided by renderer.
Definition: qgsrasterrenderer.h:120
QgsRasterBlockFeedback
Definition: qgsrasterinterface.h:40
QgsPalettedRasterRenderer::Class::value
int value
Value.
Definition: qgspalettedrasterrenderer.h:50
QgsPalettedRasterRenderer::Class::Class
Class(int value, const QColor &color=QColor(), const QString &label=QString())
Constructor for Class.
Definition: qgspalettedrasterrenderer.h:43
QgsRasterRenderer::operator=
const QgsRasterRenderer & operator=(const QgsRasterRenderer &)=delete
QgsRasterRenderer cannot be copied. Use clone() instead.
QgsRasterBlock
Definition: qgsrasterblock.h:36