A renderer for generating live hillshade models. More...

#include <qgshillshaderenderer.h>

Inheritance diagram for QgsHillshadeRenderer:

[legend]

Public Member Functions
	QgsHillshadeRenderer (QgsRasterInterface *input, int band, double lightAzimuth, double lightAltitude)
	A renderer for generating live hillshade models.

double	altitude () const
	Returns the angle of the light source over the raster.

double	azimuth () const
	Returns the direction of the light over the raster between 0-360.

Q_DECL_DEPRECATED int	band () const
	Returns the band used by the renderer.

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

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

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

int	inputBand () const override
	Returns the input band for the renderer, or -1 if no input band is available.

bool	multiDirectional () const
	Returns `true` if the renderer is using multi-directional hillshading.

void	setAltitude (double altitude)
	Set the altitude of the light source.

void	setAzimuth (double azimuth)
	Set the azimuth of the light source.

Q_DECL_DEPRECATED void	setBand (int bandNo)
	Sets the band used by the renderer.

bool	setInputBand (int band) override
	Attempts to set the input band for the renderer.

void	setMultiDirectional (bool isMultiDirectional)
	Sets whether to render using a multi-directional hillshade algorithm.

void	setZFactor (double zfactor)
	Set the Z scaling factor of the result image.

void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override
	Used from subclasses to create SLD Rule elements following SLD v1.0 specs.

QList< int >	usesBands () const override
	Returns a list of band numbers used by the renderer.

void	writeXml (QDomDocument &doc, QDomElement &parentElem) const override
	Write base class members to xml.

double	zFactor () const
	Returns the Z scaling factor.

Public Member Functions inherited from QgsRasterRenderer
	QgsRasterRenderer (const QgsRasterRenderer &)=delete
	QgsRasterRenderer cannot be copied. Use clone() instead.

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

	~QgsRasterRenderer () override

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

int	alphaBand () const

int	bandCount () const override
	Gets number of bands.

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

void	copyCommonProperties (const QgsRasterRenderer *other, bool copyMinMaxOrigin=true)
	Copies common properties like opacity / transparency data from other renderer.

virtual QList< QgsLayerTreeModelLegendNode * >	createLegendNodes (QgsLayerTreeLayer *nodeLayer)
	Creates a set of legend nodes representing the renderer.

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

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

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

bool	needsRefresh (const QgsRectangle &extent) const
	Checks if the renderer needs to be refreshed according to extent.

QColor	nodataColor () const
	Returns the color to use for shading nodata pixels.

double	opacity () const
	Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

const QgsRasterRenderer &	operator= (const QgsRasterRenderer &)=delete
	QgsRasterRenderer cannot be copied. Use clone() instead.

const QgsRasterTransparency *	rasterTransparency () const

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

virtual bool	refresh (const QgsRectangle &extent, const QList< double > &min, const QList< double > &max, bool forceRefresh=false)
	Refreshes the renderer according to the min and max values associated with the extent.

void	setAlphaBand (int band)

bool	setInput (QgsRasterInterface *input) override
	Set input.

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

void	setNodataColor (const QColor &color)
	Sets the color to use for shading nodata pixels.

void	setOpacity (double opacity)
	Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

void	setRasterTransparency (QgsRasterTransparency *t)

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

bool	usesTransparency () const

Public Member Functions inherited from QgsRasterInterface
	QgsRasterInterface (QgsRasterInterface *input=nullptr)

virtual	~QgsRasterInterface ()=default

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

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

virtual Qgis::RasterInterfaceCapabilities	capabilities () const
	Returns the capabilities supported by the interface.

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

virtual QString	colorInterpretationName (int bandNumber) const
	Returns the name of the color interpretation for the specified bandNumber.

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.

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

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

virtual QgsRectangle	extent () const
	Gets the extent of the interface.

virtual QString	generateBandName (int bandNumber) const
	helper function to create zero padded band names

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)

Q_DECL_DEPRECATED bool	hasStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual bool	hasStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

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.

virtual QgsRasterInterface *	input () const
	Current input.

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

virtual void	setOn (bool on)
	Sets whether the interface is on or off.

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.

virtual QgsRasterInterface *	sourceInput ()
	Gets source / raw input, the first in pipe, usually provider.

virtual const QgsRasterInterface *	sourceInput () const
	Gets source / raw input, the first in pipe, usually provider.

virtual int	xBlockSize () const
	Gets block size.

virtual int	xSize () const
	Gets raster size.

virtual int	yBlockSize () const

virtual int	ySize () const

Static Public Member Functions
static QgsRasterRenderer *	create (const QDomElement &elem, QgsRasterInterface *input)
	Factory method to create a new renderer.

Additional Inherited Members
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)

QRgb	renderColorForNodataPixel () const
	Returns the color for the renderer to use to represent nodata pixels.

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.

Q_DECL_DEPRECATED void	initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

void	initStatistics (QgsRasterBandStats &statistics, int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

Protected Attributes inherited from QgsRasterRenderer
int	mAlphaBand = -1
	Read alpha value from band.

QgsRectangle	mLastRectangleUsedByRefreshContrastEnhancementIfNeeded
	To save computations and possible infinite cycle of notifications.

QgsRasterMinMaxOrigin	mMinMaxOrigin
	Origin of min/max values.

double	mOpacity = 1.0
	Global alpha value (0-1)

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

QString	mType

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

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

QList< QgsRasterBandStats >	mStatistics
	List of cached statistics, all bands mixed.

Detailed Description

A renderer for generating live hillshade models.

Definition at line 35 of file qgshillshaderenderer.h.

Constructor & Destructor Documentation

◆ QgsHillshadeRenderer()

QgsHillshadeRenderer::QgsHillshadeRenderer	(	QgsRasterInterface *	input,
		int	band,
		double	lightAzimuth,
		double	lightAltitude
	)

A renderer for generating live hillshade models.

Parameters

input	The input raster interface
band	The band in the raster to use
lightAzimuth	The azimuth of the light source
lightAltitude	The altitude of the light source

Definition at line 37 of file qgshillshaderenderer.cpp.

Member Function Documentation

◆ altitude()

double QgsHillshadeRenderer::altitude ( ) const

inline

Returns the angle of the light source over the raster.

See also: setAltitude()

Definition at line 94 of file qgshillshaderenderer.h.

◆ azimuth()

double QgsHillshadeRenderer::azimuth ( ) const

inline

Returns the direction of the light over the raster between 0-360.

See also: setAzimuth()

Definition at line 88 of file qgshillshaderenderer.h.

◆ band()

Q_DECL_DEPRECATED int QgsHillshadeRenderer::band ( ) const

inline

Returns the band used by the renderer.

Deprecated:: QGIS 3.38. Use inputBand() instead.

Definition at line 73 of file qgshillshaderenderer.h.

◆ block()

QgsRasterBlock * QgsHillshadeRenderer::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.

Implements QgsRasterRenderer.

Definition at line 99 of file qgshillshaderenderer.cpp.

◆ clone()

QgsHillshadeRenderer * QgsHillshadeRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 46 of file qgshillshaderenderer.cpp.

◆ create()

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

static

Factory method to create a new renderer.

Parameters

elem	A DOM element to create the renderer from.
input	The raster input interface.

Returns: A new QgsHillshadeRenderer.

Definition at line 61 of file qgshillshaderenderer.cpp.

◆ flags()

Qgis::RasterRendererFlags QgsHillshadeRenderer::flags ( ) const

overridevirtual

Returns flags which dictate renderer behavior.

Since: QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 56 of file qgshillshaderenderer.cpp.

◆ inputBand()

int QgsHillshadeRenderer::inputBand ( ) const

overridevirtual

Returns the input band for the renderer, or -1 if no input band is available.

For renderers which utilize multiple input bands -1 will be returned. In these cases usesBands() will return a list of all utilized bands (including alpha bands).

See also: setInputBand(); usesBands()

Since: QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 572 of file qgshillshaderenderer.cpp.

◆ multiDirectional()

bool QgsHillshadeRenderer::multiDirectional ( ) const

inline

Returns true if the renderer is using multi-directional hillshading.

See also: setMultiDirectional()

Definition at line 106 of file qgshillshaderenderer.h.

◆ setAltitude()

void QgsHillshadeRenderer::setAltitude ( double altitude )

inline

Set the altitude of the light source.

Parameters

altitude the altitude

See also: altitude()

Definition at line 120 of file qgshillshaderenderer.h.

◆ setAzimuth()

void QgsHillshadeRenderer::setAzimuth ( double azimuth )

inline

Set the azimuth of the light source.

Parameters

azimuth The azimuth of the light source, between 0 and 360.0

See also: azimuth()

Definition at line 113 of file qgshillshaderenderer.h.

◆ setBand()

void QgsHillshadeRenderer::setBand ( int bandNo )

Sets the band used by the renderer.

See also: band

Deprecated:: QGIS 3.38. Use setInputBand() instead.

Definition at line 577 of file qgshillshaderenderer.cpp.

◆ setInputBand()

bool QgsHillshadeRenderer::setInputBand ( int band )

overridevirtual

Attempts to set the input band for the renderer.

Returns true if the band was successfully set, or false if the band could not be set.

Note: Not all renderers support setting the input band.

See also: inputBand(); usesBands()

Since: QGIS 3.38

Reimplemented from QgsRasterRenderer.

Definition at line 582 of file qgshillshaderenderer.cpp.

◆ setMultiDirectional()

void QgsHillshadeRenderer::setMultiDirectional ( bool isMultiDirectional )

inline

Sets whether to render using a multi-directional hillshade algorithm.

Parameters

isMultiDirectional set to true to use multi directional rendering

See also: multiDirectional()

Definition at line 134 of file qgshillshaderenderer.h.

◆ setZFactor()

void QgsHillshadeRenderer::setZFactor ( double zfactor )

inline

Set the Z scaling factor of the result image.

Parameters

zfactor The z factor

See also: zFactor()

Definition at line 127 of file qgshillshaderenderer.h.

◆ toSld()

void QgsHillshadeRenderer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props = `QVariantMap()`
	)		const

overridevirtual

Used from subclasses to create SLD Rule elements following SLD v1.0 specs.

Since: QGIS 3.6

Reimplemented from QgsRasterRenderer.

Definition at line 597 of file qgshillshaderenderer.cpp.

◆ usesBands()

QList< int > QgsHillshadeRenderer::usesBands ( ) const

overridevirtual

Returns a list of band numbers used by the renderer.

See also: setInputBand()

Reimplemented from QgsRasterRenderer.

Definition at line 561 of file qgshillshaderenderer.cpp.

◆ writeXml()

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 81 of file qgshillshaderenderer.cpp.

◆ zFactor()

double QgsHillshadeRenderer::zFactor ( ) const

inline

Returns the Z scaling factor.

See also: setZFactor()

Definition at line 100 of file qgshillshaderenderer.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/raster/qgshillshaderenderer.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/raster/qgshillshaderenderer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsHillshadeRenderer()

Member Function Documentation

◆ altitude()

◆ azimuth()

◆ band()

◆ block()

◆ clone()

◆ create()

◆ flags()

◆ inputBand()

◆ multiDirectional()

◆ setAltitude()

◆ setAzimuth()

◆ setBand()

◆ setInputBand()

◆ setMultiDirectional()

◆ setZFactor()

◆ toSld()

◆ usesBands()

◆ writeXml()

◆ zFactor()