Quantum GIS API Documentation  1.8
Public Member Functions | Protected Attributes
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]

List of all members.

Public Member Functions

 QgsRasterShaderFunction (double theMinimumValue=0.0, double theMaximumValue=255.0)
virtual ~QgsRasterShaderFunction ()
virtual void setMaximumValue (double)
 Set the maximum value.
virtual void setMinimumValue (double)
 Return the minimum value.
virtual bool shade (double, int *, int *, int *)
 generates and new RGB value based on one input value
virtual bool shade (double, double, double, int *, int *, int *)
 generates and new RGB value based on original RGB value
double minimumMaximumRange () const
double minimumValue () const
double maximumValue () const

Protected Attributes

double mMaximumValue
 User defineable maximum value for the shading function.
double mMinimumValue
 User defineable minimum value for the shading function.
double mMinimumMaximumRange
 Minimum maximum range for the shading function.

Detailed Description

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

Definition at line 27 of file qgsrastershaderfunction.h.


Constructor & Destructor Documentation

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

Definition at line 32 of file qgsrastershaderfunction.h.


Member Function Documentation

double QgsRasterShaderFunction::maximumValue ( ) const [inline]

Definition at line 49 of file qgsrastershaderfunction.h.

Referenced by QgsRasterLayer::legendSymbologyItems().

Definition at line 46 of file qgsrastershaderfunction.h.

double QgsRasterShaderFunction::minimumValue ( ) const [inline]

Definition at line 48 of file qgsrastershaderfunction.h.

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 QgsFreakOutShader, and QgsPseudoColorShader.

Definition at line 36 of file qgsrastershaderfunction.cpp.

References mMaximumValue, mMinimumMaximumRange, mMinimumValue, and QgsDebugMsg.

Referenced by QgsRasterShader::setMaximumValue().

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 QgsFreakOutShader, and QgsPseudoColorShader.

Definition at line 49 of file qgsrastershaderfunction.cpp.

References mMaximumValue, mMinimumMaximumRange, mMinimumValue, and QgsDebugMsg.

Referenced by QgsRasterShader::setMinimumValue().

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

generates and new RGB value based on one input value

Generates and new RGB value based on one input value.

Parameters:
theValueThe original value to base a new RGB value on
theReturnRedValueThe red component of the new RGB value
theReturnGreenValueThe green component of the new RGB value
theReturnBlueValueThe blue component of the new RGB value
Returns:
True if the return values are valid otherwise false

Reimplemented in QgsColorRampShader, QgsFreakOutShader, and QgsPseudoColorShader.

Definition at line 66 of file qgsrastershaderfunction.cpp.

Referenced by QgsRasterShader::shade().

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

generates and new RGB value based on original RGB value

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

Parameters:
theRedValueThe red component of the original value to base a new RGB value on
theGreenValueThe green component of the original value to base a new RGB value on
theBlueValueThe blue component of the original value to base a new RGB value on
theReturnRedValueThe red component of the new RGB value
theReturnGreenValueThe green component of the new RGB value
theReturnBlueValueThe blue component of the new RGB value
Returns:
True if the return values are valid otherwise false

Reimplemented in QgsColorRampShader, QgsFreakOutShader, and QgsPseudoColorShader.

Definition at line 89 of file qgsrastershaderfunction.cpp.


Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines