Raster renderer which draws a vector field stored in raster bands. More...

#include <qgsrastervectorfieldrenderer.h>

Inheritance diagram for QgsRasterVectorFieldRenderer:

[legend]

Public Member Functions
	QgsRasterVectorFieldRenderer (const QgsRasterVectorFieldRenderer &)=delete
	QgsRasterVectorFieldRenderer cannot be copied. Use clone() instead.
	QgsRasterVectorFieldRenderer (QgsRasterInterface *input)
	Creates a vector field renderer.
	~QgsRasterVectorFieldRenderer () override
QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
	Read block of data using given extent and size.
QgsRasterVectorFieldRenderer *	clone () const override
	Clone itself, create deep copy.
int	directionBand () const
	Returns the band which holds the coded compass directions, used when the sourceMode() is Qgis::RasterVectorFieldSourceMode::EncodedDirection.
Qgis::RasterDirectionEncoding	directionEncoding () const
	Returns the scheme the directionBand() is coded with.
Qgis::RasterRendererFlags	flags () const override
	Returns flags which dictate renderer behavior.
QList< QPair< QString, QColor > >	legendSymbologyItems () const override
	Returns symbology items if provided by renderer.
double	maximumMagnitude () const
	Returns the magnitude the symbology treats as the largest one of the raster.
double	minimumMagnitude () const
	Returns the magnitude the symbology treats as the smallest one of the raster.
const QgsRasterVectorFieldRenderer &	operator= (const QgsRasterVectorFieldRenderer &)=delete
	QgsRasterVectorFieldRenderer cannot be copied. Use clone() instead.
bool	setDirectionBand (int band)
	Attempts to set the band which holds the coded compass directions.
void	setDirectionEncoding (Qgis::RasterDirectionEncoding encoding)
	Sets the scheme the directionBand() is coded with.
void	setMaximumMagnitude (double magnitude)
	Sets the magnitude the symbology treats as the largest one of the raster.
void	setMinimumMagnitude (double magnitude)
	Sets the magnitude the symbology treats as the smallest one of the raster.
void	setSettings (const QgsVectorFieldSettings &settings)
	Sets the settings used to render the vector field.
void	setSourceMode (Qgis::RasterVectorFieldSourceMode mode)
	Sets the way the vectors are stored in the raster bands.
QgsVectorFieldSettings	settings () const
	Returns the settings used to render the vector field.
bool	setXBand (int band)
	Attempts to set the band which holds the x component of the vectors.
bool	setYBand (int band)
	Attempts to set the band which holds the y component of the vectors.
Qgis::RasterVectorFieldSourceMode	sourceMode () const
	Returns the way the vectors are stored in the raster bands.
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.
int	xBand () const
	Returns the band which holds the x component of the vectors.
int	yBand () const
	Returns the band which holds the y component of the vectors.
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 int	inputBand () const
	Returns the input band for the renderer, or -1 if no input band is available.
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.
virtual bool	setInputBand (int band)
	Attempts to set the input band for the renderer.
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 Q_DECL_DEPRECATED void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const
	Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
virtual bool	toSld (QDomDocument &doc, QDomElement &element, QgsSldExportContext &context) const
	Used from subclasses to create SLD Rule elements following SLD v1.0 specs.
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 std::unique_ptr< QgsRasterRenderer >	create (const QDomElement &elem, QgsRasterInterface *input)
	Creates an instance of the renderer based on definition from XML (used by renderer registry).

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).
std::unique_ptr< QgsRasterTransparency >	mRasterTransparency
	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

Raster renderer which draws a vector field stored in raster bands.

The way that the raster data is interpreted as vectors (eg. Cartesian component per band, single band with cardinal direction) can be set using setSourceMode()

Since: QGIS 4.4

Definition at line 38 of file qgsrastervectorfieldrenderer.h.

Constructor & Destructor Documentation

◆ QgsRasterVectorFieldRenderer() [1/2]

QgsRasterVectorFieldRenderer::QgsRasterVectorFieldRenderer ( QgsRasterInterface * input )

explicit

Creates a vector field renderer.

Definition at line 45 of file qgsrastervectorfieldrenderer.cpp.

◆ ~QgsRasterVectorFieldRenderer()

QgsRasterVectorFieldRenderer::~QgsRasterVectorFieldRenderer ( )

overridedefault

◆ QgsRasterVectorFieldRenderer() [2/2]

QgsRasterVectorFieldRenderer::QgsRasterVectorFieldRenderer ( const QgsRasterVectorFieldRenderer & )

delete

QgsRasterVectorFieldRenderer cannot be copied. Use clone() instead.

Member Function Documentation

◆ block()

QgsRasterBlock * QgsRasterVectorFieldRenderer::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 339 of file qgsrastervectorfieldrenderer.cpp.

◆ clone()

QgsRasterVectorFieldRenderer * QgsRasterVectorFieldRenderer::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 51 of file qgsrastervectorfieldrenderer.cpp.

◆ create()

std::unique_ptr< QgsRasterRenderer > QgsRasterVectorFieldRenderer::create	(	const QDomElement &	elem,
		QgsRasterInterface *	input )

static

Creates an instance of the renderer based on definition from XML (used by renderer registry).

Definition at line 71 of file qgsrastervectorfieldrenderer.cpp.

◆ directionBand()

int QgsRasterVectorFieldRenderer::directionBand ( ) const

inline

Returns the band which holds the coded compass directions, used when the sourceMode() is Qgis::RasterVectorFieldSourceMode::EncodedDirection.

See also: setDirectionBand()

Definition at line 83 of file qgsrastervectorfieldrenderer.h.

◆ directionEncoding()

Qgis::RasterDirectionEncoding QgsRasterVectorFieldRenderer::directionEncoding ( ) const

inline

Returns the scheme the directionBand() is coded with.

See also: setDirectionEncoding()

Definition at line 99 of file qgsrastervectorfieldrenderer.h.

◆ flags()

Qgis::RasterRendererFlags QgsRasterVectorFieldRenderer::flags ( ) const

overridevirtual

Returns flags which dictate renderer behavior.

Since: QGIS 3.28

Reimplemented from QgsRasterRenderer.

Definition at line 66 of file qgsrastervectorfieldrenderer.cpp.

◆ legendSymbologyItems()

QList< QPair< QString, QColor > > QgsRasterVectorFieldRenderer::legendSymbologyItems ( ) const

overridevirtual

Returns symbology items if provided by renderer.

See also: createLegendNodes()

Reimplemented from QgsRasterRenderer.

Definition at line 176 of file qgsrastervectorfieldrenderer.cpp.

◆ maximumMagnitude()

double QgsRasterVectorFieldRenderer::maximumMagnitude ( ) const

inline

Returns the magnitude the symbology treats as the largest one of the raster.

Note: Ignored when the sourceMode() is Qgis::RasterVectorFieldSourceMode::EncodedDirection

See also: setMaximumMagnitude()

Definition at line 177 of file qgsrastervectorfieldrenderer.h.

◆ minimumMagnitude()

double QgsRasterVectorFieldRenderer::minimumMagnitude ( ) const

inline

Returns the magnitude the symbology treats as the smallest one of the raster.

Note: Ignored when the sourceMode() is Qgis::RasterVectorFieldSourceMode::EncodedDirection

See also: setMinimumMagnitude()

Definition at line 161 of file qgsrastervectorfieldrenderer.h.

◆ operator=()

const QgsRasterVectorFieldRenderer & QgsRasterVectorFieldRenderer::operator= ( const QgsRasterVectorFieldRenderer & )

delete

QgsRasterVectorFieldRenderer cannot be copied. Use clone() instead.

◆ setDirectionBand()

bool QgsRasterVectorFieldRenderer::setDirectionBand ( int band )

Attempts to set the band which holds the coded compass directions.

Returns true if the band was successfully set.

See also: directionBand()

Definition at line 147 of file qgsrastervectorfieldrenderer.cpp.

◆ setDirectionEncoding()

void QgsRasterVectorFieldRenderer::setDirectionEncoding ( Qgis::RasterDirectionEncoding encoding )

inline

Sets the scheme the directionBand() is coded with.

See also: directionEncoding()

Definition at line 106 of file qgsrastervectorfieldrenderer.h.

◆ setMaximumMagnitude()

void QgsRasterVectorFieldRenderer::setMaximumMagnitude ( double magnitude )

inline

Sets the magnitude the symbology treats as the largest one of the raster.

See also: maximumMagnitude()

Definition at line 184 of file qgsrastervectorfieldrenderer.h.

◆ setMinimumMagnitude()

void QgsRasterVectorFieldRenderer::setMinimumMagnitude ( double magnitude )

inline

Sets the magnitude the symbology treats as the smallest one of the raster.

See also: minimumMagnitude()

Definition at line 168 of file qgsrastervectorfieldrenderer.h.

◆ setSettings()

void QgsRasterVectorFieldRenderer::setSettings ( const QgsVectorFieldSettings & settings )

inline

Sets the settings used to render the vector field.

See also: settings()

Definition at line 152 of file qgsrastervectorfieldrenderer.h.

◆ setSourceMode()

void QgsRasterVectorFieldRenderer::setSourceMode ( Qgis::RasterVectorFieldSourceMode mode )

inline

Sets the way the vectors are stored in the raster bands.

See also: sourceMode()

Definition at line 75 of file qgsrastervectorfieldrenderer.h.

◆ settings()

QgsVectorFieldSettings QgsRasterVectorFieldRenderer::settings ( ) const

inline

Returns the settings used to render the vector field.

See also: setSettings()

Definition at line 145 of file qgsrastervectorfieldrenderer.h.

◆ setXBand()

bool QgsRasterVectorFieldRenderer::setXBand ( int band )

Attempts to set the band which holds the x component of the vectors.

Returns true if the band was successfully set.

See also: xBand()

Definition at line 129 of file qgsrastervectorfieldrenderer.cpp.

◆ setYBand()

bool QgsRasterVectorFieldRenderer::setYBand ( int band )

Attempts to set the band which holds the y component of the vectors.

Returns true if the band was successfully set.

See also: yBand()

Definition at line 138 of file qgsrastervectorfieldrenderer.cpp.

◆ sourceMode()

Qgis::RasterVectorFieldSourceMode QgsRasterVectorFieldRenderer::sourceMode ( ) const

inline

Returns the way the vectors are stored in the raster bands.

See also: setSourceMode()

Definition at line 68 of file qgsrastervectorfieldrenderer.h.

◆ usesBands()

QList< int > QgsRasterVectorFieldRenderer::usesBands ( ) const

overridevirtual

Returns a list of band numbers used by the renderer.

See also: setInputBand()

Reimplemented from QgsRasterRenderer.

Definition at line 156 of file qgsrastervectorfieldrenderer.cpp.

◆ writeXml()

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 101 of file qgsrastervectorfieldrenderer.cpp.

◆ xBand()

int QgsRasterVectorFieldRenderer::xBand ( ) const

inline

Returns the band which holds the x component of the vectors.

See also: setXBand()

Definition at line 113 of file qgsrastervectorfieldrenderer.h.

◆ yBand()

int QgsRasterVectorFieldRenderer::yBand ( ) const

inline

Returns the band which holds the y component of the vectors.

See also: setYBand()

Definition at line 129 of file qgsrastervectorfieldrenderer.h.

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

/build/qgis-4.3.0+git20261027+52aa6503bed+99sid/src/core/raster/qgsrastervectorfieldrenderer.h
/build/qgis-4.3.0+git20261027+52aa6503bed+99sid/src/core/raster/qgsrastervectorfieldrenderer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRasterVectorFieldRenderer() [1/2]

◆ ~QgsRasterVectorFieldRenderer()

◆ QgsRasterVectorFieldRenderer() [2/2]

Member Function Documentation

◆ block()

◆ clone()

◆ create()

◆ directionBand()

◆ directionEncoding()

◆ flags()

◆ legendSymbologyItems()

◆ maximumMagnitude()

◆ minimumMagnitude()

◆ operator=()

◆ setDirectionBand()

◆ setDirectionEncoding()

◆ setMaximumMagnitude()

◆ setMinimumMagnitude()

◆ setSettings()

◆ setSourceMode()

◆ settings()

◆ setXBand()

◆ setYBand()

◆ sourceMode()

◆ usesBands()

◆ writeXml()

◆ xBand()

◆ yBand()