Single band pseudo color renderer widget consists of a color ramp shader widget, a raster min max widget and a band selector. More...

#include <qgssinglebandpseudocolorrendererwidget.h>

Inheritance diagram for QgsSingleBandPseudoColorRendererWidget:

[legend]

Public Slots
void	loadMinMax (int bandNo, double min, double max)
	called when new min/max values are loaded

void	loadMinMaxFromTree (double min, double max)
	called when the color ramp tree has changed

Public Member Functions
	QgsSingleBandPseudoColorRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())
	Creates new raster renderer widget.

void	doComputations () override
	Load programmatically with current values.

QString	max (int index=0) override

QString	min (int index=0) override

QgsRasterMinMaxWidget *	minMaxWidget () override
	Returns min/max widget when it exists.

QgsRasterRenderer *	renderer () override
	Creates a new renderer, using the properties defined in the widget.

int	selectedBand (int index=0) override

void	setFromRenderer (const QgsRasterRenderer *r)
	Sets the widget state from the specified renderer.

void	setMapCanvas (QgsMapCanvas *canvas) override
	Sets the map canvas associated with the widget.

void	setMax (const QString &value, int index=0) override

void	setMin (const QString &value, int index=0) override

Public Member Functions inherited from QgsRasterRendererWidget
	QgsRasterRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent)

virtual QgsContrastEnhancement::ContrastEnhancementAlgorithm	contrastEnhancementAlgorithm () const
	Returns the contrast enhancement algorithm to be used by the raster renderer.

QgsMapCanvas *	mapCanvas ()
	Returns the map canvas associated with the widget.

const QgsRasterLayer *	rasterLayer () const
	Returns the raster layer associated with the widget.

virtual void	setContrastEnhancementAlgorithm (QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm)
	Sets the contrast enhancement algorithm to be used by the raster renderer.

void	setRasterLayer (QgsRasterLayer *layer)
	Sets the raster layer associated with the widget.

virtual void	setStdDev (const QString &value)

virtual QString	stdDev ()

Static Public Member Functions
static QgsRasterRendererWidget *	create (QgsRasterLayer *layer, const QgsRectangle &extent)
	Creates new raster renderer widget.

Friends
class	TestQgsSingleBandPseudoColorRendererWidget

Additional Inherited Members
Signals inherited from QgsRasterRendererWidget
void	widgetChanged ()
	Emitted when something on the widget has changed.

Protected Attributes inherited from QgsRasterRendererWidget
QgsMapCanvas *	mCanvas = nullptr
	Associated map canvas.

QgsRectangle	mExtent
	Current extent.

QgsRasterLayer *	mRasterLayer = nullptr

Detailed Description

Single band pseudo color renderer widget consists of a color ramp shader widget, a raster min max widget and a band selector.

Definition at line 38 of file qgssinglebandpseudocolorrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsSingleBandPseudoColorRendererWidget()

QgsSingleBandPseudoColorRendererWidget::QgsSingleBandPseudoColorRendererWidget	(	QgsRasterLayer *	layer,
		const QgsRectangle &	extent = `QgsRectangle()`
	)

Creates new raster renderer widget.

Definition at line 39 of file qgssinglebandpseudocolorrendererwidget.cpp.

Member Function Documentation

◆ create()

static QgsRasterRendererWidget * QgsSingleBandPseudoColorRendererWidget::create	(	QgsRasterLayer *	layer,
		const QgsRectangle &	extent
	)

inlinestatic

Creates new raster renderer widget.

Definition at line 47 of file qgssinglebandpseudocolorrendererwidget.h.

◆ doComputations()

void QgsSingleBandPseudoColorRendererWidget::doComputations ( )

overridevirtual

Load programmatically with current values.

Reimplemented from QgsRasterRendererWidget.

Definition at line 123 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ loadMinMax

void QgsSingleBandPseudoColorRendererWidget::loadMinMax	(	int	bandNo,
		double	min,
		double	max
	)

slot

called when new min/max values are loaded

Definition at line 178 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ loadMinMaxFromTree

void QgsSingleBandPseudoColorRendererWidget::loadMinMaxFromTree	(	double	min,
		double	max
	)

slot

called when the color ramp tree has changed

Definition at line 214 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ max()

QString QgsSingleBandPseudoColorRendererWidget::max ( int index = 0 )

inlineoverridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 64 of file qgssinglebandpseudocolorrendererwidget.h.

◆ min()

QString QgsSingleBandPseudoColorRendererWidget::min ( int index = 0 )

inlineoverridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 59 of file qgssinglebandpseudocolorrendererwidget.h.

◆ minMaxWidget()

QgsRasterMinMaxWidget * QgsSingleBandPseudoColorRendererWidget::minMaxWidget ( )

overridevirtual

Returns min/max widget when it exists.

Reimplemented from QgsRasterRendererWidget.

Definition at line 128 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ renderer()

QgsRasterRenderer * QgsSingleBandPseudoColorRendererWidget::renderer ( )

overridevirtual

Creates a new renderer, using the properties defined in the widget.

The caller takes ownership of the returned renderer.

Implements QgsRasterRendererWidget.

Definition at line 105 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ selectedBand()

int QgsSingleBandPseudoColorRendererWidget::selectedBand ( int index = 0 )

inlineoverridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 71 of file qgssinglebandpseudocolorrendererwidget.h.

◆ setFromRenderer()

void QgsSingleBandPseudoColorRendererWidget::setFromRenderer ( const QgsRasterRenderer * r )

Sets the widget state from the specified renderer.

Definition at line 137 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ setMapCanvas()

void QgsSingleBandPseudoColorRendererWidget::setMapCanvas ( QgsMapCanvas * canvas )

overridevirtual

Sets the map canvas associated with the widget.

This allows the widget to retrieve the current map extent and other properties from the canvas.

Parameters

canvas map canvas

See also: mapCanvas()

Reimplemented from QgsRasterRendererWidget.

Definition at line 130 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ setMax()

void QgsSingleBandPseudoColorRendererWidget::setMax	(	const QString &	value,
		int	index = `0`
	)

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 294 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ setMin()

void QgsSingleBandPseudoColorRendererWidget::setMin	(	const QString &	value,
		int	index = `0`
	)

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 287 of file qgssinglebandpseudocolorrendererwidget.cpp.

Friends And Related Symbol Documentation

◆ TestQgsSingleBandPseudoColorRendererWidget

friend class TestQgsSingleBandPseudoColorRendererWidget

friend

Definition at line 102 of file qgssinglebandpseudocolorrendererwidget.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSingleBandPseudoColorRendererWidget()

Member Function Documentation

◆ create()

◆ doComputations()

◆ loadMinMax

◆ loadMinMaxFromTree

◆ max()

◆ min()

◆ minMaxWidget()

◆ renderer()

◆ selectedBand()

◆ setFromRenderer()

◆ setMapCanvas()

◆ setMax()

◆ setMin()

Friends And Related Symbol Documentation

◆ TestQgsSingleBandPseudoColorRendererWidget