QGIS API Documentation: QgsMultiBandColorRendererWidget Class Reference

QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)

Loading...

Searching...

No Matches

#include <qgsmultibandcolorrendererwidget.h>

Inheritance diagram for QgsMultiBandColorRendererWidget:

Inheritance graph

[legend]

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

Public Member Functions
	QgsMultiBandColorRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())

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

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	setContrastEnhancementAlgorithm (QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm) override
	Sets the contrast enhancement algorithm to be used by the raster renderer.

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)

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

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

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)

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

Definition at line 36 of file qgsmultibandcolorrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsMultiBandColorRendererWidget()

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

Definition at line 25 of file qgsmultibandcolorrendererwidget.cpp.

Member Function Documentation

◆ contrastEnhancementAlgorithm()

QgsContrastEnhancement::ContrastEnhancementAlgorithm QgsMultiBandColorRendererWidget::contrastEnhancementAlgorithm ( ) const

overridevirtual

Returns the contrast enhancement algorithm to be used by the raster renderer.

Since: QGIS 3.26

Reimplemented from QgsRasterRendererWidget.

Definition at line 447 of file qgsmultibandcolorrendererwidget.cpp.

◆ create()

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

inlinestatic

Definition at line 42 of file qgsmultibandcolorrendererwidget.h.

◆ doComputations()

void QgsMultiBandColorRendererWidget::doComputations ( )

overridevirtual

Load programmatically with current values.

Reimplemented from QgsRasterRendererWidget.

Definition at line 110 of file qgsmultibandcolorrendererwidget.cpp.

◆ loadMinMax

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

slot

called when new min/max values are loaded

Definition at line 253 of file qgsmultibandcolorrendererwidget.cpp.

◆ max()

QString QgsMultiBandColorRendererWidget::max ( int index = 0 )

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 375 of file qgsmultibandcolorrendererwidget.cpp.

◆ min()

QString QgsMultiBandColorRendererWidget::min ( int index = 0 )

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 359 of file qgsmultibandcolorrendererwidget.cpp.

◆ minMaxWidget()

QgsRasterMinMaxWidget * QgsMultiBandColorRendererWidget::minMaxWidget ( )

inlineoverridevirtual

Returns min/max widget when it exists.

Reimplemented from QgsRasterRendererWidget.

Definition at line 62 of file qgsmultibandcolorrendererwidget.h.

◆ renderer()

QgsRasterRenderer * QgsMultiBandColorRendererWidget::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 86 of file qgsmultibandcolorrendererwidget.cpp.

◆ selectedBand()

int QgsMultiBandColorRendererWidget::selectedBand ( int index = 0 )

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 431 of file qgsmultibandcolorrendererwidget.cpp.

◆ setContrastEnhancementAlgorithm()

void QgsMultiBandColorRendererWidget::setContrastEnhancementAlgorithm ( QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm )

overridevirtual

Sets the contrast enhancement algorithm to be used by the raster renderer.

Since: QGIS 3.26

Reimplemented from QgsRasterRendererWidget.

Definition at line 452 of file qgsmultibandcolorrendererwidget.cpp.

◆ setFromRenderer()

void QgsMultiBandColorRendererWidget::setFromRenderer ( const QgsRasterRenderer * r )

Sets the widget state from the specified renderer.

Definition at line 324 of file qgsmultibandcolorrendererwidget.cpp.

◆ setMapCanvas()

void QgsMultiBandColorRendererWidget::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 115 of file qgsmultibandcolorrendererwidget.cpp.

◆ setMax()

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

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 411 of file qgsmultibandcolorrendererwidget.cpp.

◆ setMin()

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

overridevirtual

Reimplemented from QgsRasterRendererWidget.

Definition at line 391 of file qgsmultibandcolorrendererwidget.cpp.

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

/build/qgis-3.36.0+99sid/src/gui/raster/qgsmultibandcolorrendererwidget.h
/build/qgis-3.36.0+99sid/src/gui/raster/qgsmultibandcolorrendererwidget.cpp