QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Public Attributes | List of all members
QgsRasterTransparency::TransparentSingleValuePixel Struct Reference

Defines the transparency for a range of single-band pixel values. More...

#include <qgsrastertransparency.h>

Public Member Functions

 TransparentSingleValuePixel (double minimum=0, double maximum=0, double opacity=0, bool includeMinimum=true, bool includeMaximum=true)
 Constructor for TransparentSingleValuePixel. More...
 
bool operator!= (const QgsRasterTransparency::TransparentSingleValuePixel &other) const
 
bool operator== (const QgsRasterTransparency::TransparentSingleValuePixel &other) const
 

Public Attributes

bool includeMaximum = true
 true if pixels matching the max value should be considered transparent, or false if only pixels less than the max value should be transparent. More...
 
bool includeMinimum = true
 true if pixels matching the min value should be considered transparent, or false if only pixels greater than the min value should be transparent. More...
 
double max
 Maximum pixel value to include in range. More...
 
double min
 Minimum pixel value to include in range. More...
 
double opacity = 0
 Opacity for pixel, between 0 and 1.0. More...
 

Detailed Description

Defines the transparency for a range of single-band pixel values.

Definition at line 112 of file qgsrastertransparency.h.

Constructor & Destructor Documentation

◆ TransparentSingleValuePixel()

QgsRasterTransparency::TransparentSingleValuePixel::TransparentSingleValuePixel ( double  minimum = 0,
double  maximum = 0,
double  opacity = 0,
bool  includeMinimum = true,
bool  includeMaximum = true 
)
inline

Constructor for TransparentSingleValuePixel.

Parameters
minimumminimum pixel value to include in range
maximummaximum pixel value to include in range
opacityopacity for pixel, between 0 and 1.0
includeMinimumwhether the minimum value should be included in the range
includeMaximumwhether the maximum value should be included in the range
Since
QGIS 3.38

Definition at line 125 of file qgsrastertransparency.h.

Member Function Documentation

◆ operator!=()

bool QgsRasterTransparency::TransparentSingleValuePixel::operator!= ( const QgsRasterTransparency::TransparentSingleValuePixel other) const
inline

Definition at line 173 of file qgsrastertransparency.h.

◆ operator==()

bool QgsRasterTransparency::TransparentSingleValuePixel::operator== ( const QgsRasterTransparency::TransparentSingleValuePixel other) const
inline

Definition at line 166 of file qgsrastertransparency.h.

Member Data Documentation

◆ includeMaximum

bool QgsRasterTransparency::TransparentSingleValuePixel::includeMaximum = true

true if pixels matching the max value should be considered transparent, or false if only pixels less than the max value should be transparent.

Since
QGIS 3.38

Definition at line 164 of file qgsrastertransparency.h.

◆ includeMinimum

bool QgsRasterTransparency::TransparentSingleValuePixel::includeMinimum = true

true if pixels matching the min value should be considered transparent, or false if only pixels greater than the min value should be transparent.

Since
QGIS 3.38

Definition at line 156 of file qgsrastertransparency.h.

◆ max

double QgsRasterTransparency::TransparentSingleValuePixel::max

Maximum pixel value to include in range.

Definition at line 141 of file qgsrastertransparency.h.

◆ min

double QgsRasterTransparency::TransparentSingleValuePixel::min

Minimum pixel value to include in range.

Definition at line 136 of file qgsrastertransparency.h.

◆ opacity

double QgsRasterTransparency::TransparentSingleValuePixel::opacity = 0

Opacity for pixel, between 0 and 1.0.

Since
QGIS 3.38

Definition at line 148 of file qgsrastertransparency.h.


The documentation for this struct was generated from the following file: