Quantum GIS API Documentation
1.8
|
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 |
Mutator for transparentSingleValuePixelList. | |
QList < QgsRasterTransparency::TransparentThreeValuePixel > | transparentThreeValuePixelList () const |
Mutator for transparentThreeValuePixelList. | |
void | initializeTransparentPixelList (double) |
Reset to the transparency list to a single value. | |
void | initializeTransparentPixelList (double, double, double) |
Reset to the transparency list to a single value. | |
void | setTransparentSingleValuePixelList (QList< QgsRasterTransparency::TransparentSingleValuePixel >) |
Accessor for transparentSingleValuePixelList. | |
void | setTransparentThreeValuePixelList (QList< QgsRasterTransparency::TransparentThreeValuePixel >) |
Accessor for transparentThreeValuePixelList. | |
int | alphaValue (double, int theGlobalTransparency=255) const |
Returns the transparency value for a single value Pixel. | |
int | alphaValue (double, double, double, int theGlobalTransparency=255) const |
Return the transparency value for a RGB Pixel. | |
Private Attributes | |
QList < QgsRasterTransparency::TransparentThreeValuePixel > | mTransparentThreeValuePixelList |
The list to hold transparency values for RGB layers. | |
QList < QgsRasterTransparency::TransparentSingleValuePixel > | mTransparentSingleValuePixelList |
The lsit to hold transparency values for single value pixel layers. |
Defines the list of pixel values to be considered as transparent or semi transparent when rendering rasters.
Definition at line 25 of file qgsrastertransparency.h.
Definition at line 22 of file qgsrastertransparency.cpp.
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.
theValue | the needle to search for in the transparency hay stack |
theGlobalTransparency | the overal transparency level for the layer |
Definition at line 98 of file qgsrastertransparency.cpp.
References mTransparentSingleValuePixelList, QgsRasterTransparency::TransparentSingleValuePixel::percentTransparent, and QgsRasterTransparency::TransparentSingleValuePixel::pixelValue.
Referenced by QgsRasterLayer::drawMultiBandColor(), QgsRasterLayer::drawPalettedSingleBandColor(), QgsRasterLayer::drawPalettedSingleBandGray(), QgsRasterLayer::drawPalettedSingleBandPseudoColor(), QgsRasterLayer::drawSingleBandGray(), and QgsRasterLayer::drawSingleBandPseudoColor().
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.
theRedValue | the red portion of the needle to search for in the transparency hay stack |
theGreenValue | the green portion of the needle to search for in the transparency hay stack |
theBlueValue | the green portion of the needle to search for in the transparency hay stack |
theGlobalTransparency | the overal transparency level for the layer |
Definition at line 136 of file qgsrastertransparency.cpp.
References QgsRasterTransparency::TransparentThreeValuePixel::blue, QgsRasterTransparency::TransparentThreeValuePixel::green, mTransparentThreeValuePixelList, QgsRasterTransparency::TransparentThreeValuePixel::percentTransparent, and QgsRasterTransparency::TransparentThreeValuePixel::red.
void QgsRasterTransparency::initializeTransparentPixelList | ( | double | theValue | ) |
Reset to the transparency list to a single value.
Definition at line 46 of file qgsrastertransparency.cpp.
References mTransparentSingleValuePixelList, QgsRasterTransparency::TransparentSingleValuePixel::percentTransparent, and QgsRasterTransparency::TransparentSingleValuePixel::pixelValue.
Referenced by QgsRasterLayer::setDataProvider().
void QgsRasterTransparency::initializeTransparentPixelList | ( | double | theRedValue, |
double | theGreenValue, | ||
double | theBlueValue | ||
) |
Reset to the transparency list to a single value.
Definition at line 61 of file qgsrastertransparency.cpp.
References QgsRasterTransparency::TransparentThreeValuePixel::blue, QgsRasterTransparency::TransparentThreeValuePixel::green, mTransparentThreeValuePixelList, QgsRasterTransparency::TransparentThreeValuePixel::percentTransparent, and QgsRasterTransparency::TransparentThreeValuePixel::red.
void QgsRasterTransparency::setTransparentSingleValuePixelList | ( | QList< QgsRasterTransparency::TransparentSingleValuePixel > | theNewList | ) |
Accessor for transparentSingleValuePixelList.
Mutator for transparentSingleValuePixelList, replaces the whole list.
Definition at line 79 of file qgsrastertransparency.cpp.
References mTransparentSingleValuePixelList.
Referenced by QgsRasterLayer::readSymbology().
void QgsRasterTransparency::setTransparentThreeValuePixelList | ( | QList< QgsRasterTransparency::TransparentThreeValuePixel > | theNewList | ) |
Accessor for transparentThreeValuePixelList.
Mutator for transparentThreeValuePixelList, replaces the whole list.
Definition at line 87 of file qgsrastertransparency.cpp.
References mTransparentThreeValuePixelList.
Referenced by QgsRasterLayer::readSymbology().
QList< QgsRasterTransparency::TransparentSingleValuePixel > QgsRasterTransparency::transparentSingleValuePixelList | ( | ) | const |
Mutator for transparentSingleValuePixelList.
Accessor for transparentSingleValuePixelList.
Definition at line 30 of file qgsrastertransparency.cpp.
References mTransparentSingleValuePixelList.
Referenced by QgsRasterLayer::writeSymbology().
QList< QgsRasterTransparency::TransparentThreeValuePixel > QgsRasterTransparency::transparentThreeValuePixelList | ( | ) | const |
Mutator for transparentThreeValuePixelList.
Accessor for transparentThreeValuePixelList.
Definition at line 38 of file qgsrastertransparency.cpp.
References mTransparentThreeValuePixelList.
Referenced by QgsRasterLayer::writeSymbology().
QList<QgsRasterTransparency::TransparentSingleValuePixel> QgsRasterTransparency::mTransparentSingleValuePixelList [private] |
The lsit to hold transparency values for single value pixel layers.
Definition at line 80 of file qgsrastertransparency.h.
Referenced by alphaValue(), initializeTransparentPixelList(), setTransparentSingleValuePixelList(), and transparentSingleValuePixelList().
QList<QgsRasterTransparency::TransparentThreeValuePixel> QgsRasterTransparency::mTransparentThreeValuePixelList [private] |
The list to hold transparency values for RGB layers.
Definition at line 77 of file qgsrastertransparency.h.
Referenced by alphaValue(), initializeTransparentPixelList(), setTransparentThreeValuePixelList(), and transparentThreeValuePixelList().