QGIS API Documentation 3.39.0-Master (bca3cdb6021)
Loading...
Searching...
No Matches
qgscolorrampshader.h
Go to the documentation of this file.
1/* **************************************************************************
2 qgscolorrampshader.h - description
3 -------------------
4begin : Fri Dec 28 2007
5copyright : (C) 2007 by Peter J. Ersts
7
8This class is based off of code that was originally written by Marco Hugentobler and
9originally part of the larger QgsRasterLayer class
10****************************************************************************/
11
12/* **************************************************************************
13 * *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
18 * *
19 ***************************************************************************/
20
21#ifndef QGSCOLORRAMPSHADER_H
22#define QGSCOLORRAMPSHADER_H
23
24#include "qgis_core.h"
25#include "qgis_sip.h"
26#include <QColor>
27#include <QVector>
28#include <memory>
29
30#include "qgis.h"
32#include "qgsrectangle.h"
33#include "qgsreadwritecontext.h"
35
36class QgsColorRamp;
38
44{
45
46 public:
47
57
59
61 QgsColorRampShader &operator=( const QgsColorRampShader &other );
62
63 bool operator==( const QgsColorRampShader &other ) const
64 {
65 if ( mColorRampItemList.count() != other.mColorRampItemList.count() ||
66 mClassificationMode != other.mClassificationMode ||
67 mColorRampType != other.mColorRampType )
68 {
69 return false;
70 }
71 for ( int i = 0; i < mColorRampItemList.count(); ++i )
72 {
73 if ( mColorRampItemList.at( i ) != other.mColorRampItemList.at( i ) ) return false;
74 }
75 return true;
76 }
77
78 //An entry for classification based upon value.
79 //Such a classification is typically used for
80 //single band layers where a pixel value represents
81 //not a color but a quantity, e.g. temperature or elevation
83 {
84
85 ColorRampItem() = default;
87 ColorRampItem( double val, const QColor &col, const QString &lbl = QString() )
88 : label( lbl )
89 , value( val )
90 , color( col )
91 {}
92
93 QString label;
94 double value = 0;
95 QColor color;
96
97 // compare operator for sorting
98 bool operator<( const QgsColorRampShader::ColorRampItem &other ) const { return value < other.value; }
99
101 {
102 return ( color != other.color ) ||
103 ( !std::isnan( value ) && !std::isnan( other.value ) && value != other.value ) ||
104 ( std::isnan( value ) != std::isnan( other.value ) );
105 }
106 };
107
113 QList<QgsColorRampShader::ColorRampItem> colorRampItemList() const { return mColorRampItemList.toList(); }
114
120 Qgis::ShaderInterpolationMethod colorRampType() const { return mColorRampType; }
121
123 QString colorRampTypeAsQString() const;
124
130 void setColorRampItemList( const QList<QgsColorRampShader::ColorRampItem> &list ); //TODO: sort on set
131
137 void setColorRampType( Qgis::ShaderInterpolationMethod colorRampType );
138
143 bool isEmpty() const;
144
149 QgsColorRamp *sourceColorRamp() const;
150
155 QgsColorRamp *createColorRamp() const SIP_FACTORY;
156
161 void setSourceColorRamp( QgsColorRamp *colorramp SIP_TRANSFER );
162
164 void setColorRampType( const QString &type );
165
173 void classifyColorRamp( int classes = 0, int band = -1, const QgsRectangle &extent = QgsRectangle(), QgsRasterInterface *input = nullptr );
174
181 void classifyColorRamp( int band = -1, const QgsRectangle &extent = QgsRectangle(), QgsRasterInterface *input = nullptr ) SIP_PYNAME( classifyColorRampV2 );
182
183 bool shade( double value, int *returnRedValue SIP_OUT, int *returnGreenValue SIP_OUT, int *returnBlueValue SIP_OUT, int *returnAlphaValue SIP_OUT ) const override;
184 bool shade( double redValue, double greenValue,
185 double blueValue, double alphaValue,
186 int *returnRedValue SIP_OUT, int *returnGreenValue SIP_OUT,
187 int *returnBlueValue SIP_OUT, int *returnAlphaValue SIP_OUT ) const override;
188 void legendSymbologyItems( QList< QPair< QString, QColor > > &symbolItems SIP_OUT ) const override;
189
194 QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
195
200 void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() );
201
207 void setClassificationMode( Qgis::ShaderClassificationMethod classificationMode ) { mClassificationMode = classificationMode; }
208
214 Qgis::ShaderClassificationMethod classificationMode() const { return mClassificationMode; }
215
221 void setClip( bool clip ) { mClip = clip; }
222
227 bool clip() const { return mClip; }
228
235 const QgsColorRampLegendNodeSettings *legendSettings() const;
236
245 void setLegendSettings( QgsColorRampLegendNodeSettings *settings SIP_TRANSFER );
246
247 protected:
248
250 std::unique_ptr<QgsColorRamp> mSourceColorRamp;
251
252 private:
253
261 QVector<QgsColorRampShader::ColorRampItem> mColorRampItemList;
262
265
270 mutable std::vector<int> mLUT;
271 mutable double mLUTOffset = 0.0;
272 mutable double mLUTFactor = 1.0;
273 mutable bool mLUTInitialized = false;
274
276 bool mClip = false;
277
278 std::unique_ptr< QgsColorRampLegendNodeSettings > mLegendSettings;
279
280};
281
282#endif
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
ShaderInterpolationMethod
Color ramp shader interpolation methods.
Definition qgis.h:1335
@ Linear
Interpolates the color between two class breaks linearly.
ShaderClassificationMethod
Color ramp shader classification methods.
Definition qgis.h:1350
@ Continuous
Uses breaks from color palette.
Settings for a color ramp legend node.
A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
~QgsColorRampShader() override
Qgis::ShaderClassificationMethod classificationMode() const
Returns the classification mode.
Qgis::ShaderInterpolationMethod colorRampType() const
Returns the color ramp interpolation method.
QList< QgsColorRampShader::ColorRampItem > colorRampItemList() const
Returns the custom color map.
bool operator==(const QgsColorRampShader &other) const
void setClip(bool clip)
Sets whether the shader should not render values out of range.
bool clip() const
Returns whether the shader will clip values which are out of range.
std::unique_ptr< QgsColorRamp > mSourceColorRamp
Source color ramp.
Abstract base class for color ramps.
Base class for processing filters like renderers, reprojector, resampler etc.
The raster shade function applies a shader to a pixel at render time - typically used to render grays...
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
#define SIP_PYNAME(name)
Definition qgis_sip.h:81
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_OUT
Definition qgis_sip.h:58
#define SIP_FACTORY
Definition qgis_sip.h:76
ColorRampItem(double val, const QColor &col, const QString &lbl=QString())
convenience constructor
bool operator!=(const QgsColorRampShader::ColorRampItem &other) const
bool operator<(const QgsColorRampShader::ColorRampItem &other) const