qgsrastertransparency.h

Go to the documentation of this file.

/***************************************************************************
                qgsrastertransparency.h -  description
                       -------------------
begin                : Mon Nov 30 2007
copyright            : (C) 2007 by Peter J. Ersts
email                : ersts@amnh.org
 
****************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSRASTERTRANSPARENCY_H
#define QGSRASTERTRANSPARENCY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QList>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QDomDocument;
class QDomElement;

class CORE_EXPORT QgsRasterTransparency
{
  public:
    QgsRasterTransparency() = default;

    struct TransparentThreeValuePixel
    {
        TransparentThreeValuePixel(
          double red = 0,
          double green = 0,
          double blue = 0,
          double opacity = 0,
          double fuzzyToleranceRed = 4 * std::numeric_limits<double>::epsilon(),
          double fuzzyToleranceGreen = 4 * std::numeric_limits<double>::epsilon(),
          double fuzzyToleranceBlue = 4 * std::numeric_limits<double>::epsilon()
        )
          : red( red )
          , green( green )
          , blue( blue )
          , opacity( opacity )
          , fuzzyToleranceRed( fuzzyToleranceRed )
          , fuzzyToleranceGreen( fuzzyToleranceGreen )
          , fuzzyToleranceBlue( fuzzyToleranceBlue )
        {}

        double red;

        double green;

        double blue;

        double opacity = 0;

#ifndef SIP_RUN
        double fuzzyToleranceRed = 4 * std::numeric_limits<double>::epsilon();
#else
        double fuzzyToleranceRed;
#endif

#ifndef SIP_RUN
        double fuzzyToleranceGreen = 4 * std::numeric_limits<double>::epsilon();
#else
        double fuzzyToleranceGreen;
#endif

#ifndef SIP_RUN
        double fuzzyToleranceBlue = 4 * std::numeric_limits<double>::epsilon();
#else
        double fuzzyToleranceBlue;
#endif
 
        bool operator==( const QgsRasterTransparency::TransparentThreeValuePixel &other ) const
        {
          return qgsDoubleNear( red, other.red )
                 && qgsDoubleNear( green, other.green )
                 && qgsDoubleNear( blue, other.blue )
                 && qgsDoubleNear( opacity, other.opacity )
                 && qgsDoubleNear( fuzzyToleranceRed, other.fuzzyToleranceRed )
                 && qgsDoubleNear( fuzzyToleranceGreen, other.fuzzyToleranceGreen )
                 && qgsDoubleNear( fuzzyToleranceBlue, other.fuzzyToleranceBlue );
        }
        bool operator!=( const QgsRasterTransparency::TransparentThreeValuePixel &other ) const { return !( *this == other ); }
 
#ifdef SIP_RUN
        // clang-format off
      SIP_PYOBJECT __repr__();
      % MethodCode
      QString str;
      if ( !qgsDoubleNear( sipCpp->fuzzyToleranceRed, 0 ) || !qgsDoubleNear( sipCpp->fuzzyToleranceGreen, 0 ) || !qgsDoubleNear( sipCpp->fuzzyToleranceBlue, 0 ) )
        str = u"<QgsRasterTransparency.TransparentThreeValuePixel: %1, %2, %3, %4, %5, %6, %7>"_s.arg( sipCpp->red ).arg( sipCpp->green ).arg( sipCpp->blue ).arg( sipCpp->opacity ).arg( sipCpp->fuzzyToleranceRed ).arg( sipCpp->fuzzyToleranceGreen ).arg( sipCpp->fuzzyToleranceBlue );
      else
        str = u"<QgsRasterTransparency.TransparentThreeValuePixel: %1, %2, %3, %4>"_s.arg( sipCpp->red ).arg( sipCpp->green ).arg( sipCpp->blue ).arg( sipCpp->opacity );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
      % End
// clang-format on
#endif
    };

    struct TransparentSingleValuePixel
    {
        TransparentSingleValuePixel( double minimum = 0, double maximum = 0, double opacity = 0, bool includeMinimum = true, bool includeMaximum = true )
          : min( minimum )
          , max( maximum )
          , opacity( opacity )
          , includeMinimum( includeMinimum )
          , includeMaximum( includeMaximum )
        {}

        double min;

        double max;

        double opacity = 0;

        bool includeMinimum = true;

        bool includeMaximum = true;
 
        bool operator==( const QgsRasterTransparency::TransparentSingleValuePixel &other ) const
        {
          return qgsDoubleNear( min, other.min )
                 && qgsDoubleNear( max, other.max )
                 && qgsDoubleNear( opacity, other.opacity )
                 && includeMinimum == other.includeMinimum
                 && includeMaximum == other.includeMaximum;
        }
        bool operator!=( const QgsRasterTransparency::TransparentSingleValuePixel &other ) const { return !( *this == other ); }
 
#ifdef SIP_RUN
        // clang-format off
      SIP_PYOBJECT __repr__();
      % MethodCode
      const QString str = u"<QgsRasterTransparency.TransparentSingleValuePixel: %1, %2, %3>"_s.arg( sipCpp->min ).arg( sipCpp->max ).arg( sipCpp->opacity );
      sipRes = PyUnicode_FromString( str.toUtf8().constData() );
      % End
// clang-format on
#endif
    };

    QVector<QgsRasterTransparency::TransparentSingleValuePixel> transparentSingleValuePixelList() const;

    QVector<QgsRasterTransparency::TransparentThreeValuePixel> transparentThreeValuePixelList() const;

    void initializeTransparentPixelList( double value );

    void initializeTransparentPixelList( double redValue, double greenValue, double blueValue );

    void setTransparentSingleValuePixelList( const QVector<QgsRasterTransparency::TransparentSingleValuePixel> &newList );

    void setTransparentThreeValuePixelList( const QVector<QgsRasterTransparency::TransparentThreeValuePixel> &newList );

    Q_DECL_DEPRECATED int alphaValue( double value, int globalTransparency = 255 ) const SIP_DEPRECATED;

    double opacityForValue( double value ) const;

    Q_DECL_DEPRECATED int alphaValue( double redValue, double greenValue, double blueValue, int globalTransparency = 255 ) const SIP_DEPRECATED;

    double opacityForRgbValues( double redValue, double greenValue, double blueValue ) const;

    bool isEmpty() const;

    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;

    void readXml( const QDomElement &elem );
 
  private:
    QVector<QgsRasterTransparency::TransparentThreeValuePixel> mTransparentThreeValuePixelList;

    QVector<QgsRasterTransparency::TransparentSingleValuePixel> mTransparentSingleValuePixelList;
};
#endif