QgsSingleBandPseudoColorRenderer Class Reference

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

#include <qgssinglebandpseudocolorrenderer.h>

Inheritance diagram for QgsSingleBandPseudoColorRenderer:

Collaboration diagram for QgsSingleBandPseudoColorRenderer:

List of all members.

Public Member Functions
	QgsSingleBandPseudoColorRenderer (QgsRasterInterface *input, int band, QgsRasterShader *shader)
	Note: takes ownership of QgsRasterShader.
	~QgsSingleBandPseudoColorRenderer ()
QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height)
	Read block of data using given extent and size.
double	classificationMax () const
double	classificationMin () const
int	classificationMinMaxOrigin () const
QgsRasterInterface *	clone () const
	Clone itself, create deep copy.
void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
	Get symbology items if provided by renderer.
void	setClassificationMax (double max)
void	setClassificationMin (double min)
void	setClassificationMinMaxOrigin (int origin)
void	setShader (QgsRasterShader *shader)
	Takes ownership of the shader.
QgsRasterShader *	shader ()
const QgsRasterShader *	shader () const
QList< int >	usesBands () const
	Returns a list of band numbers used by the renderer.
void	writeXML (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml.
Static Public Member Functions
static QgsRasterRenderer *	create (const QDomElement &elem, QgsRasterInterface *input)
Private Attributes
int	mBand
double	mClassificationMax
double	mClassificationMin
int	mClassificationMinMaxOrigin
QgsRasterShader *	mShader

---

Detailed Description

Raster renderer pipe for single band pseudocolor.

Definition at line 29 of file qgssinglebandpseudocolorrenderer.h.

---

Constructor & Destructor Documentation

QgsSingleBandPseudoColorRenderer::QgsSingleBandPseudoColorRenderer	(	QgsRasterInterface *	input,
		int	band,
		QgsRasterShader *	shader
	)

Note: takes ownership of QgsRasterShader.

Definition at line 26 of file qgssinglebandpseudocolorrenderer.cpp.

Referenced by clone(), and create().

QgsSingleBandPseudoColorRenderer::~QgsSingleBandPseudoColorRenderer

(

)

Definition at line 36 of file qgssinglebandpseudocolorrenderer.cpp.

References mShader.

---

Member Function Documentation

QgsRasterBlock * QgsSingleBandPseudoColorRenderer::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height
	)		[virtual]

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

Implements QgsRasterRenderer.

Definition at line 104 of file qgssinglebandpseudocolorrenderer.cpp.

References QgsRasterTransparency::alphaValue(), QGis::ARGB32_Premultiplied, QgsRasterInterface::block(), QgsRasterBlock::isEmpty(), QgsRasterBlock::isNoData(), QgsRasterRenderer::mAlphaBand, mBand, QgsRasterInterface::mInput, QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, mShader, QgsRasterRenderer::NODATA_COLOR, QgsDebugMsg, QgsRasterBlock::reset(), QgsRasterBlock::setColor(), QgsRasterShader::shade(), QgsRasterRenderer::usesTransparency(), and QgsRasterBlock::value().

double QgsSingleBandPseudoColorRenderer::classificationMax

(

)

const [inline]

Definition at line 53 of file qgssinglebandpseudocolorrenderer.h.

Referenced by QgsSingleBandPseudoColorRendererWidget::setFromRenderer().

double QgsSingleBandPseudoColorRenderer::classificationMin

(

)

const [inline]

Definition at line 52 of file qgssinglebandpseudocolorrenderer.h.

Referenced by QgsSingleBandPseudoColorRendererWidget::setFromRenderer().

int QgsSingleBandPseudoColorRenderer::classificationMinMaxOrigin

(

)

const [inline]

Definition at line 56 of file qgssinglebandpseudocolorrenderer.h.

Referenced by QgsSingleBandPseudoColorRendererWidget::setFromRenderer().

QgsRasterInterface * QgsSingleBandPseudoColorRenderer::clone

(

)

const [virtual]

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 41 of file qgssinglebandpseudocolorrenderer.cpp.

References QgsRasterRenderer::mAlphaBand, QgsRasterShader::maximumValue(), mBand, QgsRasterShader::minimumValue(), QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, mShader, QgsSingleBandPseudoColorRenderer(), QgsRasterShader::rasterShaderFunction(), QgsRasterRenderer::setAlphaBand(), QgsColorRampShader::setColorRampItemList(), QgsColorRampShader::setColorRampType(), QgsRasterRenderer::setOpacity(), QgsRasterShader::setRasterShaderFunction(), QgsRasterRenderer::setRasterTransparency(), and shader().

QgsRasterRenderer * QgsSingleBandPseudoColorRenderer::create	(	const QDomElement &	elem,
		QgsRasterInterface *	input
	)		[static]

Definition at line 77 of file qgssinglebandpseudocolorrenderer.cpp.

References QgsRasterRenderer::minMaxOriginFromName(), QgsSingleBandPseudoColorRenderer(), QgsRasterShader::readXML(), QgsRasterRenderer::readXML(), setClassificationMax(), setClassificationMin(), setClassificationMinMaxOrigin(), and shader().

Referenced by QgsRasterRendererRegistry::QgsRasterRendererRegistry().

void QgsSingleBandPseudoColorRenderer::legendSymbologyItems

(

QList< QPair< QString, QColor > > &

symbolItems

)

const [virtual]

Get symbology items if provided by renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 225 of file qgssinglebandpseudocolorrenderer.cpp.

References QgsRasterShaderFunction::legendSymbologyItems(), mShader, and QgsRasterShader::rasterShaderFunction().

void QgsSingleBandPseudoColorRenderer::setClassificationMax

(

double

max

)

[inline]

Definition at line 55 of file qgssinglebandpseudocolorrenderer.h.

References MathUtils::max().

Referenced by create(), and QgsSingleBandPseudoColorRendererWidget::renderer().

void QgsSingleBandPseudoColorRenderer::setClassificationMin

(

double

min

)

[inline]

Definition at line 54 of file qgssinglebandpseudocolorrenderer.h.

References MathUtils::min().

Referenced by create(), and QgsSingleBandPseudoColorRendererWidget::renderer().

void QgsSingleBandPseudoColorRenderer::setClassificationMinMaxOrigin

(

int

origin

)

[inline]

Definition at line 57 of file qgssinglebandpseudocolorrenderer.h.

Referenced by create(), and QgsSingleBandPseudoColorRendererWidget::renderer().

void QgsSingleBandPseudoColorRenderer::setShader

(

QgsRasterShader *

shader

)

Takes ownership of the shader.

Definition at line 71 of file qgssinglebandpseudocolorrenderer.cpp.

References mShader, and shader().

Referenced by QgsRasterLayer::setDataProvider().

QgsRasterShader* QgsSingleBandPseudoColorRenderer::shader

(

)

[inline]

Definition at line 43 of file qgssinglebandpseudocolorrenderer.h.

Referenced by clone(), create(), QgsSingleBandPseudoColorRendererWidget::setFromRenderer(), and setShader().

const QgsRasterShader* QgsSingleBandPseudoColorRenderer::shader

(

)

const [inline]

Definition at line 44 of file qgssinglebandpseudocolorrenderer.h.

QList< int > QgsSingleBandPseudoColorRenderer::usesBands

(

)

const [virtual]

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 237 of file qgssinglebandpseudocolorrenderer.cpp.

References mBand.

void QgsSingleBandPseudoColorRenderer::writeXML	(	QDomDocument &	doc,
		QDomElement &	parentElem
	)		const [virtual]

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 204 of file qgssinglebandpseudocolorrenderer.cpp.

References QgsRasterRenderer::_writeXML(), mBand, mClassificationMax, mClassificationMin, mClassificationMinMaxOrigin, QgsRasterRenderer::minMaxOriginName(), mShader, and QgsRasterShader::writeXML().

---

Member Data Documentation

int QgsSingleBandPseudoColorRenderer::mBand [private]

Definition at line 61 of file qgssinglebandpseudocolorrenderer.h.

Referenced by block(), clone(), usesBands(), and writeXML().

double QgsSingleBandPseudoColorRenderer::mClassificationMax [private]

Definition at line 66 of file qgssinglebandpseudocolorrenderer.h.

Referenced by writeXML().

double QgsSingleBandPseudoColorRenderer::mClassificationMin [private]

Definition at line 65 of file qgssinglebandpseudocolorrenderer.h.

Referenced by writeXML().

int QgsSingleBandPseudoColorRenderer::mClassificationMinMaxOrigin [private]

Definition at line 68 of file qgssinglebandpseudocolorrenderer.h.

Referenced by writeXML().

QgsRasterShader* QgsSingleBandPseudoColorRenderer::mShader [private]

Definition at line 60 of file qgssinglebandpseudocolorrenderer.h.

Referenced by block(), clone(), legendSymbologyItems(), setShader(), writeXML(), and ~QgsSingleBandPseudoColorRenderer().

---

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

• src/core/raster/qgssinglebandpseudocolorrenderer.h
• src/core/raster/qgssinglebandpseudocolorrenderer.cpp