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

#include <qgssinglebandcolordatarenderer.h>

Inheritance diagram for QgsSingleBandColorDataRenderer:

Public Member Functions
	QgsSingleBandColorDataRenderer (const QgsSingleBandColorDataRenderer &)=delete
	QgsSingleBandColorDataRenderer cannot be copied. Use clone() instead. More...

	QgsSingleBandColorDataRenderer (QgsRasterInterface *input, int band)

QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
	Read block of data using given extent and size. More...

QgsSingleBandColorDataRenderer *	clone () const override
	Clone itself, create deep copy. More...

Qgis::RasterRendererFlags	flags () const override
	Returns flags which dictate renderer behavior. More...

const QgsSingleBandColorDataRenderer &	operator= (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 (const QgsRasterRenderer &)=delete
	QgsRasterRenderer cannot be copied. Use clone() instead. More...

	QgsRasterRenderer (QgsRasterInterface *input=nullptr, const QString &type=QString())
	Constructor for QgsRasterRenderer. More...

	~QgsRasterRenderer () override

virtual bool	accept (QgsStyleEntityVisitorInterface *visitor) const
	Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More...

int	alphaBand () const

int	bandCount () const override
	Gets number of bands. More...

QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override=0
	Read block of data using given extent and size. More...

virtual bool	canCreateRasterAttributeTable () const
	Returns `true` if the renderer is suitable for attribute table creation. More...

QgsRasterRenderer *	clone () 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 QList< QgsLayerTreeModelLegendNode * >	createLegendNodes (QgsLayerTreeLayer *nodeLayer)
	Creates a set of legend nodes representing the renderer. More...

Qgis::DataType	dataType (int bandNo) const override
	Returns data type for the band specified by number. More...

virtual Qgis::RasterRendererFlags	flags () const
	Returns flags which dictate renderer behavior. More...

virtual QList< QPair< QString, QColor > >	legendSymbologyItems () const
	Returns symbology items if provided by renderer. More...

const QgsRasterMinMaxOrigin &	minMaxOrigin () const
	Returns const reference to origin of min/max values. More...

QColor	nodataColor () const
	Returns the color to use for shading nodata pixels. 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 QgsRasterRenderer &	operator= (const QgsRasterRenderer &)=delete
	QgsRasterRenderer cannot be copied. Use clone() instead. More...

const QgsRasterTransparency *	rasterTransparency () 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)

bool	setInput (QgsRasterInterface *input) override
	Set input. More...

void	setMinMaxOrigin (const QgsRasterMinMaxOrigin &origin)
	Sets origin of min/max values. More...

void	setNodataColor (const QColor &color)
	Sets the color to use for shading nodata pixels. 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 void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
	Used from subclasses to create SLD Rule elements following SLD v1.0 specs. More...

virtual QString	type () const
	Returns a unique string representation of the renderer type. More...

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 int	bandCount () const =0
	Gets number of bands. More...

virtual QgsRasterBandStats	bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics. More...

virtual QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)=0
	Read block of data using given extent and size. More...

virtual int	capabilities () const
	Returns a bitmask containing the supported capabilities. More...

QString	capabilitiesString () const
	Returns the raster interface capabilities in friendly format. More...

virtual QgsRasterInterface *	clone () const =0
	Clone itself, create deep copy. More...

virtual QString	colorInterpretationName (int bandNumber) const
	Returns the name of the color interpretation for the specified bandNumber. 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...

virtual Qgis::DataType	dataType (int bandNo) const =0
	Returns data type for the band specified by number. More...

int	dataTypeSize (int bandNo) const
	Returns the size (in bytes) for the data type for the specified band. More...

QString	displayBandName (int bandNumber) const
	Generates a friendly, descriptive name for the specified bandNumber. More...

virtual QgsRectangle	extent () const
	Gets 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)
	Returns a band histogram. More...

virtual QgsRasterInterface *	input () const
	Current input. More...

virtual bool	on () const
	Returns whether the interface is on or off. More...

virtual void	readXml (const QDomElement &filterElem)
	Sets base class members from xml. Usually called from create() methods of subclasses. More...

virtual bool	setInput (QgsRasterInterface *input)
	Set input. More...

virtual void	setOn (bool on)
	Sets whether the interface is on or 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 QgsRasterInterface *	sourceInput ()
	Gets source / raw input, the first in pipe, usually provider. More...

virtual const QgsRasterInterface *	sourceInput () const
	Gets 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
	Gets block size. More...

virtual int	xSize () const
	Gets raster size. More...

virtual int	yBlockSize () const

virtual int	ySize () const

Static Public Member Functions
static QgsRasterRenderer *	create (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 , Prefetch = 1 << 10 }
	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...

QRgb	renderColorForNodataPixel () const
	Returns the color for the renderer to use to represent nodata pixels. 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) const
	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...

QgsRasterTransparency *	mRasterTransparency = nullptr
	Raster transparency per color or value. Overwrites global alpha value. More...

QString	mType

Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogram >	mHistograms
	List of cached histograms, all bands mixed. More...

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

QList< QgsRasterBandStats >	mStatistics
	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

bandNo	band number
extent	extent of block
width	pixel width of block
height	pixel height of block
feedback	optional raster feedback object for cancellation/preview. Added in QGIS 3.0.