QGIS API Documentation 4.3.0-Master (52aa6503bed)
Loading...
Searching...
No Matches
QgsRasterVectorFieldRendererWidget Class Reference

Configuration widget for QgsRasterVectorFieldRenderer. More...

#include <qgsrastervectorfieldrendererwidget.h>

Inheritance diagram for QgsRasterVectorFieldRendererWidget:

Public Member Functions

 QgsRasterVectorFieldRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent=QgsRectangle())
 Constructor for QgsRasterVectorFieldRendererWidget.
QgsRasterRenderer * renderer () override
 Creates a new renderer, using the properties defined in the widget.
Public Member Functions inherited from QgsRasterRendererWidget
 QgsRasterRendererWidget (QgsRasterLayer *layer, const QgsRectangle &extent)
 Constructor for QgsRasterRendererWidget.
virtual QgsContrastEnhancement::ContrastEnhancementAlgorithm contrastEnhancementAlgorithm () const
 Returns the contrast enhancement algorithm to be used by the raster renderer.
virtual void doComputations ()
 Load programmatically with current values.
QgsMapCanvas * mapCanvas ()
 Returns the map canvas associated with the widget.
virtual QString max (int index=0)
virtual QString min (int index=0)
virtual QgsRasterMinMaxWidget * minMaxWidget ()
 Returns min/max widget when it exists.
const QgsRasterLayer * rasterLayer () const
 Returns the raster layer associated with the widget.
virtual int selectedBand (int index=0)
virtual void setContrastEnhancementAlgorithm (QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm)
 Sets the contrast enhancement algorithm to be used by the raster renderer.
virtual void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the widget.
virtual void setMax (const QString &value, int index=0)
virtual void setMin (const QString &value, int index=0)
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)
 Widget creation function (mainly for the use by the renderer registry).

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

Configuration widget for QgsRasterVectorFieldRenderer.

Holds the pair of band selectors which are specific to a raster layer, and a QgsVectorFieldSettingsWidget for the symbology itself, which is shared with the mesh layer.

Since
QGIS 4.4

Definition at line 41 of file qgsrastervectorfieldrendererwidget.h.

Constructor & Destructor Documentation

◆ QgsRasterVectorFieldRendererWidget()

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

Constructor for QgsRasterVectorFieldRendererWidget.

Parameters
layerassociated raster layer
extentcurrent canvas extent

Definition at line 30 of file qgsrastervectorfieldrendererwidget.cpp.

Member Function Documentation

◆ create()

QgsRasterRendererWidget * QgsRasterVectorFieldRendererWidget::create ( QgsRasterLayer * layer,
const QgsRectangle & extent )
inlinestatic

Widget creation function (mainly for the use by the renderer registry).

Definition at line 54 of file qgsrastervectorfieldrendererwidget.h.

◆ renderer()

QgsRasterRenderer * QgsRasterVectorFieldRendererWidget::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 156 of file qgsrastervectorfieldrendererwidget.cpp.


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