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
QgsRasterShader Class Reference

Interface for all raster shaders. More...

#include <qgsrastershader.h>

Public Member Functions

 QgsRasterShader (double theMinimumValue=0.0, double theMaximumValue=255.0)
 
 ~QgsRasterShader ()
 
double maximumValue ()
 Return the maximum value for the raster shader. More...
 
double minimumValue ()
 Return the minimum value for the raster shader. More...
 
QgsRasterShaderFunctionrasterShaderFunction ()
 
const QgsRasterShaderFunctionrasterShaderFunction () const
 
bool shade (double, int *, int *, int *, int *)
 generates and new RGBA value based on one input value More...
 
bool shade (double, double, double, double, int *, int *, int *, int *)
 generates and new RGBA value based on original RGBA value More...
 
void setRasterShaderFunction (QgsRasterShaderFunction *)
 A public method that allows the user to set their own shader function. More...
 
void setMaximumValue (double)
 Set the maximum value. More...
 
void setMinimumValue (double)
 Return the minimum value. More...
 
void writeXML (QDomDocument &doc, QDomElement &parent) const
 
void readXML (const QDomElement &elem)
 

Detailed Description

Interface for all raster shaders.

Constructor & Destructor Documentation

QgsRasterShader::QgsRasterShader ( double  theMinimumValue = 0.0,
double  theMaximumValue = 255.0 
)
QgsRasterShader::~QgsRasterShader ( )

Member Function Documentation

double QgsRasterShader::maximumValue ( )
inline

Return the maximum value for the raster shader.

double QgsRasterShader::minimumValue ( )
inline

Return the minimum value for the raster shader.

QgsRasterShaderFunction* QgsRasterShader::rasterShaderFunction ( )
inline
const QgsRasterShaderFunction* QgsRasterShader::rasterShaderFunction ( ) const
inline
void QgsRasterShader::readXML ( const QDomElement &  elem)
void QgsRasterShader::setMaximumValue ( double  theValue)

Set the maximum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new maximum value
void QgsRasterShader::setMinimumValue ( double  theValue)

Return the minimum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new minimum value
void QgsRasterShader::setRasterShaderFunction ( QgsRasterShaderFunction theFunction)

A public method that allows the user to set their own shader function.

A public function that allows the user to set their own custom shader function.

Note
Raster shader takes ownership of the shader function instance
Parameters
theFunctionA pointer to the new raster shader function
bool QgsRasterShader::shade ( double  theValue,
int *  theReturnRedValue,
int *  theReturnGreenValue,
int *  theReturnBlueValue,
int *  theReturnAlpha 
)

generates and new RGBA value based on one input value

Generates and new RGBA value based on one input value.

Parameters
theValueThe original value to base a new RGBA value on
theReturnRedValueThe red component of the new RGBA value
theReturnGreenValueThe green component of the new RGBA value
theReturnBlueValueThe blue component of the new RGBA value
theReturnAlphaThe alpha component of the new RGBA value
Returns
True if the return values are valid otherwise false
bool QgsRasterShader::shade ( double  theRedValue,
double  theGreenValue,
double  theBlueValue,
double  theAlphaValue,
int *  theReturnRedValue,
int *  theReturnGreenValue,
int *  theReturnBlueValue,
int *  theReturnAlphaValue 
)

generates and new RGBA value based on original RGBA value

Generates and new RGBA value based on an original RGBA value.

Parameters
theRedValueThe red component of the original value to base a new RGBA value on
theGreenValueThe green component of the original value to base a new RGBA value on
theBlueValueThe blue component of the original value to base a new RGBA value on
theAlphaValueThe alpha component of the original value to base a new RGBA value on
theReturnRedValueThe red component of the new RGBA value
theReturnGreenValueThe green component of the new RGBA value
theReturnBlueValueThe blue component of the new RGBA value
theReturnAlphaValueThe alpha component of the new RGBA value
Returns
True if the return values are valid otherwise false
void QgsRasterShader::writeXML ( QDomDocument &  doc,
QDomElement &  parent 
) const

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