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

#include <qgsrasterrenderer.h>

Inheritance diagram for QgsRasterRenderer:

Collaboration diagram for QgsRasterRenderer:

Public Types
enum	MinMaxOrigin { MinMaxUnknown = 0, MinMaxUser = 1, MinMaxMinMax = 1 << 1, MinMaxCumulativeCut = 1 << 2, MinMaxStdDev = 1 << 3, MinMaxFullExtent = 1 << 4, MinMaxSubExtent = 1 << 5, MinMaxEstimated = 1 << 6, MinMaxExact = 1 << 7 }
Public Member Functions
	QgsRasterRenderer (QgsRasterInterface *input=0, const QString &type="")
virtual	~QgsRasterRenderer ()
int	alphaBand () const
virtual int	bandCount () const
	Get number of bands.
virtual QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height)=0
	Read block of data using given extent and size.
QgsRasterInterface *	clone () const =0
	Clone itself, create deep copy.
virtual QGis::DataType	dataType (int bandNo) const
	Returns data type for the band specified by number.
virtual void	legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
	Get symbology items if provided by renderer.
double	opacity () const
const QgsRasterTransparency *	rasterTransparency () const
void	readXML (const QDomElement &rendererElem)
	Sets base class members from xml.
void	setAlphaBand (int band)
virtual bool	setInput (QgsRasterInterface *input)
	Set input.
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.
bool	usesTransparency () const
Static Public Member Functions
static int	minMaxOriginFromName (QString theName)
static QString	minMaxOriginLabel (int theOrigin)
static QString	minMaxOriginName (int theOrigin)
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)
Protected Attributes
int	mAlphaBand
	Read alpha value from band.
double	mOpacity
	Global alpha value (0-1)
QgsRasterTransparency *	mRasterTransparency
	Raster transparency per color or value.
QString	mType

Detailed Description

Raster renderer pipe that applies colors to a raster.

Definition at line 34 of file qgsrasterrenderer.h.

Member Enumeration Documentation

enum QgsRasterRenderer::MinMaxOrigin

Enumerator:

MinMaxUnknown
MinMaxUser
MinMaxMinMax
MinMaxCumulativeCut
MinMaxStdDev
MinMaxFullExtent
MinMaxSubExtent
MinMaxEstimated
MinMaxExact

Definition at line 38 of file qgsrasterrenderer.h.

Constructor & Destructor Documentation

QgsRasterRenderer::QgsRasterRenderer	(	QgsRasterInterface *	input = `0`,
		const QString &	type = `""`
	)

Definition at line 32 of file qgsrasterrenderer.cpp.

QgsRasterRenderer::~QgsRasterRenderer ( ) [virtual]

Definition at line 39 of file qgsrasterrenderer.cpp.

Member Function Documentation

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 101 of file qgsrasterrenderer.cpp.

References mAlphaBand, mOpacity, mRasterTransparency, mType, and QgsRasterTransparency::writeXML().

Referenced by QgsSingleBandColorDataRenderer::writeXML(), QgsSingleBandPseudoColorRenderer::writeXML(), QgsPalettedRasterRenderer::writeXML(), QgsSingleBandGrayRenderer::writeXML(), and QgsMultiBandColorRenderer::writeXML().

int QgsRasterRenderer::alphaBand ( ) const [inline]

Definition at line 80 of file qgsrasterrenderer.h.

int QgsRasterRenderer::bandCount ( ) const [virtual]

Get number of bands.

Implements QgsRasterInterface.

Definition at line 43 of file qgsrasterrenderer.cpp.

References QgsRasterInterface::bandCount(), QgsRasterInterface::mInput, and QgsRasterInterface::mOn.

virtual QgsRasterBlock* QgsRasterRenderer::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height
	)		`[pure 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 QgsRasterInterface.

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

QgsRasterInterface* QgsRasterRenderer::clone ( ) const [pure virtual]

Clone itself, create deep copy.

Implements QgsRasterInterface.

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

QGis::DataType QgsRasterRenderer::dataType ( int bandNo ) const [virtual]

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 52 of file qgsrasterrenderer.cpp.

References QGis::ARGB32_Premultiplied, QgsRasterInterface::dataType(), QgsRasterInterface::mInput, QgsRasterInterface::mOn, QgsDebugMsg, and QGis::UnknownDataType.

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

Get symbology items if provided by renderer.

Reimplemented in QgsSingleBandGrayRenderer, QgsPalettedRasterRenderer, and QgsSingleBandPseudoColorRenderer.

Definition at line 83 of file qgsrasterrenderer.h.

Referenced by QgsRasterLayer::legendSymbologyItems().

int QgsRasterRenderer::minMaxOriginFromName ( QString theName ) [static]

Definition at line 235 of file qgsrasterrenderer.cpp.

References MinMaxCumulativeCut, MinMaxEstimated, MinMaxExact, MinMaxFullExtent, MinMaxMinMax, MinMaxStdDev, MinMaxSubExtent, MinMaxUnknown, and MinMaxUser.

Referenced by QgsSingleBandPseudoColorRenderer::create().

QString QgsRasterRenderer::minMaxOriginLabel ( int theOrigin ) [static]

Definition at line 183 of file qgsrasterrenderer.cpp.

References MinMaxCumulativeCut, MinMaxEstimated, MinMaxExact, MinMaxFullExtent, MinMaxMinMax, MinMaxStdDev, MinMaxSubExtent, MinMaxUnknown, MinMaxUser, and tr.

Referenced by QgsSingleBandPseudoColorRendererWidget::showMinMaxOrigin().

QString QgsRasterRenderer::minMaxOriginName ( int theOrigin ) [static]

Definition at line 138 of file qgsrasterrenderer.cpp.

References MinMaxCumulativeCut, MinMaxEstimated, MinMaxExact, MinMaxFullExtent, MinMaxMinMax, MinMaxStdDev, MinMaxSubExtent, MinMaxUnknown, and MinMaxUser.

Referenced by QgsSingleBandPseudoColorRenderer::writeXML().

double QgsRasterRenderer::opacity ( ) const [inline]

Definition at line 74 of file qgsrasterrenderer.h.

const QgsRasterTransparency* QgsRasterRenderer::rasterTransparency ( ) const [inline]

Definition at line 77 of file qgsrasterrenderer.h.

Referenced by QgsRasterLayerSaveAsDialog::on_mLoadTransparentNoDataToolButton_clicked().

void QgsRasterRenderer::readXML ( const QDomElement & rendererElem ) [virtual]

Sets base class members from xml.

Usually called from create() methods of subclasses

Reimplemented from QgsRasterInterface.

Definition at line 118 of file qgsrasterrenderer.cpp.

References mAlphaBand, mOpacity, mRasterTransparency, mType, and QgsRasterTransparency::readXML().

Referenced by QgsSingleBandColorDataRenderer::create(), QgsSingleBandPseudoColorRenderer::create(), QgsPalettedRasterRenderer::create(), QgsMultiBandColorRenderer::create(), and QgsSingleBandGrayRenderer::create().

void QgsRasterRenderer::setAlphaBand ( int band ) [inline]

Definition at line 79 of file qgsrasterrenderer.h.

Referenced by QgsSingleBandColorDataRenderer::clone(), QgsSingleBandPseudoColorRenderer::clone(), QgsMultiBandColorRenderer::clone(), QgsPalettedRasterRenderer::clone(), QgsSingleBandGrayRenderer::clone(), and QgsRasterLayer::setDataProvider().

bool QgsRasterRenderer::setInput ( QgsRasterInterface * input ) [virtual]

Set input.

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

Reimplemented from QgsRasterInterface.

Reimplemented in QgsSingleBandColorDataRenderer.

Definition at line 63 of file qgsrasterrenderer.cpp.

References QgsRasterInterface::bandCount(), QgsRasterInterface::dataType(), QgsRasterInterface::input(), QgsRasterInterface::mInput, QgsRasterInterface::mOn, and QgsRasterBlock::typeIsNumeric().

void QgsRasterRenderer::setOpacity ( double opacity ) [inline]

Definition at line 73 of file qgsrasterrenderer.h.

Referenced by QgsSingleBandColorDataRenderer::clone(), QgsSingleBandPseudoColorRenderer::clone(), QgsPalettedRasterRenderer::clone(), QgsMultiBandColorRenderer::clone(), and QgsSingleBandGrayRenderer::clone().

void QgsRasterRenderer::setRasterTransparency ( QgsRasterTransparency * t )

Definition at line 95 of file qgsrasterrenderer.cpp.

References mRasterTransparency.

Referenced by QgsSingleBandColorDataRenderer::clone(), QgsSingleBandPseudoColorRenderer::clone(), QgsMultiBandColorRenderer::clone(), QgsPalettedRasterRenderer::clone(), QgsSingleBandGrayRenderer::clone(), and QgsRasterRendererRegistry::defaultRendererForDrawingStyle().

virtual QString QgsRasterRenderer::type ( ) const [inline, virtual]

Definition at line 65 of file qgsrasterrenderer.h.

Referenced by QgsRasterLayer::setContrastEnhancement().

virtual QList<int> QgsRasterRenderer::usesBands ( ) const [inline, virtual]

Returns a list of band numbers used by the renderer.

Reimplemented in QgsMultiBandColorRenderer, QgsSingleBandGrayRenderer, QgsPalettedRasterRenderer, QgsSingleBandPseudoColorRenderer, and QgsSingleBandColorDataRenderer.

Definition at line 89 of file qgsrasterrenderer.h.

Referenced by QgsRasterRendererRegistry::defaultRendererForDrawingStyle().

bool QgsRasterRenderer::usesTransparency ( ) const

Definition at line 86 of file qgsrasterrenderer.cpp.

References QgsRasterTransparency::isEmpty(), mAlphaBand, QgsRasterInterface::mInput, mOpacity, mRasterTransparency, and qgsDoubleNear().

Referenced by QgsPalettedRasterRenderer::block(), QgsSingleBandPseudoColorRenderer::block(), QgsSingleBandColorDataRenderer::block(), and QgsMultiBandColorRenderer::block().

Member Data Documentation

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 108 of file qgsrasterrenderer.h.

Referenced by _writeXML(), QgsPalettedRasterRenderer::block(), QgsSingleBandPseudoColorRenderer::block(), QgsMultiBandColorRenderer::block(), QgsSingleBandGrayRenderer::block(), QgsSingleBandColorDataRenderer::clone(), QgsSingleBandPseudoColorRenderer::clone(), QgsMultiBandColorRenderer::clone(), QgsPalettedRasterRenderer::clone(), QgsSingleBandGrayRenderer::clone(), readXML(), and usesTransparency().

double QgsRasterRenderer::mOpacity [protected]

Global alpha value (0-1)

Definition at line 103 of file qgsrasterrenderer.h.

Referenced by _writeXML(), QgsSingleBandColorDataRenderer::block(), QgsPalettedRasterRenderer::block(), QgsSingleBandPseudoColorRenderer::block(), QgsMultiBandColorRenderer::block(), QgsSingleBandGrayRenderer::block(), QgsSingleBandColorDataRenderer::clone(), QgsSingleBandPseudoColorRenderer::clone(), QgsMultiBandColorRenderer::clone(), QgsPalettedRasterRenderer::clone(), QgsSingleBandGrayRenderer::clone(), readXML(), and usesTransparency().

QgsRasterTransparency* QgsRasterRenderer::mRasterTransparency [protected]

Raster transparency per color or value.

Overwrites global alpha value

Definition at line 105 of file qgsrasterrenderer.h.

Referenced by _writeXML(), QgsPalettedRasterRenderer::block(), QgsSingleBandPseudoColorRenderer::block(), QgsMultiBandColorRenderer::block(), QgsSingleBandGrayRenderer::block(), QgsSingleBandColorDataRenderer::clone(), QgsSingleBandPseudoColorRenderer::clone(), QgsMultiBandColorRenderer::clone(), QgsPalettedRasterRenderer::clone(), QgsSingleBandGrayRenderer::clone(), readXML(), setRasterTransparency(), and usesTransparency().

QString QgsRasterRenderer::mType [protected]

Definition at line 100 of file qgsrasterrenderer.h.

Referenced by _writeXML(), and readXML().

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

Definition at line 54 of file qgsrasterrenderer.h.

Referenced by QgsPalettedRasterRenderer::block(), QgsSingleBandPseudoColorRenderer::block(), QgsMultiBandColorRenderer::block(), and QgsSingleBandGrayRenderer::block().

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

src/core/raster/qgsrasterrenderer.h
src/core/raster/qgsrasterrenderer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation