QGIS API Documentation  2.99.0-Master (19b062c)
Public Member Functions | Static Public Member Functions | List of all members
QgsSingleBandColorDataRenderer Class Reference

Raster renderer pipe for single band color. More...

#include <qgssinglebandcolordatarenderer.h>

Inheritance diagram for QgsSingleBandColorDataRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsSingleBandColorDataRenderer (QgsRasterInterface *input, int band)
 
 QgsSingleBandColorDataRenderer (const QgsSingleBandColorDataRenderer &)=delete
 QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
QgsSingleBandColorDataRendererclone () const override
 Clone itself, create deep copy. More...
 
const QgsSingleBandColorDataRendereroperator= (const QgsSingleBandColorDataRenderer &)=delete
 QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead. More...
 
bool setInput (QgsRasterInterface *input) override
 Set input. More...
 
QList< int > usesBands () const override
 Returns a list of band numbers used by the renderer. More...
 
void writeXml (QDomDocument &doc, QDomElement &parentElem) const override
 Write base class members to xml. More...
 
- Public Member Functions inherited from QgsRasterRenderer
 QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString())
 Constructor for QgsRasterRenderer. More...
 
 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...
 
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
 Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
 
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)
 
void setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin)
 Sets origin of min/max values. More...
 
void setOpacity (double opacity)
 Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque). More...
 
void setRasterTransparency (QgsRasterTransparency *t)
 
virtual QString type () const
 
bool usesTransparency () const
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=nullptr)
 
virtual ~QgsRasterInterface ()=default
 
virtual QgsRasterBandStats bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 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 bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent=QgsRectangle(), int sampleSize=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 bandNumber) const
 helper function to create zero padded band names More...
 
virtual bool hasHistogram (int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
 Returns true if histogram is available (cached, already calculated) More...
 
virtual bool hasStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
 Returns true if histogram is available (cached, already calculated). More...
 
virtual QgsRasterHistogram histogram (int bandNo, int binCount=0, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false, QgsRasterBlockFeedback *feedback=nullptr)
 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 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 Member Functions

static QgsRasterRenderercreate (const QDomElement &elem, QgsRasterInterface *input)
 

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...
 
- Static Public Attributes inherited from QgsRasterRenderer
static const QRgb NODATA_COLOR = qRgba( 0, 0, 0, 0 )
 
- Protected Member Functions inherited from QgsRasterRenderer
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 &histogram, int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &boundingBox=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
 Fill in histogram defaults if not specified. More...
 
void initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0)
 Fill in statistics defaults if not specified. More...
 
- Protected Attributes inherited from QgsRasterRenderer
int mAlphaBand = -1
 Read alpha value from band. More...
 
QgsRasterMinMaxOrigin mMinMaxOrigin
 Origin of min/max values. More...
 
double mOpacity = 1.0
 Global alpha value (0-1) More...
 
QgsRasterTransparencymRasterTransparency = nullptr
 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 = nullptr
 
bool mOn = true
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 

Detailed Description

Raster renderer pipe for single band color.

Definition at line 31 of file qgssinglebandcolordatarenderer.h.

Constructor & Destructor Documentation

◆ QgsSingleBandColorDataRenderer() [1/2]

QgsSingleBandColorDataRenderer::QgsSingleBandColorDataRenderer ( QgsRasterInterface input,
int  band 
)

Definition at line 26 of file qgssinglebandcolordatarenderer.cpp.

◆ QgsSingleBandColorDataRenderer() [2/2]

QgsSingleBandColorDataRenderer::QgsSingleBandColorDataRenderer ( const QgsSingleBandColorDataRenderer )
delete

QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ block()

QgsRasterBlock * QgsSingleBandColorDataRenderer::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height,
QgsRasterBlockFeedback feedback = nullptr 
)
overridevirtual

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 cancelation/preview. Added in QGIS 3.0.

Implements QgsRasterRenderer.

Definition at line 52 of file qgssinglebandcolordatarenderer.cpp.

◆ clone()

QgsSingleBandColorDataRenderer * QgsSingleBandColorDataRenderer::clone ( ) const
overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 32 of file qgssinglebandcolordatarenderer.cpp.

◆ create()

QgsRasterRenderer * QgsSingleBandColorDataRenderer::create ( const QDomElement &  elem,
QgsRasterInterface input 
)
static

Definition at line 39 of file qgssinglebandcolordatarenderer.cpp.

◆ operator=()

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

QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead.

◆ setInput()

bool QgsSingleBandColorDataRenderer::setInput ( QgsRasterInterface input)
overridevirtual

Set input.

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

Reimplemented from QgsRasterRenderer.

Definition at line 117 of file qgssinglebandcolordatarenderer.cpp.

◆ usesBands()

QList< int > QgsSingleBandColorDataRenderer::usesBands ( ) const
overridevirtual

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 107 of file qgssinglebandcolordatarenderer.cpp.

◆ writeXml()

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 96 of file qgssinglebandcolordatarenderer.cpp.


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