QGIS API Documentation  2.99.0-Master (f1c3692)
qgsrasterrendererwidget.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrasterrendererwidget.h
3  ---------------------------
4  begin : February 2012
5  copyright : (C) 2012 by Marco Hugentobler
6  email : marco at sourcepole dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSRASTERRENDERERWIDGET_H
19 #define QGSRASTERRENDERERWIDGET_H
20 
21 #include "qgsrectangle.h"
22 #include "qgis.h"
23 
24 #include <QWidget>
25 #include "qgis_gui.h"
26 
27 class QgsRasterLayer;
28 class QgsRasterRenderer;
29 class QgsMapCanvas;
31 
36 class GUI_EXPORT QgsRasterRendererWidget: public QWidget
37 {
38  Q_OBJECT
39 
40  public:
41 
42  //TODO QGIS 3.0 - remove extent parameter, replace with map canvas parameter
44  : mRasterLayer( layer )
45  , mExtent( extent )
46  {}
47 
48  virtual QgsRasterRenderer *renderer() = 0 SIP_FACTORY;
49 
50  void setRasterLayer( QgsRasterLayer *layer ) { mRasterLayer = layer; }
51  const QgsRasterLayer *rasterLayer() const { return mRasterLayer; }
52 
60  virtual void setMapCanvas( QgsMapCanvas *canvas );
61 
68  QgsMapCanvas *mapCanvas();
69 
70  virtual QString min( int index = 0 ) { Q_UNUSED( index ); return QString(); }
71  virtual QString max( int index = 0 ) { Q_UNUSED( index ); return QString(); }
72  virtual void setMin( const QString &value, int index = 0 ) { Q_UNUSED( index ); Q_UNUSED( value ); }
73  virtual void setMax( const QString &value, int index = 0 ) { Q_UNUSED( index ); Q_UNUSED( value ); }
74  virtual QString stdDev() { return QString(); }
75  virtual void setStdDev( const QString &value ) { Q_UNUSED( value ); }
76  virtual int selectedBand( int index = 0 ) { Q_UNUSED( index ); return -1; }
77 
79  virtual void doComputations() { }
80 
82  virtual QgsRasterMinMaxWidget *minMaxWidget() { return nullptr; }
83 
84  signals:
85 
90  void widgetChanged();
91 
92  protected:
93  QgsRasterLayer *mRasterLayer = nullptr;
94 
97 
99  QgsMapCanvas *mCanvas = nullptr;
100 };
101 
102 #endif // QGSRASTERRENDERERWIDGET_H
A rectangle specified with double values.
Definition: qgsrectangle.h:39
virtual QgsRasterMinMaxWidget * minMaxWidget()
Return min/max widget when it exists.
This class provides qgis with the ability to render raster datasets onto the mapcanvas.
QgsRasterRendererWidget(QgsRasterLayer *layer, const QgsRectangle &extent)
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:74
virtual void setMax(const QString &value, int index=0)
virtual QString min(int index=0)
virtual int selectedBand(int index=0)
QgsRectangle mExtent
Current extent.
#define SIP_FACTORY
Definition: qgis_sip.h:69
void setRasterLayer(QgsRasterLayer *layer)
virtual void doComputations()
Load programmatically with current values.
virtual void setStdDev(const QString &value)
const QgsRasterLayer * rasterLayer() const
virtual QString max(int index=0)
virtual void setMin(const QString &value, int index=0)
Raster renderer pipe that applies colors to a raster.