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>
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 *, int *) |
| | generates and new RGBA value based on one input value
|
| virtual bool | shade (double, double, double, double, int *, int *, int *, int *) |
| | generates and new RGBA value based on original RGBA value
|
| 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.
|
| 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.
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 |
| 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
-
| theValue | The 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
-
| theValue | The 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
-
| theValue | The original value to base a new RGBA value on |
| theReturnRedValue | The red component of the new RGBA value |
| theReturnGreenValue | The green component of the new RGBA value |
| theReturnBlueValue | The blue component of the new RGBA value |
| theReturnAlphaValue | The 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
-
| theRedValue | The red component of the original value to base a new RGBA value on |
| theGreenValue | The green component of the original value to base a new RGBA value on |
| theBlueValue | The blue component of the original value to base a new RGBA value on |
| theAlphaValue | The alpha component of the original value to base a new RGBA value on |
| theReturnRedValue | The red component of the new RGBA value |
| theReturnGreenValue | The green component of the new RGBA value |
| theReturnBlueValue | The blue component of the new RGBA value |
| theReturnAlphaValue | The 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:
1.8.1.2