QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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 legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 
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...
 
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...
 

Protected Attributes

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

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 30 of file qgsrastershaderfunction.h.

Constructor & Destructor Documentation

◆ QgsRasterShaderFunction()

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

Definition at line 22 of file qgsrastershaderfunction.cpp.

◆ ~QgsRasterShaderFunction()

virtual QgsRasterShaderFunction::~QgsRasterShaderFunction ( )
inlinevirtual

Definition at line 35 of file qgsrastershaderfunction.h.

Member Function Documentation

◆ legendSymbologyItems()

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

Reimplemented in QgsColorRampShader.

Definition at line 54 of file qgsrastershaderfunction.h.

◆ maximumValue()

double QgsRasterShaderFunction::maximumValue ( ) const
inline

Definition at line 52 of file qgsrastershaderfunction.h.

◆ minimumMaximumRange()

double QgsRasterShaderFunction::minimumMaximumRange ( ) const
inline

Definition at line 49 of file qgsrastershaderfunction.h.

◆ minimumValue()

double QgsRasterShaderFunction::minimumValue ( ) const
inline

Definition at line 51 of file qgsrastershaderfunction.h.

◆ setMaximumValue()

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.

Definition at line 36 of file qgsrastershaderfunction.cpp.

◆ setMinimumValue()

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.

Definition at line 49 of file qgsrastershaderfunction.cpp.

◆ shade() [1/2]

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.

Definition at line 67 of file qgsrastershaderfunction.cpp.

◆ shade() [2/2]

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.

Definition at line 93 of file qgsrastershaderfunction.cpp.

Member Data Documentation

◆ mMaximumValue

double QgsRasterShaderFunction::mMaximumValue
protected

User defineable maximum value for the shading function.

Definition at line 58 of file qgsrastershaderfunction.h.

◆ mMinimumMaximumRange

double QgsRasterShaderFunction::mMinimumMaximumRange
protected

Minimum maximum range for the shading function.

Definition at line 64 of file qgsrastershaderfunction.h.

◆ mMinimumValue

double QgsRasterShaderFunction::mMinimumValue
protected

User defineable minimum value for the shading function.

Definition at line 61 of file qgsrastershaderfunction.h.


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