QGIS API Documentation 3.41.0-Master (a6c88b06562)
|
A ramp shader will color a raster pixel based on a list of values ranges in a ramp. More...
#include <qgscolorrampshader.h>
Classes | |
struct | ColorRampItem |
Public Member Functions | |
QgsColorRampShader (const QgsColorRampShader &other) | |
QgsColorRampShader (double minimumValue=0.0, double maximumValue=255.0, QgsColorRamp *colorRamp=nullptr, Qgis::ShaderInterpolationMethod type=Qgis::ShaderInterpolationMethod::Linear, Qgis::ShaderClassificationMethod classificationMode=Qgis::ShaderClassificationMethod::Continuous) | |
Creates a new color ramp shader. | |
~QgsColorRampShader () override | |
Qgis::ShaderClassificationMethod | classificationMode () const |
Returns the classification mode. | |
void | classifyColorRamp (int band=-1, const QgsRectangle &extent=QgsRectangle(), QgsRasterInterface *input=nullptr) |
Classify color ramp shader. | |
void | classifyColorRamp (int classes=0, int band=-1, const QgsRectangle &extent=QgsRectangle(), QgsRasterInterface *input=nullptr) |
Classify color ramp shader. | |
bool | clip () const |
Returns whether the shader will clip values which are out of range. | |
QList< QgsColorRampShader::ColorRampItem > | colorRampItemList () const |
Returns the custom color map. | |
Qgis::ShaderInterpolationMethod | colorRampType () const |
Returns the color ramp interpolation method. | |
QString | colorRampTypeAsQString () const |
Returns the color ramp type as a string. | |
QgsColorRamp * | createColorRamp () const |
Creates a gradient color ramp from shader settings. | |
bool | isEmpty () const |
Whether the color ramp contains any items. | |
const QgsColorRampLegendNodeSettings * | legendSettings () const |
Returns the color ramp shader legend settings. | |
void | legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const override |
Returns legend symbology items if provided by renderer. | |
QgsColorRampShader & | operator= (const QgsColorRampShader &other) |
bool | operator== (const QgsColorRampShader &other) const |
void | readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext()) |
Reads configuration from the given DOM element. | |
void | setClassificationMode (Qgis::ShaderClassificationMethod classificationMode) |
Sets the classification mode. | |
void | setClip (bool clip) |
Sets whether the shader should not render values out of range. | |
void | setColorRampItemList (const QList< QgsColorRampShader::ColorRampItem > &list) |
Sets a custom color map. | |
void | setColorRampType (const QString &type) |
Sets the color ramp type. | |
void | setColorRampType (Qgis::ShaderInterpolationMethod colorRampType) |
Sets the color ramp interpolation method. | |
void | setLegendSettings (QgsColorRampLegendNodeSettings *settings) |
Sets the color ramp shader legend settings. | |
void | setSourceColorRamp (QgsColorRamp *colorramp) |
Set the source color ramp. | |
bool | shade (double redValue, double greenValue, double blueValue, double alphaValue, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlphaValue) const override |
Generates an new RGBA value based on an original RGBA value. | |
bool | shade (double value, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlphaValue) const override |
Generates an new RGBA value based on one input value. | |
QgsColorRamp * | sourceColorRamp () const |
Returns the source color ramp. | |
QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const |
Writes configuration to a new DOM element. | |
Public Member Functions inherited from QgsRasterShaderFunction | |
QgsRasterShaderFunction (double minimumValue=0.0, double maximumValue=255.0) | |
virtual | ~QgsRasterShaderFunction ()=default |
int | labelPrecision () const |
Returns label precision. | |
double | maximumValue () const |
Returns the minimum value for the raster shader. | |
double | minimumMaximumRange () const |
double | minimumValue () const |
Returns the maximum value for the raster shader. | |
void | setLabelPrecision (int labelPrecision) |
Sets label precision to labelPrecision. | |
virtual void | setMaximumValue (double value) |
Sets the maximum value for the raster shader. | |
virtual void | setMinimumValue (double value) |
Sets the minimum value for the raster shader. | |
Protected Attributes | |
std::unique_ptr< QgsColorRamp > | mSourceColorRamp |
Source color ramp. | |
Protected Attributes inherited from QgsRasterShaderFunction | |
int | mLabelPrecision = 6 |
Label precision. | |
double | mMaximumValue |
User defineable maximum value for the shading function. | |
double | mMinimumMaximumRange |
Minimum maximum range for the shading function. | |
double | mMinimumValue |
User defineable minimum value for the shading function. | |
A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
Definition at line 43 of file qgscolorrampshader.h.
QgsColorRampShader::QgsColorRampShader | ( | double | minimumValue = 0.0 , |
double | maximumValue = 255.0 , |
||
QgsColorRamp * | colorRamp = nullptr , |
||
Qgis::ShaderInterpolationMethod | type = Qgis::ShaderInterpolationMethod::Linear , |
||
Qgis::ShaderClassificationMethod | classificationMode = Qgis::ShaderClassificationMethod::Continuous |
||
) |
Creates a new color ramp shader.
minimumValue | minimum value for the raster shader |
maximumValue | maximum value for the raster shader |
type | interpolation type used |
classificationMode | method used to classify the color ramp shader |
colorRamp | vector color ramp used to classify the color ramp shader. Ownership is transferred to the shader. |
Definition at line 35 of file qgscolorrampshader.cpp.
|
overridedefault |
QgsColorRampShader::QgsColorRampShader | ( | const QgsColorRampShader & | other | ) |
Definition at line 48 of file qgscolorrampshader.cpp.
|
inline |
Returns the classification mode.
Definition at line 214 of file qgscolorrampshader.h.
void QgsColorRampShader::classifyColorRamp | ( | int | band = -1 , |
const QgsRectangle & | extent = QgsRectangle() , |
||
QgsRasterInterface * | input = nullptr |
||
) |
Classify color ramp shader.
band | raster band used in classification (quantile mode only) |
extent | extent used in classification (quantile mode only) |
input | raster input used in classification (quantile mode only) |
Definition at line 375 of file qgscolorrampshader.cpp.
void QgsColorRampShader::classifyColorRamp | ( | int | classes = 0 , |
int | band = -1 , |
||
const QgsRectangle & | extent = QgsRectangle() , |
||
QgsRasterInterface * | input = nullptr |
||
) |
Classify color ramp shader.
classes | number of classes |
band | raster band used in classification (only used in quantile mode) |
extent | extent used in classification (only used in quantile mode) |
input | raster input used in classification (only used in quantile mode) |
Definition at line 186 of file qgscolorrampshader.cpp.
|
inline |
Returns whether the shader will clip values which are out of range.
Definition at line 227 of file qgscolorrampshader.h.
|
inline |
Returns the custom color map.
Definition at line 113 of file qgscolorrampshader.h.
|
inline |
Returns the color ramp interpolation method.
Definition at line 120 of file qgscolorrampshader.h.
QString QgsColorRampShader::colorRampTypeAsQString | ( | ) | const |
Returns the color ramp type as a string.
Definition at line 84 of file qgscolorrampshader.cpp.
QgsColorRamp * QgsColorRampShader::createColorRamp | ( | ) | const |
Creates a gradient color ramp from shader settings.
Definition at line 137 of file qgscolorrampshader.cpp.
bool QgsColorRampShader::isEmpty | ( | ) | const |
Whether the color ramp contains any items.
Definition at line 111 of file qgscolorrampshader.cpp.
const QgsColorRampLegendNodeSettings * QgsColorRampShader::legendSettings | ( | ) | const |
Returns the color ramp shader legend settings.
Definition at line 640 of file qgscolorrampshader.cpp.
|
overridevirtual |
Returns legend symbology items if provided by renderer.
Reimplemented from QgsRasterShaderFunction.
Definition at line 553 of file qgscolorrampshader.cpp.
QgsColorRampShader & QgsColorRampShader::operator= | ( | const QgsColorRampShader & | other | ) |
Definition at line 64 of file qgscolorrampshader.cpp.
|
inline |
Definition at line 63 of file qgscolorrampshader.h.
void QgsColorRampShader::readXml | ( | const QDomElement & | elem, |
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) |
Reads configuration from the given DOM element.
Definition at line 598 of file qgscolorrampshader.cpp.
|
inline |
Sets the classification mode.
Definition at line 207 of file qgscolorrampshader.h.
|
inline |
Sets whether the shader should not render values out of range.
clip | set to true to clip values which are out of range. |
Definition at line 221 of file qgscolorrampshader.h.
void QgsColorRampShader::setColorRampItemList | ( | const QList< QgsColorRampShader::ColorRampItem > & | list | ) |
Sets a custom color map.
Definition at line 98 of file qgscolorrampshader.cpp.
void QgsColorRampShader::setColorRampType | ( | const QString & | type | ) |
Sets the color ramp type.
Definition at line 116 of file qgscolorrampshader.cpp.
void QgsColorRampShader::setColorRampType | ( | Qgis::ShaderInterpolationMethod | colorRampType | ) |
Sets the color ramp interpolation method.
Definition at line 106 of file qgscolorrampshader.cpp.
void QgsColorRampShader::setLegendSettings | ( | QgsColorRampLegendNodeSettings * | settings | ) |
Sets the color ramp shader legend settings.
Ownership of settings is transferred.
Definition at line 645 of file qgscolorrampshader.cpp.
void QgsColorRampShader::setSourceColorRamp | ( | QgsColorRamp * | colorramp | ) |
Set the source color ramp.
Ownership is transferred to the shader.
Definition at line 181 of file qgscolorrampshader.cpp.
|
overridevirtual |
Generates an new RGBA value based on an original RGBA value.
redValue | The red component of the original value to base a new RGBA value on |
greenValue | The green component of the original value to base a new RGBA value on |
blueValue | The blue component of the original value to base a new RGBA value on |
alphaValue | The alpha component of the original value to base a new RGBA value on |
returnRedValue | The red component of the new RGBA value |
returnGreenValue | The green component of the new RGBA value |
returnBlueValue | The blue component of the new RGBA value |
returnAlpha | The alpha component of the new RGBA value |
true
if the return values are valid otherwise false
Reimplemented from QgsRasterShaderFunction.
Definition at line 535 of file qgscolorrampshader.cpp.
|
overridevirtual |
Generates an new RGBA value based on one input value.
value | The original value to base a new RGBA value on |
returnRedValue | The red component of the new RGBA value |
returnGreenValue | The green component of the new RGBA value |
returnBlueValue | The blue component of the new RGBA value |
returnAlpha | The alpha component of the new RGBA value |
true
if the return values are valid otherwise false
Reimplemented from QgsRasterShaderFunction.
Definition at line 380 of file qgscolorrampshader.cpp.
QgsColorRamp * QgsColorRampShader::sourceColorRamp | ( | ) | const |
Returns the source color ramp.
Definition at line 132 of file qgscolorrampshader.cpp.
QDomElement QgsColorRampShader::writeXml | ( | QDomDocument & | doc, |
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) | const |
Writes configuration to a new DOM element.
Definition at line 562 of file qgscolorrampshader.cpp.
|
protected |
Source color ramp.
Definition at line 250 of file qgscolorrampshader.h.