A ramp shader will color a raster pixel based on a list of values ranges in a ramp. More...

#include <qgscolorrampshader.h>

Inheritance diagram for QgsColorRampShader:

Classes
struct	ColorRampItem

Public Types
enum	ColorRamp_TYPE { INTERPOLATED, DISCRETE, EXACT }

Public Member Functions
	QgsColorRampShader (double theMinimumValue=0.0, double theMaximumValue=255.0)

bool	clip () const

QList< QgsColorRampShader::ColorRampItem >	colorRampItemList () const
	Get the custom colormap. More...

QgsColorRampShader::ColorRamp_TYPE	colorRampType () const
	Get the color ramp type. More...

QString	colorRampTypeAsQString ()
	Get the color ramp type as a string. More...

void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const override

int	maximumColorCacheSize ()
	Get the maximum size the color cache can be. More...

void	setClip (bool clip)

void	setColorRampItemList (const QList< QgsColorRampShader::ColorRampItem > &theList)
	Set custom colormap. More...

void	setColorRampType (QgsColorRampShader::ColorRamp_TYPE theColorRampType)
	Set the color ramp type. More...

void	setColorRampType (const QString &theType)
	Set the color ramp type. More...

void	setMaximumColorCacheSize (int theSize)
	Set the maximum size the color cache can be. More...

bool	shade (double, int , int , int , int ) override
	Generates and new RGB value based on one input value. More...

bool	shade (double, double, double, double, int , int , int , int ) override
	Generates and new RGB value based on original RGB value. More...

Public Member Functions inherited from QgsRasterShaderFunction
	QgsRasterShaderFunction (double theMinimumValue=0.0, double theMaximumValue=255.0)

virtual	~QgsRasterShaderFunction ()

double	maximumValue () const

double	minimumMaximumRange () const

double	minimumValue () const

virtual void	setMaximumValue (double)
	Set the maximum value. More...

virtual void	setMinimumValue (double)
	Return the minimum value. More...

Additional Inherited Members
Protected Attributes inherited from QgsRasterShaderFunction
double	mMaximumValue
	User defineable maximum value for the shading function. More...

double	mMinimumMaximumRange
	Minimum maximum range for the shading function. More...

double	mMinimumValue
	User defineable minimum value for the shading function. More...

Detailed Description

A ramp shader will color a raster pixel based on a list of values ranges in a ramp.

Definition at line 32 of file qgscolorrampshader.h.

Constructor & Destructor Documentation

QgsColorRampShader::QgsColorRampShader	(	double	theMinimumValue = `0.0`,
		double	theMaximumValue = `255.0`
	)

Definition at line 28 of file qgscolorrampshader.cpp.

Member Function Documentation

bool QgsColorRampShader::clip ( ) const

inline

Definition at line 97 of file qgscolorrampshader.h.

QList<QgsColorRampShader::ColorRampItem> QgsColorRampShader::colorRampItemList ( ) const

inline

Get the custom colormap.

Definition at line 65 of file qgscolorrampshader.h.

QgsColorRampShader::ColorRamp_TYPE QgsColorRampShader::colorRampType ( ) const

inline

Get the color ramp type.

Definition at line 68 of file qgscolorrampshader.h.

QString QgsColorRampShader::colorRampTypeAsQString ( )

Get the color ramp type as a string.

Definition at line 38 of file qgscolorrampshader.cpp.

void QgsColorRampShader::legendSymbologyItems ( QList< QPair< QString, QColor > > & symbolItems ) const

overridevirtual

Reimplemented from QgsRasterShaderFunction.

Definition at line 311 of file qgscolorrampshader.cpp.

int QgsColorRampShader::maximumColorCacheSize ( )

inline

Get the maximum size the color cache can be.

Definition at line 74 of file qgscolorrampshader.h.

void QgsColorRampShader::setClip ( bool clip )

inline

Definition at line 96 of file qgscolorrampshader.h.

void QgsColorRampShader::setColorRampItemList ( const QList< QgsColorRampShader::ColorRampItem > & theList )

Set custom colormap.

Definition at line 223 of file qgscolorrampshader.cpp.

void QgsColorRampShader::setColorRampType ( QgsColorRampShader::ColorRamp_TYPE theColorRampType )

Set the color ramp type.

Definition at line 230 of file qgscolorrampshader.cpp.

void QgsColorRampShader::setColorRampType ( const QString & theType )

Set the color ramp type.

Definition at line 237 of file qgscolorrampshader.cpp.

void QgsColorRampShader::setMaximumColorCacheSize ( int theSize )

inline

Set the maximum size the color cache can be.

Definition at line 86 of file qgscolorrampshader.h.

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

overridevirtual

Generates and new RGB value based on one input value.

Reimplemented from QgsRasterShaderFunction.

Definition at line 255 of file qgscolorrampshader.cpp.

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

overridevirtual

Generates and new RGB value based on original RGB value.

Reimplemented from QgsRasterShaderFunction.

Definition at line 293 of file qgscolorrampshader.cpp.

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

/tmp/buildd/qgis-2.12.0+99unstable/src/core/raster/qgscolorrampshader.h
/tmp/buildd/qgis-2.12.0+99unstable/src/core/raster/qgscolorrampshader.cpp

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation