QgsPalettedRasterRenderer Class Reference

Renderer for paletted raster images. More...

#include <qgspalettedrasterrenderer.h>

Inheritance diagram for QgsPalettedRasterRenderer:

Collaboration diagram for QgsPalettedRasterRenderer:

List of all members.

Public Member Functions
	QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, QColor *colorArray, int nColors)
	Renderer owns color array.
	QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, QRgb *colorArray, int nColors)
	~QgsPalettedRasterRenderer ()
QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height)
	Read block of data using given extent and size.
QgsRasterInterface *	clone () const
	Clone itself, create deep copy.
QColor *	colors () const
	Returns copy of color array (caller takes ownership)
void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
	Get symbology items if provided by renderer.
int	nColors () const
	Returns number of colors.
QRgb *	rgbArray () const
	Returns copy of rgb array (caller takes ownership)
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
QRgb *	mColors
	Color array.
int	mNColors
	Number of colors.

---

Detailed Description

Renderer for paletted raster images.

Definition at line 29 of file qgspalettedrasterrenderer.h.

---

Constructor & Destructor Documentation

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer	(	QgsRasterInterface *	input,
		int	bandNumber,
		QColor *	colorArray,
		int	nColors
	)

Renderer owns color array.

Definition at line 26 of file qgspalettedrasterrenderer.cpp.

References mColors, and nColors().

Referenced by clone(), and create().

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer	(	QgsRasterInterface *	input,
		int	bandNumber,
		QRgb *	colorArray,
		int	nColors
	)

Definition at line 38 of file qgspalettedrasterrenderer.cpp.

QgsPalettedRasterRenderer::~QgsPalettedRasterRenderer

(

)

Definition at line 43 of file qgspalettedrasterrenderer.cpp.

References mColors.

---

Member Function Documentation

QgsRasterBlock * QgsPalettedRasterRenderer::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 137 of file qgspalettedrasterrenderer.cpp.

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

QgsRasterInterface * QgsPalettedRasterRenderer::clone

(

)

const [virtual]

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 48 of file qgspalettedrasterrenderer.cpp.

References QgsRasterRenderer::mAlphaBand, mBand, mNColors, QgsRasterRenderer::mOpacity, QgsRasterRenderer::mRasterTransparency, QgsPalettedRasterRenderer(), rgbArray(), QgsRasterRenderer::setAlphaBand(), QgsRasterRenderer::setOpacity(), and QgsRasterRenderer::setRasterTransparency().

QColor * QgsPalettedRasterRenderer::colors

(

)

const

Returns copy of color array (caller takes ownership)

Definition at line 109 of file qgspalettedrasterrenderer.cpp.

References mColors, and mNColors.

Referenced by create(), and QgsPalettedRendererWidget::setFromRenderer().

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

Definition at line 57 of file qgspalettedrasterrenderer.cpp.

References colors(), nColors(), QgsDebugMsg, QgsPalettedRasterRenderer(), and QgsRasterRenderer::readXML().

Referenced by QgsRasterRendererRegistry::QgsRasterRendererRegistry().

void QgsPalettedRasterRenderer::legendSymbologyItems

(

QList< QPair< QString, QColor > > &

symbolItems

)

const [virtual]

Get symbology items if provided by renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 250 of file qgspalettedrasterrenderer.cpp.

References mColors, and mNColors.

int QgsPalettedRasterRenderer::nColors

(

)

const [inline]

Returns number of colors.

Definition at line 42 of file qgspalettedrasterrenderer.h.

Referenced by create(), QgsPalettedRasterRenderer(), and QgsPalettedRendererWidget::setFromRenderer().

QRgb * QgsPalettedRasterRenderer::rgbArray

(

)

const

Returns copy of rgb array (caller takes ownership)

Note:

not available in python bindings

Definition at line 123 of file qgspalettedrasterrenderer.cpp.

References mColors, and mNColors.

Referenced by clone().

QList< int > QgsPalettedRasterRenderer::usesBands

(

)

const [virtual]

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 258 of file qgspalettedrasterrenderer.cpp.

References mBand.

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 226 of file qgspalettedrasterrenderer.cpp.

References QgsRasterRenderer::_writeXML(), mBand, mColors, and mNColors.

---

Member Data Documentation

int QgsPalettedRasterRenderer::mBand [private]

Definition at line 58 of file qgspalettedrasterrenderer.h.

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

QRgb* QgsPalettedRasterRenderer::mColors [private]

Color array.

Definition at line 60 of file qgspalettedrasterrenderer.h.

Referenced by block(), colors(), legendSymbologyItems(), QgsPalettedRasterRenderer(), rgbArray(), writeXML(), and ~QgsPalettedRasterRenderer().

int QgsPalettedRasterRenderer::mNColors [private]

Number of colors.

Definition at line 62 of file qgspalettedrasterrenderer.h.

Referenced by clone(), colors(), legendSymbologyItems(), rgbArray(), and writeXML().

---

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

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