QGIS API Documentation: QgsSingleBandPseudoColorRendererWidget Class Reference

QGIS API Documentation 3.20.0-Odense (decaadbb31)

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:

Inheritance graph

[legend]

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

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

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

int	currentBand () const
	Returns the current raster band number. More...

void	doComputations () override
	Load programmatically with current values. More...

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

QgsRasterRenderer *	renderer () override

void	setFromRenderer (const QgsRasterRenderer *r)
	Set state of the widget from renderer settings. More...

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

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

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

virtual QString	max (int index=0)

virtual QString	min (int index=0)

const QgsRasterLayer *	rasterLayer () const

virtual int	selectedBand (int index=0)

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

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

void	setRasterLayer (QgsRasterLayer *layer)

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. More...

Friends
class	TestQgsSingleBandPseudoColorRendererWidget

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

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

QgsRectangle	mExtent
	Current extent. More...

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 45 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 49 of file qgssinglebandpseudocolorrendererwidget.h.

◆ currentBand()

int QgsSingleBandPseudoColorRendererWidget::currentBand ( ) const

Returns the current raster band number.

Definition at line 136 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ doComputations()

void QgsSingleBandPseudoColorRendererWidget::doComputations ( )

overridevirtual

Load programmatically with current values.

Reimplemented from QgsRasterRendererWidget.

Definition at line 129 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 189 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ loadMinMaxFromTree

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

slot

called when the color ramp tree has changed

Definition at line 225 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ minMaxWidget()

QgsRasterMinMaxWidget * QgsSingleBandPseudoColorRendererWidget::minMaxWidget ( )

overridevirtual

Returns min/max widget when it exists.

Reimplemented from QgsRasterRendererWidget.

Definition at line 134 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ renderer()

QgsRasterRenderer * QgsSingleBandPseudoColorRendererWidget::renderer ( )

overridevirtual

Implements QgsRasterRendererWidget.

Definition at line 111 of file qgssinglebandpseudocolorrendererwidget.cpp.

◆ setFromRenderer()

void QgsSingleBandPseudoColorRendererWidget::setFromRenderer ( const QgsRasterRenderer * r )

Set state of the widget from renderer settings.

Definition at line 148 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()

Since: QGIS 2.16

Reimplemented from QgsRasterRendererWidget.

Definition at line 141 of file qgssinglebandpseudocolorrendererwidget.cpp.

Friends And Related Function Documentation

◆ TestQgsSingleBandPseudoColorRendererWidget

friend class TestQgsSingleBandPseudoColorRendererWidget

friend

Definition at line 87 of file qgssinglebandpseudocolorrendererwidget.h.

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

/build/qgis-3.20.0+99unstable/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h
/build/qgis-3.20.0+99unstable/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp