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:

Collaboration diagram for QgsPseudoColorShader:

List of all members.

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
bool	shade (double, double, double, int *, int *, int *)
	generates and new RGB value based on original RGB value
void	setMaximumValue (double)
	Set the maximum value.
void	setMinimumValue (double)
	Return the minimum value.
double	classBreakMin1 () const
double	classBreakMax1 () const
double	classBreakMin2 () const
double	classBreakMax2 () const
double	classBreakMin3 () const
Private Member Functions
void	setClassBreaks ()
Private Attributes
double	mBreakSize
double	mClassBreakMin1
double	mClassBreakMax1
double	mClassBreakMin2
double	mClassBreakMax2
double	mClassBreakMin3

---

Detailed Description

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

Definition at line 29 of file qgspseudocolorshader.h.

---

Constructor & Destructor Documentation

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

Definition at line 25 of file qgspseudocolorshader.cpp.

References setClassBreaks().

---

Member Function Documentation

double QgsPseudoColorShader::classBreakMax1

(

)

const [inline]

Definition at line 48 of file qgspseudocolorshader.h.

Referenced by QgsRasterLayer::legendSymbologyItems().

double QgsPseudoColorShader::classBreakMax2

(

)

const [inline]

Definition at line 50 of file qgspseudocolorshader.h.

Referenced by QgsRasterLayer::legendSymbologyItems().

double QgsPseudoColorShader::classBreakMin1

(

)

const [inline]

Definition at line 47 of file qgspseudocolorshader.h.

Referenced by QgsRasterLayer::legendSymbologyItems().

double QgsPseudoColorShader::classBreakMin2

(

)

const [inline]

Definition at line 49 of file qgspseudocolorshader.h.

double QgsPseudoColorShader::classBreakMin3

(

)

const [inline]

Definition at line 51 of file qgspseudocolorshader.h.

void QgsPseudoColorShader::setClassBreaks

(

)

[private]

Definition at line 84 of file qgspseudocolorshader.cpp.

References mBreakSize, mClassBreakMax1, mClassBreakMax2, mClassBreakMin1, mClassBreakMin2, mClassBreakMin3, QgsRasterShaderFunction::mMinimumMaximumRange, and QgsRasterShaderFunction::mMinimumValue.

Referenced by QgsPseudoColorShader(), setMaximumValue(), and setMinimumValue().

void QgsPseudoColorShader::setMaximumValue

(

double

theValue

)

[virtual]

Set the maximum value.

Set the maximum value for the raster shader.

Parameters:

theValue

The new maximum value

Reimplemented from QgsRasterShaderFunction.

Definition at line 100 of file qgspseudocolorshader.cpp.

References QgsRasterShaderFunction::mMaximumValue, QgsRasterShaderFunction::mMinimumMaximumRange, QgsRasterShaderFunction::mMinimumValue, and setClassBreaks().

void QgsPseudoColorShader::setMinimumValue

(

double

theValue

)

[virtual]

Return the minimum value.

Set the maximum value for the raster shader.

Parameters:

theValue

The new minimum value

Reimplemented from QgsRasterShaderFunction.

Definition at line 112 of file qgspseudocolorshader.cpp.

References QgsRasterShaderFunction::mMaximumValue, QgsRasterShaderFunction::mMinimumMaximumRange, QgsRasterShaderFunction::mMinimumValue, and setClassBreaks().

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

generates and new RGB value based on one input value

Reimplemented from QgsRasterShaderFunction.

Definition at line 31 of file qgspseudocolorshader.cpp.

References mClassBreakMax1, mClassBreakMax2, mClassBreakMin1, mClassBreakMin2, mClassBreakMin3, QgsRasterShaderFunction::mMaximumValue, QgsRasterShaderFunction::mMinimumMaximumRange, and QgsRasterShaderFunction::mMinimumValue.

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

generates and new RGB value based on original RGB value

Reimplemented from QgsRasterShaderFunction.

Definition at line 71 of file qgspseudocolorshader.cpp.

---

Member Data Documentation

double QgsPseudoColorShader::mBreakSize [private]

Definition at line 56 of file qgspseudocolorshader.h.

Referenced by setClassBreaks().

double QgsPseudoColorShader::mClassBreakMax1 [private]

Definition at line 58 of file qgspseudocolorshader.h.

Referenced by setClassBreaks(), and shade().

double QgsPseudoColorShader::mClassBreakMax2 [private]

Definition at line 60 of file qgspseudocolorshader.h.

Referenced by setClassBreaks(), and shade().

double QgsPseudoColorShader::mClassBreakMin1 [private]

Definition at line 57 of file qgspseudocolorshader.h.

Referenced by setClassBreaks(), and shade().

double QgsPseudoColorShader::mClassBreakMin2 [private]

Definition at line 59 of file qgspseudocolorshader.h.

Referenced by setClassBreaks(), and shade().

double QgsPseudoColorShader::mClassBreakMin3 [private]

Definition at line 61 of file qgspseudocolorshader.h.

Referenced by setClassBreaks(), and shade().

---

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

• src/core/raster/qgspseudocolorshader.h
• src/core/raster/qgspseudocolorshader.cpp