QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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)
 
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...
 
void setMaximumValue (double)
 Set the maximum value. More...
 
void setMinimumValue (double)
 Return the minimum value. More...
 
double classBreakMin1 () const
 
double classBreakMax1 () const
 
double classBreakMin2 () const
 
double classBreakMax2 () const
 
double classBreakMin3 () const
 
- Public Member Functions inherited from QgsRasterShaderFunction
 QgsRasterShaderFunction (double theMinimumValue=0.0, double theMaximumValue=255.0)
 
virtual ~QgsRasterShaderFunction ()
 
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...
 
double minimumMaximumRange () const
 
double minimumValue () const
 
double maximumValue () const
 
virtual void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

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

Member Function Documentation

double QgsPseudoColorShader::classBreakMax1 ( ) const
inline
double QgsPseudoColorShader::classBreakMax2 ( ) const
inline
double QgsPseudoColorShader::classBreakMin1 ( ) const
inline
double QgsPseudoColorShader::classBreakMin2 ( ) const
inline
double QgsPseudoColorShader::classBreakMin3 ( ) const
inline
void QgsPseudoColorShader::setMaximumValue ( double  theValue)
virtual

Set the maximum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new maximum value

Reimplemented from QgsRasterShaderFunction.

void QgsPseudoColorShader::setMinimumValue ( double  theValue)
virtual

Return the minimum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new minimum value

Reimplemented from QgsRasterShaderFunction.

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

generates and new RGB value based on one input value

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


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