QGIS API Documentation  3.0.2-Girona (307d082)
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 ()=default
 Constructor for QgsRasterTransparency. More...
 
int alphaValue (double, int globalTransparency=255) const
 Returns the transparency value for a single value Pixel. More...
 
int alphaValue (double, double, double, int globalTransparency=255) const
 Return the transparency value for a RGB Pixel. 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...
 
bool isEmpty () const
 True if there are no entries in the pixel lists except the nodata value. More...
 
void readXml (const QDomElement &elem)
 Reads the transparency information from an XML document. More...
 
void setTransparentSingleValuePixelList (const QList< QgsRasterTransparency::TransparentSingleValuePixel > &newList)
 Mutator for transparentSingleValuePixelList. More...
 
void setTransparentThreeValuePixelList (const QList< QgsRasterTransparency::TransparentThreeValuePixel > &newList)
 Mutator for transparentThreeValuePixelList. More...
 
QList< QgsRasterTransparency::TransparentSingleValuePixeltransparentSingleValuePixelList () const
 Accessor for transparentSingleValuePixelList. More...
 
QList< QgsRasterTransparency::TransparentThreeValuePixeltransparentThreeValuePixelList () const
 Accessor for transparentThreeValuePixelList. More...
 
void writeXml (QDomDocument &doc, QDomElement &parentElem) const
 Writes the transparency information to an XML document. More...
 

Detailed Description

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

Definition at line 32 of file qgsrastertransparency.h.

Constructor & Destructor Documentation

◆ QgsRasterTransparency()

QgsRasterTransparency::QgsRasterTransparency ( )
default

Constructor for QgsRasterTransparency.

Member Function Documentation

◆ alphaValue() [1/2]

int QgsRasterTransparency::alphaValue ( double  value,
int  globalTransparency = 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
valuethe needle to search for in the transparency hay stack
globalTransparencythe overal transparency level for the layer

Definition at line 99 of file qgsrastertransparency.cpp.

◆ alphaValue() [2/2]

int QgsRasterTransparency::alphaValue ( double  redValue,
double  greenValue,
double  blueValue,
int  globalTransparency = 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
redValuethe red portion of the needle to search for in the transparency hay stack
greenValuethe green portion of the needle to search for in the transparency hay stack
blueValuethe green portion of the needle to search for in the transparency hay stack
globalTransparencythe overal transparency level for the layer

Definition at line 139 of file qgsrastertransparency.cpp.

◆ initializeTransparentPixelList() [1/2]

void QgsRasterTransparency::initializeTransparentPixelList ( double  value)

Reset to the transparency list to a single value.

Definition at line 46 of file qgsrastertransparency.cpp.

◆ initializeTransparentPixelList() [2/2]

void QgsRasterTransparency::initializeTransparentPixelList ( double  redValue,
double  greenValue,
double  blueValue 
)

Reset to the transparency list to a single value.

Definition at line 62 of file qgsrastertransparency.cpp.

◆ isEmpty()

bool QgsRasterTransparency::isEmpty ( ) const

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

Definition at line 175 of file qgsrastertransparency.cpp.

◆ readXml()

void QgsRasterTransparency::readXml ( const QDomElement &  elem)

Reads the transparency information from an XML document.

Definition at line 216 of file qgsrastertransparency.cpp.

◆ setTransparentSingleValuePixelList()

void QgsRasterTransparency::setTransparentSingleValuePixelList ( const QList< QgsRasterTransparency::TransparentSingleValuePixel > &  newList)

Mutator for transparentSingleValuePixelList.

Mutator for transparentSingleValuePixelList, replaces the whole list.

Definition at line 80 of file qgsrastertransparency.cpp.

◆ setTransparentThreeValuePixelList()

void QgsRasterTransparency::setTransparentThreeValuePixelList ( const QList< QgsRasterTransparency::TransparentThreeValuePixel > &  newList)

Mutator for transparentThreeValuePixelList.

Mutator for transparentThreeValuePixelList, replaces the whole list.

Definition at line 88 of file qgsrastertransparency.cpp.

◆ transparentSingleValuePixelList()

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

Accessor for transparentSingleValuePixelList.

Definition at line 30 of file qgsrastertransparency.cpp.

◆ transparentThreeValuePixelList()

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

Accessor for transparentThreeValuePixelList.

Definition at line 38 of file qgsrastertransparency.cpp.

◆ writeXml()

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

Writes the transparency information to an XML document.

Definition at line 180 of file qgsrastertransparency.cpp.


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