QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Attributes | List of all members
QgsRasterShaderFunction Class Reference

The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color. More...

#include <qgsrastershaderfunction.h>

Inheritance diagram for QgsRasterShaderFunction:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterShaderFunction (double theMinimumValue=0.0, double theMaximumValue=255.0)
 
virtual ~QgsRasterShaderFunction ()
 
virtual void setMaximumValue (double)
 Set the maximum value. More...
 
virtual void setMinimumValue (double)
 Return the minimum value. More...
 
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
 

Protected Attributes

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

The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.

Constructor & Destructor Documentation

QgsRasterShaderFunction::QgsRasterShaderFunction ( double  theMinimumValue = 0.0,
double  theMaximumValue = 255.0 
)
virtual QgsRasterShaderFunction::~QgsRasterShaderFunction ( )
inlinevirtual

Member Function Documentation

virtual void QgsRasterShaderFunction::legendSymbologyItems ( QList< QPair< QString, QColor > > &  symbolItems) const
inlinevirtual

Reimplemented in QgsColorRampShader.

double QgsRasterShaderFunction::maximumValue ( ) const
inline
double QgsRasterShaderFunction::minimumMaximumRange ( ) const
inline
double QgsRasterShaderFunction::minimumValue ( ) const
inline
void QgsRasterShaderFunction::setMaximumValue ( double  theValue)
virtual

Set the maximum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new maximum value

Reimplemented in QgsPseudoColorShader.

void QgsRasterShaderFunction::setMinimumValue ( double  theValue)
virtual

Return the minimum value.

Set the maximum value for the raster shader.

Parameters
theValueThe new minimum value

Reimplemented in QgsPseudoColorShader.

bool QgsRasterShaderFunction::shade ( double  theValue,
int *  theReturnRedValue,
int *  theReturnGreenValue,
int *  theReturnBlueValue,
int *  theReturnAlphaValue 
)
virtual

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
theReturnAlphaValueThe blue component of the new RGBA value
Returns
True if the return values are valid otherwise false

Reimplemented in QgsColorRampShader.

bool QgsRasterShaderFunction::shade ( double  theRedValue,
double  theGreenValue,
double  theBlueValue,
double  theAlphaValue,
int *  theReturnRedValue,
int *  theReturnGreenValue,
int *  theReturnBlueValue,
int *  theReturnAlphaValue 
)
virtual

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

Reimplemented in QgsColorRampShader.

Member Data Documentation

double QgsRasterShaderFunction::mMaximumValue
protected

User defineable maximum value for the shading function.

double QgsRasterShaderFunction::mMinimumMaximumRange
protected

Minimum maximum range for the shading function.

double QgsRasterShaderFunction::mMinimumValue
protected

User defineable minimum value for the shading function.


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