QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Member Functions | List of all members
QgsRasterTransparency Class Reference

Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters. More...

#include <qgsrastertransparency.h>

Classes

struct  TransparentSingleValuePixel
 
struct  TransparentThreeValuePixel
 

Public Member Functions

 QgsRasterTransparency ()
 
QList
< QgsRasterTransparency::TransparentSingleValuePixel
transparentSingleValuePixelList () const
 Accessor for transparentSingleValuePixelList. More...
 
QList
< QgsRasterTransparency::TransparentThreeValuePixel
transparentThreeValuePixelList () const
 Accessor for transparentThreeValuePixelList. More...
 
void initializeTransparentPixelList (double)
 Reset to the transparency list to a single value. More...
 
void initializeTransparentPixelList (double, double, double)
 Reset to the transparency list to a single value. More...
 
void setTransparentSingleValuePixelList (QList< QgsRasterTransparency::TransparentSingleValuePixel >)
 Mutator for transparentSingleValuePixelList. More...
 
void setTransparentThreeValuePixelList (QList< QgsRasterTransparency::TransparentThreeValuePixel >)
 Mutator for transparentThreeValuePixelList. More...
 
int alphaValue (double, int theGlobalTransparency=255) const
 Returns the transparency value for a single value Pixel. More...
 
int alphaValue (double, double, double, int theGlobalTransparency=255) const
 Return the transparency value for a RGB Pixel. More...
 
bool isEmpty () const
 True if there are no entries in the pixel lists except the nodata value. More...
 
void writeXML (QDomDocument &doc, QDomElement &parentElem) const
 
void readXML (const QDomElement &elem)
 

Detailed Description

Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters.

Constructor & Destructor Documentation

QgsRasterTransparency::QgsRasterTransparency ( )

Member Function Documentation

int QgsRasterTransparency::alphaValue ( double  theValue,
int  theGlobalTransparency = 255 
) const

Returns the transparency value for a single value Pixel.

Searches through the transparency list, if a match is found, the global transparency value is scaled by the stored transparency value.

Parameters
theValuethe needle to search for in the transparency hay stack
theGlobalTransparencythe overal transparency level for the layer
int QgsRasterTransparency::alphaValue ( double  theRedValue,
double  theGreenValue,
double  theBlueValue,
int  theGlobalTransparency = 255 
) const

Return the transparency value for a RGB Pixel.

Searches through the transparency list, if a match is found, the global transparency value is scaled by the stored transparency value.

Parameters
theRedValuethe red portion of the needle to search for in the transparency hay stack
theGreenValuethe green portion of the needle to search for in the transparency hay stack
theBlueValuethe green portion of the needle to search for in the transparency hay stack
theGlobalTransparencythe overal transparency level for the layer
void QgsRasterTransparency::initializeTransparentPixelList ( double  theValue)

Reset to the transparency list to a single value.

void QgsRasterTransparency::initializeTransparentPixelList ( double  theRedValue,
double  theGreenValue,
double  theBlueValue 
)

Reset to the transparency list to a single value.

bool QgsRasterTransparency::isEmpty ( ) const

True if there are no entries in the pixel lists except the nodata value.

void QgsRasterTransparency::readXML ( const QDomElement &  elem)
void QgsRasterTransparency::setTransparentSingleValuePixelList ( QList< QgsRasterTransparency::TransparentSingleValuePixel theNewList)

Mutator for transparentSingleValuePixelList.

Mutator for transparentSingleValuePixelList, replaces the whole list.

void QgsRasterTransparency::setTransparentThreeValuePixelList ( QList< QgsRasterTransparency::TransparentThreeValuePixel theNewList)

Mutator for transparentThreeValuePixelList.

Mutator for transparentThreeValuePixelList, replaces the whole list.

QList< QgsRasterTransparency::TransparentSingleValuePixel > QgsRasterTransparency::transparentSingleValuePixelList ( ) const

Accessor for transparentSingleValuePixelList.

QList< QgsRasterTransparency::TransparentThreeValuePixel > QgsRasterTransparency::transparentThreeValuePixelList ( ) const

Accessor for transparentThreeValuePixelList.

void QgsRasterTransparency::writeXML ( QDomDocument &  doc,
QDomElement &  parentElem 
) const

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