qgsrastertransparencywidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsrastertransparencywidget.h
    ---------------------
    begin                : May 2016
    copyright            : (C) 2016 by Nathan Woodrow
    email                : woodrow dot nathan at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSRASTERTRANSPARENCYWIDGET_H
#define QGSRASTERTRANSPARENCYWIDGET_H
 
#include "ui_qgsrastertransparencywidget.h"
 
#include "qgis_gui.h"
#include "qgsmaplayerconfigwidget.h"
#include "qgsrasterpipe.h"
#include "qgssymbolwidgetcontext.h"
 
#include <QWidget>
 
class QgsRasterLayer;
class QgsRasterRenderer;
class QgsMapCanvas;
class QgsMapToolEmitPoint;
class QgsPointXY;

class GUI_EXPORT QgsRasterTransparencyWidget : public QgsMapLayerConfigWidget, private QgsExpressionContextGenerator, public Ui::QgsRasterTransparencyWidget
{
    Q_OBJECT
  public:

    QgsRasterTransparencyWidget( QgsRasterLayer *layer, QgsMapCanvas *canvas, QWidget *parent = nullptr );

    void setContext( const QgsSymbolWidgetContext &context );
 
    QgsExpressionContext createExpressionContext() const override;

    QgsMapToolEmitPoint *pixelSelectorTool() const;

    void applyToRasterProvider( QgsRasterDataProvider *provider ) SIP_SKIP;

    void applyToRasterRenderer( QgsRasterRenderer *renderer ) SIP_SKIP;
 
  public slots:
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Woverloaded-virtual"
#endif

    void syncToLayer();
#ifdef __clang__
#pragma clang diagnostic pop
#endif

    void apply() override;
 
  protected:
#ifndef SIP_RUN
 
    // TODO -- consider moving these to a common raster widget base class

    void initializeDataDefinedButton( QgsPropertyOverrideButton *button, QgsRasterPipe::Property key );

    void updateDataDefinedButtons();

    void updateDataDefinedButton( QgsPropertyOverrideButton *button );

    QgsPropertyCollection mPropertyCollection;
 
#endif
 
  private slots:
 
    void updateProperty();
 
    void pixelSelected( const QgsPointXY &canvasPoint );

    void transparencyCellTextEdited( const QString &text );

    void pbnAddValuesFromDisplay_clicked();

    void pbnAddValuesManually_clicked();

    void pbnDefaultValues_clicked();

    void pbnExportTransparentPixelValues_clicked();

    void pbnImportTransparentPixelValues_clicked();
    void pbnRemoveSelectedRow_clicked();
 
  private:
    const QString TRSTRING_NOT_SET;
 
    enum class Mode : int
    {
      SingleBand = 0,
      RgbBands
    };
 
    enum class RgbBandTableColumns : int
    {
      Red = 0,
      Green = 1,
      Blue = 2,
      Tolerance = 3,
      Opacity = 4,
      ColumnCount = Opacity + 1
    };
 
    enum class SingleBandTableColumns : int
    {
      From = 0,
      To = 1,
      Opacity = 2,
      ColumnCount = Opacity + 1
    };

    void populateTransparencyTable( QgsRasterRenderer *renderer );
 
    void setupTransparencyTable( int nBands );
 
    void setTransparencyCell( int row, int column, double value );
 
    void adjustTransparencyCellWidth( int row, int column );
 
    void setTransparencyToEdited( int row );
 
    double transparencyCellValue( int row, int column );
 
    Mode mCurrentMode = Mode::RgbBands;
 
    QgsRasterLayer *mRasterLayer = nullptr;
 
    QgsMapCanvas *mMapCanvas = nullptr;
 
    QgsMapToolEmitPoint *mPixelSelectorTool = nullptr;
 
    QVector<bool> mTransparencyToEdited;

    QgsSymbolWidgetContext mContext;
};
#endif // QGSRASTERTRANSPARENCYWIDGET_H