QGIS API Documentation  2.99.0-Master (0a63d1f)
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
QgsRasterRenderer Class Referenceabstract

Raster renderer pipe that applies colors to a raster. More...

#include <qgsrasterrenderer.h>

Inheritance diagram for QgsRasterRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type="")
 
 QgsRasterRenderer (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
virtual ~QgsRasterRenderer ()
 
int alphaBand () const
 
virtual int bandCount () const override
 Get number of bands. More...
 
virtual QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override=0
 Read block of data using given extent and size. More...
 
QgsRasterRendererclone () const override=0
 Clone itself, create deep copy. More...
 
void copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true)
 Copies common properties like opacity / transparency data from other renderer. More...
 
virtual Qgis::DataType dataType (int bandNo) const override
 Returns data type for the band specified by number. More...
 
virtual void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 Get symbology items if provided by renderer. More...
 
const QgsRasterMinMaxOriginminMaxOrigin () const
 Returns const reference to origin of min/max values. More...
 
double opacity () const
 
const QgsRasterRendereroperator= (const QgsRasterRenderer &)=delete
 QgsRasterRenderer cannot be copied. Use clone() instead. More...
 
const QgsRasterTransparencyrasterTransparency () const
 
void readXml (const QDomElement &rendererElem) override
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
void setAlphaBand (int band)
 
virtual bool setInput (QgsRasterInterface *input) override
 Set input. More...
 
void setMinMaxOrigin (const QgsRasterMinMaxOrigin &theOrigin)
 Sets origin of min/max values. More...
 
void setOpacity (double opacity)
 
void setRasterTransparency (QgsRasterTransparency *t)
 
virtual QString type () const
 
virtual QList< int > usesBands () const
 Returns a list of band numbers used by the renderer. More...
 
bool usesTransparency () const
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual QgsRasterBandStats bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Get band statistics. More...
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the above in friendly format. More...
 
virtual void cumulativeCut (int theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Find values for cumulative pixel count cut. More...
 
int dataTypeSize (int bandNo)
 
virtual QgsRectangle extent () const
 Get the extent of the interface. More...
 
virtual QString generateBandName (int theBandNumber) const
 helper function to create zero padded band names More...
 
virtual bool hasHistogram (int theBandNo, int theBinCount, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
 Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram() More...
 
virtual bool hasStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Returns true if histogram is available (cached, already calculated). More...
 
virtual QgsRasterHistogram histogram (int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
 Get histogram. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Is on/off. More...
 
virtual void setOn (bool on)
 Set on/off. More...
 
virtual Qgis::DataType sourceDataType (int bandNo) const
 Returns source data type for the band specified by number, source data type may be shorter than dataType. More...
 
virtual const QgsRasterInterfacesourceInput () const
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesourceInput ()
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual void writeXml (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
virtual int xBlockSize () const
 Get block size. More...
 
virtual int xSize () const
 Get raster size. More...
 
virtual int yBlockSize () const
 
virtual int ySize () const
 

Static Public Attributes

static const QRgb NODATA_COLOR = qRgba( 0, 0, 0, 0 )
 

Protected Member Functions

void _writeXml (QDomDocument &doc, QDomElement &rasterRendererElem) const
 Write upper class info into rasterrenderer element (called by writeXml method of subclasses) More...
 
- Protected Member Functions inherited from QgsRasterInterface
void initHistogram (QgsRasterHistogram &theHistogram, int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
 Fill in histogram defaults if not specified. More...
 
void initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=0)
 Fill in statistics defaults if not specified. More...
 

Protected Attributes

int mAlphaBand
 Read alpha value from band. More...
 
QgsRasterMinMaxOrigin mMinMaxOrigin
 Origin of min/max values. More...
 
double mOpacity
 Global alpha value (0-1) More...
 
QgsRasterTransparencymRasterTransparency
 Raster transparency per color or value. Overwrites global alpha value. More...
 
QString mType
 
- Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
QgsRasterInterfacemInput
 
bool mOn
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 

Additional Inherited Members

- Public Types inherited from QgsRasterInterface
enum  Capability {
  NoCapabilities = 0, Size = 1 << 1, Create = 1 << 2, Remove = 1 << 3,
  BuildPyramids = 1 << 4, Identify = 1 << 5, IdentifyValue = 1 << 6, IdentifyText = 1 << 7,
  IdentifyHtml = 1 << 8, IdentifyFeature = 1 << 9
}
 If you add to this, please also add to capabilitiesString() More...
 

Detailed Description

Raster renderer pipe that applies colors to a raster.

Definition at line 35 of file qgsrasterrenderer.h.

Constructor & Destructor Documentation

◆ QgsRasterRenderer() [1/2]

QgsRasterRenderer::QgsRasterRenderer ( QgsRasterInterface input = nullptr,
const QString &  type = "" 
)

Definition at line 30 of file qgsrasterrenderer.cpp.

◆ ~QgsRasterRenderer()

QgsRasterRenderer::~QgsRasterRenderer ( )
virtual

Definition at line 37 of file qgsrasterrenderer.cpp.

◆ QgsRasterRenderer() [2/2]

QgsRasterRenderer::QgsRasterRenderer ( const QgsRasterRenderer )
delete

QgsRasterRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ _writeXml()

void QgsRasterRenderer::_writeXml ( QDomDocument &  doc,
QDomElement &  rasterRendererElem 
) const
protected

Write upper class info into rasterrenderer element (called by writeXml method of subclasses)

Definition at line 100 of file qgsrasterrenderer.cpp.

◆ alphaBand()

int QgsRasterRenderer::alphaBand ( ) const
inline

Definition at line 73 of file qgsrasterrenderer.h.

◆ bandCount()

int QgsRasterRenderer::bandCount ( ) const
overridevirtual

Get number of bands.

Implements QgsRasterInterface.

Definition at line 42 of file qgsrasterrenderer.cpp.

◆ block()

virtual QgsRasterBlock* QgsRasterRenderer::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height,
QgsRasterBlockFeedback feedback = nullptr 
)
overridepure virtual

Read block of data using given extent and size.

Returns pointer to data. Caller is responsible to free the memory returned.

Parameters
bandNoband number
extentextent of block
widthpixel width of block
heightpixel height of block
feedbackoptional raster feedback object for cancellation/preview. Added in QGIS 3.0.

Implements QgsRasterInterface.

Implemented in QgsHillshadeRenderer, QgsSingleBandGrayRenderer, QgsSingleBandPseudoColorRenderer, QgsPalettedRasterRenderer, QgsMultiBandColorRenderer, and QgsSingleBandColorDataRenderer.

◆ clone()

QgsRasterRenderer* QgsRasterRenderer::clone ( ) const
overridepure virtual

◆ copyCommonProperties()

void QgsRasterRenderer::copyCommonProperties ( const QgsRasterRenderer other,
bool  copyMinMaxOrigin = true 
)

Copies common properties like opacity / transparency data from other renderer.

Useful when cloning renderers.

Note
added in 2.16

Definition at line 147 of file qgsrasterrenderer.cpp.

◆ dataType()

Qgis::DataType QgsRasterRenderer::dataType ( int  bandNo) const
overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 51 of file qgsrasterrenderer.cpp.

◆ legendSymbologyItems()

virtual void QgsRasterRenderer::legendSymbologyItems ( QList< QPair< QString, QColor > > &  symbolItems) const
inlinevirtual

Get symbology items if provided by renderer.

Reimplemented in QgsSingleBandPseudoColorRenderer, QgsPalettedRasterRenderer, and QgsSingleBandGrayRenderer.

Definition at line 76 of file qgsrasterrenderer.h.

◆ minMaxOrigin()

const QgsRasterMinMaxOrigin& QgsRasterRenderer::minMaxOrigin ( ) const
inline

Returns const reference to origin of min/max values.

Definition at line 90 of file qgsrasterrenderer.h.

◆ opacity()

double QgsRasterRenderer::opacity ( ) const
inline

Definition at line 67 of file qgsrasterrenderer.h.

◆ operator=()

const QgsRasterRenderer& QgsRasterRenderer::operator= ( const QgsRasterRenderer )
delete

QgsRasterRenderer cannot be copied. Use clone() instead.

◆ rasterTransparency()

const QgsRasterTransparency* QgsRasterRenderer::rasterTransparency ( ) const
inline

Definition at line 70 of file qgsrasterrenderer.h.

◆ readXml()

void QgsRasterRenderer::readXml ( const QDomElement &  rendererElem)
overridevirtual

Sets base class members from xml. Usually called from create() methods of subclasses.

Reimplemented from QgsRasterInterface.

Definition at line 121 of file qgsrasterrenderer.cpp.

◆ setAlphaBand()

void QgsRasterRenderer::setAlphaBand ( int  band)
inline

Definition at line 72 of file qgsrasterrenderer.h.

◆ setInput()

bool QgsRasterRenderer::setInput ( QgsRasterInterface input)
overridevirtual

Set input.

Returns true if set correctly, false if cannot use that input

Reimplemented from QgsRasterInterface.

Reimplemented in QgsSingleBandColorDataRenderer.

Definition at line 62 of file qgsrasterrenderer.cpp.

◆ setMinMaxOrigin()

void QgsRasterRenderer::setMinMaxOrigin ( const QgsRasterMinMaxOrigin theOrigin)
inline

Sets origin of min/max values.

Definition at line 93 of file qgsrasterrenderer.h.

◆ setOpacity()

void QgsRasterRenderer::setOpacity ( double  opacity)
inline

Definition at line 66 of file qgsrasterrenderer.h.

◆ setRasterTransparency()

void QgsRasterRenderer::setRasterTransparency ( QgsRasterTransparency t)

Definition at line 94 of file qgsrasterrenderer.cpp.

◆ type()

virtual QString QgsRasterRenderer::type ( ) const
inlinevirtual

Definition at line 58 of file qgsrasterrenderer.h.

◆ usesBands()

virtual QList<int> QgsRasterRenderer::usesBands ( ) const
inlinevirtual

◆ usesTransparency()

bool QgsRasterRenderer::usesTransparency ( ) const

Definition at line 85 of file qgsrasterrenderer.cpp.

Member Data Documentation

◆ mAlphaBand

int QgsRasterRenderer::mAlphaBand
protected

Read alpha value from band.

Is combined with value from raster transparency / global alpha value. Default: -1 (not set)

Definition at line 109 of file qgsrasterrenderer.h.

◆ mMinMaxOrigin

QgsRasterMinMaxOrigin QgsRasterRenderer::mMinMaxOrigin
protected

Origin of min/max values.

Definition at line 112 of file qgsrasterrenderer.h.

◆ mOpacity

double QgsRasterRenderer::mOpacity
protected

Global alpha value (0-1)

Definition at line 103 of file qgsrasterrenderer.h.

◆ mRasterTransparency

QgsRasterTransparency* QgsRasterRenderer::mRasterTransparency
protected

Raster transparency per color or value. Overwrites global alpha value.

Definition at line 105 of file qgsrasterrenderer.h.

◆ mType

QString QgsRasterRenderer::mType
protected

Definition at line 100 of file qgsrasterrenderer.h.

◆ NODATA_COLOR

const QRgb QgsRasterRenderer::NODATA_COLOR = qRgba( 0, 0, 0, 0 )
static

Definition at line 42 of file qgsrasterrenderer.h.


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