src/ImageComposer/ImageComposer_ColorMaskOperator.h

   1 // Copyright (C) 2013-2024  CEA, EDF, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef IMAGE_COMPOSER_COLOR_MASK_OPERATOR_HEADER
  21 #define IMAGE_COMPOSER_COLOR_MASK_OPERATOR_HEADER
  22
  23 #include "ImageComposer_Operator.h"
  24 #include <QColor>
  25
  26 /**
  27   \class ImageComposer_ColorMaskOperator
  28   Implementation of the color mask operator
  29 */
  30 class IMAGE_COMPOSER_API ImageComposer_ColorMaskOperator : public ImageComposer_Operator
  31 {
  32 public:
  33   ImageComposer_ColorMaskOperator();
  34   virtual ~ImageComposer_ColorMaskOperator();
  35
  36   void setArgs( const QColor& theRefColor,
  37                 bool isMakeTransparent,
  38                 int theRGBThreshold,
  39                 int theAlphaThreshold );
  40
  41   static QString Type() { return "colormask"; }
  42
  43   virtual QString name() const;
  44
  45   /**
  46     Dumps arguments of operator to python script representation
  47     @param theArrayName name of result \c QByteArray array variable
  48     @return list of strings with python representation
  49   **/
  50   QStringList dumpArgsToPython( QString& theArrayName ) const;
  51
  52 protected:
  53   virtual QRectF calcResultBoundingRect( const QVariant& theObj1,
  54                                          const QVariant& theObj2 ) const;
  55   virtual void drawResult( QPainter& thePainter, const QVariant& theObj1,
  56                                                  const QVariant& theObj2 ) const;
  57
  58   virtual void storeArgs( QDataStream& theStream ) const;
  59   virtual void restoreArgs( QDataStream& theStream );
  60
  61 private:
  62   friend class ImageComposerTests_TestOperators;
  63
  64   QColor myRefColor;         ///< the color to the searched (the color for mask)
  65   bool myIsMakeTransparent;  ///< the boolean flag controlling if the pixels with matching color
  66                              ///< should be made transparent or one with non-matching color
  67   int myRGBThreshold;        ///< the threshold for RGB components
  68   int myAlphaThreshold;      ///< the threshold for Alpha component
  69 };
  70
  71 #endif