QGIS API Documentation 4.3.0-Master (91d4a333d5d)
Loading...
Searching...
No Matches
qgsrendererrasterpropertieswidget.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsrendererrasterpropertieswidget.cpp
3 ---------------------
4 begin : May 2016
5 copyright : (C) 2016 by Nathan Woodrow
6 email : woodrow dot nathan at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
16
17#include "qgis.h"
18#include "qgsapplication.h"
22#include "qgsmapcanvas.h"
26#include "qgsproject.h"
27#include "qgsprojectutils.h"
29#include "qgsrasterlayer.h"
37
38#include <QString>
39
40#include "moc_qgsrendererrasterpropertieswidget.cpp"
41
42using namespace Qt::StringLiterals;
43
44void QgsRendererRasterPropertiesWidget::initRendererWidgetFunctions()
45{
46 static bool sInitialized = false;
47 if ( sInitialized )
48 return;
49
58
59 sInitialized = true;
60}
61
63 : QgsMapLayerConfigWidget( layer, canvas, parent )
64 , mRasterLayer( qobject_cast<QgsRasterLayer *>( layer ) )
65{
66 if ( !mRasterLayer )
67 return;
68
69 setupUi( this );
70 connect( mResetColorRenderingBtn, &QToolButton::clicked, this, &QgsRendererRasterPropertiesWidget::mResetColorRenderingBtn_clicked );
71
72 initRendererWidgetFunctions();
73
74 mResamplingUtils.initWidgets( mRasterLayer, mZoomedInResamplingComboBox, mZoomedOutResamplingComboBox, mMaximumOversamplingSpinBox, mCbEarlyResampling );
75
76 connect( cboRenderers, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsRendererRasterPropertiesWidget::rendererChanged );
77
78 connect( mSliderBrightness, &QAbstractSlider::valueChanged, mBrightnessSpinBox, &QSpinBox::setValue );
79 connect( mBrightnessSpinBox, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), mSliderBrightness, &QAbstractSlider::setValue );
80 mBrightnessSpinBox->setClearValue( 0 );
81
82 connect( mSliderContrast, &QAbstractSlider::valueChanged, mContrastSpinBox, &QSpinBox::setValue );
83 connect( mContrastSpinBox, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), mSliderContrast, &QAbstractSlider::setValue );
84 mContrastSpinBox->setClearValue( 0 );
85
86 connect( mSliderGamma, &QAbstractSlider::valueChanged, this, &QgsRendererRasterPropertiesWidget::updateGammaSpinBox );
87 connect( mGammaSpinBox, static_cast<void ( QDoubleSpinBox::* )( double )>( &QDoubleSpinBox::valueChanged ), this, &QgsRendererRasterPropertiesWidget::updateGammaSlider );
88 mGammaSpinBox->setClearValue( 1.0 );
89
90 // Connect saturation slider and spin box
91 connect( sliderSaturation, &QAbstractSlider::valueChanged, spinBoxSaturation, &QSpinBox::setValue );
92 connect( spinBoxSaturation, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), sliderSaturation, &QAbstractSlider::setValue );
93 spinBoxSaturation->setClearValue( 0 );
94
95 // Connect colorize strength slider and spin box
96 connect( sliderColorizeStrength, &QAbstractSlider::valueChanged, spinColorizeStrength, &QSpinBox::setValue );
97 connect( spinColorizeStrength, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), sliderColorizeStrength, &QAbstractSlider::setValue );
98 spinColorizeStrength->setClearValue( 100 );
99
100 // enable or disable saturation slider and spin box depending on grayscale combo choice
101 connect( comboGrayscale, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsRendererRasterPropertiesWidget::toggleSaturationControls );
102
103 // enable or disable colorize colorbutton with colorize checkbox
104 connect( mColorizeCheck, &QAbstractButton::toggled, this, &QgsRendererRasterPropertiesWidget::toggleColorizeControls );
105
106 // Just connect the spin boxes because the sliders update the spinners
107 connect( mBrightnessSpinBox, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), this, &QgsPanelWidget::changed );
108 connect( mContrastSpinBox, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), this, &QgsPanelWidget::changed );
109 connect( mGammaSpinBox, static_cast<void ( QDoubleSpinBox::* )( double )>( &QDoubleSpinBox::valueChanged ), this, &QgsPanelWidget::changed );
110 connect( spinBoxSaturation, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), this, &QgsPanelWidget::changed );
111 connect( spinColorizeStrength, static_cast<void ( QSpinBox::* )( int )>( &QSpinBox::valueChanged ), this, &QgsPanelWidget::changed );
112 connect( btnColorizeColor, &QgsColorButton::colorChanged, this, &QgsPanelWidget::changed );
113 connect( mInvertColorsCheck, &QAbstractButton::toggled, this, &QgsPanelWidget::changed );
114
115 connect( mBlendModeComboBox, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsPanelWidget::changed );
116 connect( mZoomedInResamplingComboBox, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsPanelWidget::changed );
117 connect( mZoomedOutResamplingComboBox, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsPanelWidget::changed );
118 connect( mMaximumOversamplingSpinBox, static_cast<void ( QDoubleSpinBox::* )( double )>( &QDoubleSpinBox::valueChanged ), this, &QgsPanelWidget::changed );
119 connect( mCbEarlyResampling, &QAbstractButton::toggled, this, &QgsPanelWidget::changed );
120
121 // finally sync to the layer - even though some actions may emit widgetChanged signal,
122 // this is not a problem - nobody is listening to our signals yet
123 syncToLayer( mRasterLayer );
124
125 connect( mRasterLayer, &QgsMapLayer::styleChanged, this, &QgsRendererRasterPropertiesWidget::refreshAfterStyleChanged );
126}
127
132
134{
135 const QString rendererName = cboRenderers->currentData().toString();
136 setRendererWidget( rendererName );
137 emit changed();
138}
139
141{
142 if ( QgsBrightnessContrastFilter *brightnessFilter = mRasterLayer->brightnessFilter() )
143 {
144 brightnessFilter->setBrightness( mSliderBrightness->value() );
145 brightnessFilter->setContrast( mSliderContrast->value() );
146 brightnessFilter->setGamma( mGammaSpinBox->value() );
147 }
148
149 if ( QgsRasterRendererWidget *rendererWidget = dynamic_cast<QgsRasterRendererWidget *>( stackedWidget->currentWidget() ) )
150 {
151 rendererWidget->doComputations();
152
153 std::unique_ptr< QgsRasterRenderer > newRenderer( rendererWidget->renderer() );
154 if ( newRenderer )
155 {
156 // there are transparency related data stored in renderer instances, but they
157 // are not configured in the widget, so we need to copy them over from existing renderer
158 if ( QgsRasterRenderer *oldRenderer = mRasterLayer->renderer() )
159 newRenderer->copyCommonProperties( oldRenderer, false );
160 mRasterLayer->setRenderer( newRenderer.release() );
161 }
162 }
163
164 // Hue and saturation controls
165 if ( QgsHueSaturationFilter *hueSaturationFilter = mRasterLayer->hueSaturationFilter() )
166 {
167 hueSaturationFilter->setSaturation( sliderSaturation->value() );
168 hueSaturationFilter->setGrayscaleMode( ( QgsHueSaturationFilter::GrayscaleMode ) comboGrayscale->currentIndex() );
169 hueSaturationFilter->setColorizeOn( mColorizeCheck->checkState() );
170 hueSaturationFilter->setColorizeColor( btnColorizeColor->color() );
171 hueSaturationFilter->setColorizeStrength( sliderColorizeStrength->value() );
172 hueSaturationFilter->setInvertColors( mInvertColorsCheck->isChecked() );
173 }
174
175 mResamplingUtils.refreshLayerFromWidgets();
176
177 mRasterLayer->setBlendMode( mBlendModeComboBox->blendMode() );
178}
179
181{
182 mRasterLayer = layer;
183
184 cboRenderers->blockSignals( true );
185 cboRenderers->clear();
187 const auto constRenderersList = QgsApplication::rasterRendererRegistry()->renderersList();
188 for ( const QString &name : constRenderersList )
189 {
190 if ( QgsApplication::rasterRendererRegistry()->rendererData( name, entry ) )
191 {
192 if ( ( mRasterLayer->rasterType() != Qgis::RasterLayerType::SingleBandColorData && entry.name != "singlebandcolordata"_L1 )
193 || ( mRasterLayer->rasterType() == Qgis::RasterLayerType::SingleBandColorData && entry.name == "singlebandcolordata"_L1 ) )
194 {
195 cboRenderers->addItem( entry.icon(), entry.visibleName, entry.name );
196 }
197 }
198 }
199 cboRenderers->setCurrentIndex( -1 );
200 cboRenderers->blockSignals( false );
201
202 if ( QgsRasterRenderer *renderer = mRasterLayer->renderer() )
203 {
204 setRendererWidget( renderer->type() );
205 }
206
207 if ( QgsBrightnessContrastFilter *brightnessFilter = mRasterLayer->brightnessFilter() )
208 {
209 mSliderBrightness->setValue( brightnessFilter->brightness() );
210 mSliderContrast->setValue( brightnessFilter->contrast() );
211 mGammaSpinBox->setValue( brightnessFilter->gamma() );
212 }
213
214 btnColorizeColor->setColorDialogTitle( tr( "Select Color" ) );
215 btnColorizeColor->setContext( u"symbology"_s );
216
217 // Hue and saturation color control
218 //set hue and saturation controls to current values
219 if ( const QgsHueSaturationFilter *hueSaturationFilter = mRasterLayer->hueSaturationFilter() )
220 {
221 sliderSaturation->setValue( hueSaturationFilter->saturation() );
222 comboGrayscale->setCurrentIndex( ( int ) hueSaturationFilter->grayscaleMode() );
223
224 // Set initial state of saturation controls based on grayscale mode choice
225 toggleSaturationControls( static_cast<int>( hueSaturationFilter->grayscaleMode() ) );
226
227 // Set initial state of colorize controls
228 mColorizeCheck->setChecked( hueSaturationFilter->colorizeOn() );
229 btnColorizeColor->setColor( hueSaturationFilter->colorizeColor() );
230 toggleColorizeControls( hueSaturationFilter->colorizeOn() );
231 sliderColorizeStrength->setValue( hueSaturationFilter->colorizeStrength() );
232
233 mInvertColorsCheck->setChecked( hueSaturationFilter->invertColors() );
234 }
235
236 //blend mode
237 mBlendModeComboBox->setShowClippingModes( QgsProjectUtils::layerIsContainedInGroupLayer( QgsProject::instance(), mRasterLayer ) );
238 mBlendModeComboBox->setBlendMode( mRasterLayer->blendMode() );
239
240 //set combo boxes to current resampling types
241 mResamplingUtils.refreshWidgetsFromLayer();
242}
243
244void QgsRendererRasterPropertiesWidget::mResetColorRenderingBtn_clicked()
245{
246 mBlendModeComboBox->setBlendMode( QPainter::CompositionMode_SourceOver );
247 mSliderBrightness->setValue( 0 );
248 mSliderContrast->setValue( 0 );
249 mGammaSpinBox->setValue( 1.0 );
250 sliderSaturation->setValue( 0 );
251 comboGrayscale->setCurrentIndex( ( int ) QgsHueSaturationFilter::GrayscaleOff );
252 mColorizeCheck->setChecked( false );
253 sliderColorizeStrength->setValue( 100 );
254 mInvertColorsCheck->setChecked( false );
255}
256
257void QgsRendererRasterPropertiesWidget::toggleSaturationControls( int grayscaleMode )
258{
259 // Enable or disable saturation controls based on choice of grayscale mode
260 if ( grayscaleMode == 0 )
261 {
262 sliderSaturation->setEnabled( true );
263 spinBoxSaturation->setEnabled( true );
264 }
265 else
266 {
267 sliderSaturation->setEnabled( false );
268 spinBoxSaturation->setEnabled( false );
269 }
270 emit changed();
271}
272
273void QgsRendererRasterPropertiesWidget::toggleColorizeControls( bool colorizeEnabled )
274{
275 // Enable or disable colorize controls based on checkbox
276 btnColorizeColor->setEnabled( colorizeEnabled );
277 sliderColorizeStrength->setEnabled( colorizeEnabled );
278 spinColorizeStrength->setEnabled( colorizeEnabled );
279 emit changed();
280}
281
282void QgsRendererRasterPropertiesWidget::setRendererWidget( const QString &rendererName )
283{
284 QgsDebugMsgLevel( "rendererName = " + rendererName, 3 );
285 QgsRasterRendererWidget *oldWidget = mRendererWidget;
286
287 int alphaBand = -1;
288 double opacity = 1;
289 QColor nodataColor;
290 if ( QgsRasterRenderer *oldRenderer = mRasterLayer->renderer() )
291 {
292 // Retain alpha band and opacity when switching renderer
293 alphaBand = oldRenderer->alphaBand();
294 opacity = oldRenderer->opacity();
295 nodataColor = oldRenderer->nodataColor();
296 }
297
298 QgsRasterRendererRegistryEntry rendererEntry;
299 if ( QgsApplication::rasterRendererRegistry()->rendererData( rendererName, rendererEntry ) )
300 {
301 if ( rendererEntry.widgetCreateFunction ) // Single band color data renderer e.g. has no widget
302 {
303 QgsDebugMsgLevel( u"renderer has widgetCreateFunction"_s, 3 );
304 // Current canvas extent (used to calc min/max) in layer CRS
305 const QgsRectangle myExtent = QgsCoordinateTransform::isTransformationPossible( mRasterLayer->crs(), mMapCanvas->mapSettings().destinationCrs() )
306 ? mMapCanvas->mapSettings().outputExtentToLayerExtent( mRasterLayer, mMapCanvas->extent() )
307 : mRasterLayer->extent();
308 if ( oldWidget )
309 {
310 std::unique_ptr<QgsRasterRenderer> oldRenderer( oldWidget->renderer() );
311 if ( !oldRenderer || oldRenderer->type() != rendererName )
312 {
313 if ( rendererName == "singlebandgray"_L1 )
314 {
315 whileBlocking( mRasterLayer )
316 ->setRenderer( QgsApplication::rasterRendererRegistry()->defaultRendererForDrawingStyle( Qgis::RasterDrawingStyle::SingleBandGray, mRasterLayer->dataProvider() ).release() );
317 whileBlocking( mRasterLayer )->setDefaultContrastEnhancement();
318 }
319 else if ( rendererName == "multibandcolor"_L1 )
320 {
321 whileBlocking( mRasterLayer )
322 ->setRenderer( QgsApplication::rasterRendererRegistry()->defaultRendererForDrawingStyle( Qgis::RasterDrawingStyle::MultiBandColor, mRasterLayer->dataProvider() ).release() );
323 whileBlocking( mRasterLayer )->setDefaultContrastEnhancement();
324 }
325 }
326 }
327 mRasterLayer->renderer()->setAlphaBand( alphaBand );
328 mRasterLayer->renderer()->setOpacity( opacity );
329 mRasterLayer->renderer()->setNodataColor( nodataColor );
330 mRendererWidget = rendererEntry.widgetCreateFunction( mRasterLayer, myExtent );
331 mRendererWidget->setMapCanvas( mMapCanvas );
332 connect( mRendererWidget, &QgsRasterRendererWidget::widgetChanged, this, &QgsPanelWidget::changed );
333 stackedWidget->addWidget( mRendererWidget );
334 stackedWidget->setCurrentWidget( mRendererWidget );
335#if 0
336 if ( oldWidget )
337 {
338 // Compare used bands in new and old renderer and reset transparency dialog if different
339 std::unique_ptr< QgsRasterRenderer > oldRenderer( oldWidget->renderer() );
340 std::unique_ptr< QgsRasterRenderer > newRenderer( mRendererWidget->renderer() );
341 QList<int> oldBands = oldRenderer->usesBands();
342 QList<int> newBands = newRenderer->usesBands();
343
344 if ( oldBands != newBands )
345 {
346 populateTransparencyTable( newRenderer );
347 }
348 }
349#endif
350 }
351 }
352
353 if ( mRendererWidget != oldWidget )
354 delete oldWidget;
355
356 const int widgetIndex = cboRenderers->findData( rendererName );
357 if ( widgetIndex != -1 )
358 {
359 whileBlocking( cboRenderers )->setCurrentIndex( widgetIndex );
360 }
361}
362
363void QgsRendererRasterPropertiesWidget::refreshAfterStyleChanged()
364{
365 if ( mRendererWidget )
366 {
367 QgsRasterRenderer *renderer = mRasterLayer->renderer();
368 if ( QgsMultiBandColorRenderer *mbcr = dynamic_cast<QgsMultiBandColorRenderer *>( renderer ) )
369 {
370 const QgsContrastEnhancement *redCe = mbcr->redContrastEnhancement();
371 if ( redCe )
372 {
373 mRendererWidget->setMin( QLocale().toString( redCe->minimumValue() ), 0 );
374 mRendererWidget->setMax( QLocale().toString( redCe->maximumValue() ), 0 );
375 }
376 const QgsContrastEnhancement *greenCe = mbcr->greenContrastEnhancement();
377 if ( greenCe )
378 {
379 mRendererWidget->setMin( QLocale().toString( greenCe->minimumValue() ), 1 );
380 mRendererWidget->setMax( QLocale().toString( greenCe->maximumValue() ), 1 );
381 }
382 const QgsContrastEnhancement *blueCe = mbcr->blueContrastEnhancement();
383 if ( blueCe )
384 {
385 mRendererWidget->setMin( QLocale().toString( blueCe->minimumValue() ), 2 );
386 mRendererWidget->setMax( QLocale().toString( blueCe->maximumValue() ), 2 );
387 }
388 }
389 else if ( QgsSingleBandGrayRenderer *sbgr = dynamic_cast<QgsSingleBandGrayRenderer *>( renderer ) )
390 {
391 const QgsContrastEnhancement *ce = sbgr->contrastEnhancement();
392 if ( ce )
393 {
394 mRendererWidget->setMin( QLocale().toString( ce->minimumValue() ) );
395 mRendererWidget->setMax( QLocale().toString( ce->maximumValue() ) );
396 }
397 }
398 }
399}
400
401void QgsRendererRasterPropertiesWidget::updateGammaSpinBox( int value )
402{
403 mGammaSpinBox->setValue( value / 100.0 );
404}
405
406void QgsRendererRasterPropertiesWidget::updateGammaSlider( double value )
407{
408 mSliderGamma->setValue( value * 100 );
409}
@ SingleBandColorData
Single band containing color data.
Definition qgis.h:5334
@ SingleBandGray
A single band image drawn as a range of gray colors.
Definition qgis.h:5348
@ MultiBandColor
A layer containing 2 or more bands, mapped to RGB color space. In the case of a multiband with only t...
Definition qgis.h:5356
static QgsRasterRendererRegistry * rasterRendererRegistry()
Returns the application's raster renderer registry, used for managing raster layer renderers.
Brightness/contrast and gamma correction filter pipe for rasters.
void colorChanged(const QColor &color)
Emitted whenever a new color is set for the button.
double minimumValue() const
Returns the minimum value for the contrast enhancement range.
double maximumValue() const
Returns the maximum value for the contrast enhancement range.
static bool isTransformationPossible(const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination)
Returns true if it is theoretically possible to transform between source and destination CRSes.
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
Factory method to create the renderer for this type.
Color and saturation filter pipe for rasters.
Map canvas is a class for displaying all GIS data types on a canvas.
QgsMapLayerConfigWidget(QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
A panel widget that can be shown in the map style dock.
QgsMapLayer * layer()
Returns the layer the widget is associated with.
Base class for all map layer types.
Definition qgsmaplayer.h:84
void styleChanged()
Signal emitted whenever a change affects the layer's style.
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
void changed()
Emitted when the widget state changes.
static bool layerIsContainedInGroupLayer(QgsProject *project, QgsMapLayer *layer)
Returns true if the specified layer is a child layer from any QgsGroupLayer in the given project.
static QgsProject * instance()
Returns the QgsProject singleton instance.
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
Widget creation function (mainly for the use by the renderer registry).
Represents a raster layer.
void insertWidgetFunction(const QString &rendererName, QgsRasterRendererWidgetCreateFunc func)
Sets the widget creation function for a renderer.
QStringList renderersList() const
Returns a list of the names of registered renderers.
Abstract base class for widgets which configure a QgsRasterRenderer.
virtual QgsRasterRenderer * renderer()=0
Creates a new renderer, using the properties defined in the widget.
void widgetChanged()
Emitted when something on the widget has changed.
Raster renderer pipe that applies colors to a raster.
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
Widget creation function (use by the renderer registry).
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
Widget creation function (mainly for the use by the renderer registry).
void rendererChanged()
called when user changes renderer type
QgsRendererRasterPropertiesWidget(QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
A widget to hold the renderer properties for a raster layer.
void syncToLayer(QgsRasterLayer *layer)
Sync the widget to the given layer.
void setMapCanvas(QgsMapCanvas *canvas)
Sets the map canvas associated with the dialog.
void apply() override
Apply the changes from the dialog to the layer.
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
static QgsRasterRendererWidget * create(QgsRasterLayer *layer, const QgsRectangle &extent)
Creates new raster renderer widget.
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
Definition qgis.h:7705
#define QgsDebugMsgLevel(str, level)
Definition qgslogger.h:80
Registry for raster renderer entries.
QgsRasterRendererWidgetCreateFunc widgetCreateFunction