QGIS/python/core/raster/qgsrastershader.sip
Nyall Dawson 4cfacf14e3 Make API more consistent
- rename methods with XML to Xml, CRS to Crs, WMS to Wms, ID to Id
- rename methods with SRS to Crs
- rename methods with abbreviations like "dest" to "destination"
- rename methods with abbreviations like "src" to "source"
2016-07-21 08:40:50 +10:00

55 lines
1.4 KiB
Plaintext

class QgsRasterShader
{
%TypeHeaderCode
#include <qgsrastershader.h>
#include <qgsrastershaderfunction.h>
%End
public:
QgsRasterShader( double theMinimumValue = 0.0, double theMaximumValue = 255.0 );
~QgsRasterShader();
/*
*
* Non-Static Inline methods
*
*/
/** \brief Return the maximum value for the raster shader */
double maximumValue();
/** \brief Return the minimum value for the raster shader */
double minimumValue();
QgsRasterShaderFunction* rasterShaderFunction();
/*
*
* Non-Static methods
*
*/
/** \brief generates and new RGBA value based on one input value */
bool shade( double, int* /Out/, int* /Out/, int* /Out/, int* /Out/ );
/** \brief generates and new RGBA value based on original RGBA value */
bool shade( double, double, double, double, int* /Out/, int* /Out/, int* /Out/, int* /Out/ );
/** \brief A public method that allows the user to set their own shader function
\note Raster shader takes ownership of the shader function instance */
void setRasterShaderFunction( QgsRasterShaderFunction* /Transfer/ );
/** \brief Set the maximum value */
void setMaximumValue( double );
/** \brief Return the minimum value */
void setMinimumValue( double );
void writeXml( QDomDocument& doc, QDomElement& parent ) const;
void readXml( const QDomElement& elem );
private:
QgsRasterShader( const QgsRasterShader& rh );
};