QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsPseudoColorShader Class Reference

A raster color shader that highlighs low values in blue and high values in red. More...

#include <qgspseudocolorshader.h>

Inheritance diagram for QgsPseudoColorShader:
Inheritance graph
[legend]

Public Member Functions

 QgsPseudoColorShader (double theMinimumValue=0.0, double theMaximumValue=255.0)
 
double classBreakMax1 () const
 
double classBreakMax2 () const
 
double classBreakMin1 () const
 
double classBreakMin2 () const
 
double classBreakMin3 () const
 
void setMaximumValue (double) override
 Set the maximum value. More...
 
void setMinimumValue (double) override
 Return the minimum value. More...
 
bool shade (double, int *, int *, int *)
 generates and new RGB value based on one input value More...
 
bool shade (double, double, double, int *, int *, int *)
 generates and new RGB value based on original RGB value More...
 
- Public Member Functions inherited from QgsRasterShaderFunction
 QgsRasterShaderFunction (double theMinimumValue=0.0, double theMaximumValue=255.0)
 
virtual ~QgsRasterShaderFunction ()
 
virtual void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 
double maximumValue () const
 
double minimumMaximumRange () const
 
double minimumValue () const
 
virtual bool shade (double, int *, int *, int *, int *)
 generates and new RGBA value based on one input value More...
 
virtual bool shade (double, double, double, double, int *, int *, int *, int *)
 generates and new RGBA value based on original RGBA value More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsRasterShaderFunction
double mMaximumValue
 User defineable maximum value for the shading function. More...
 
double mMinimumMaximumRange
 Minimum maximum range for the shading function. More...
 
double mMinimumValue
 User defineable minimum value for the shading function. More...
 

Detailed Description

A raster color shader that highlighs low values in blue and high values in red.

Definition at line 29 of file qgspseudocolorshader.h.

Constructor & Destructor Documentation

◆ QgsPseudoColorShader()

QgsPseudoColorShader::QgsPseudoColorShader ( double  theMinimumValue = 0.0,
double  theMaximumValue = 255.0 
)

Definition at line 25 of file qgspseudocolorshader.cpp.

Member Function Documentation

◆ classBreakMax1()

double QgsPseudoColorShader::classBreakMax1 ( ) const
inline

Definition at line 48 of file qgspseudocolorshader.h.

◆ classBreakMax2()

double QgsPseudoColorShader::classBreakMax2 ( ) const
inline

Definition at line 50 of file qgspseudocolorshader.h.

◆ classBreakMin1()

double QgsPseudoColorShader::classBreakMin1 ( ) const
inline

Definition at line 47 of file qgspseudocolorshader.h.

◆ classBreakMin2()

double QgsPseudoColorShader::classBreakMin2 ( ) const
inline

Definition at line 49 of file qgspseudocolorshader.h.

◆ classBreakMin3()

double QgsPseudoColorShader::classBreakMin3 ( ) const
inline

Definition at line 51 of file qgspseudocolorshader.h.

◆ setMaximumValue()

void QgsPseudoColorShader::setMaximumValue ( double  theValue)
overridevirtual

Set the maximum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new maximum value

Reimplemented from QgsRasterShaderFunction.

Definition at line 100 of file qgspseudocolorshader.cpp.

◆ setMinimumValue()

void QgsPseudoColorShader::setMinimumValue ( double  theValue)
overridevirtual

Return the minimum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new minimum value

Reimplemented from QgsRasterShaderFunction.

Definition at line 112 of file qgspseudocolorshader.cpp.

◆ shade() [1/2]

bool QgsPseudoColorShader::shade ( double  theValue,
int *  theReturnRedValue,
int *  theReturnGreenValue,
int *  theReturnBlueValue 
)

generates and new RGB value based on one input value

Definition at line 31 of file qgspseudocolorshader.cpp.

◆ shade() [2/2]

bool QgsPseudoColorShader::shade ( double  theRedValue,
double  theGreenValue,
double  theBlueValue,
int *  theReturnRedValue,
int *  theReturnGreenValue,
int *  theReturnBlueValue 
)

generates and new RGB value based on original RGB value

Definition at line 71 of file qgspseudocolorshader.cpp.


The documentation for this class was generated from the following files: