src/ImageComposer/ImageComposer_Operator.h

   1 // Copyright (C) 2013-2022  CEA/DEN, EDF R&D, 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_OPERATOR_HEADER
  21 #define IMAGE_COMPOSER_OPERATOR_HEADER
  22
  23 #include "ImageComposer.h"
  24
  25 #include <QColor>
  26
  27 class QString;
  28 class QRectF;
  29 class QPainter;
  30 class QTransform;
  31 class QVariant;
  32 class ImageComposer_Image;
  33
  34 const QColor TRANSPARENT( 255, 255, 255, 0 );
  35
  36 /**
  37   \class ImageComposer_Operator
  38   Implementation of the base abstract operation for image composing
  39 */
  40 class IMAGE_COMPOSER_API ImageComposer_Operator
  41 {
  42 public:
  43   ImageComposer_Operator();
  44   virtual ~ImageComposer_Operator();
  45
  46   void getArgs( QColor& theBackground ) const;
  47   void setArgs( const QColor& theBackground );
  48
  49   QByteArray getBinArgs() const;
  50   void setBinArgs( const QByteArray& );
  51
  52   /**
  53     Dumps arguments of operator to python script representation
  54     @param theArrayName name of result \c QByteArray array variable
  55     @return list of strings with python representation
  56   **/
  57   QStringList dumpArgsToPython( QString& theArrayName ) const;
  58
  59   /**
  60     Return name of the operator.
  61     @return name of the operator
  62   */
  63   virtual QString name() const = 0;
  64
  65   virtual ImageComposer_Image process( const QVariant& theObj1,
  66                                        const QVariant& theObj2 ) const;
  67
  68 protected:
  69   /**
  70     Calculate bounding rectangle for the result image
  71     @param theObj1 first object to calculate
  72     @param theObj2 second object to calculate
  73     @return calculated bounding rectangle
  74   */
  75   virtual QRectF calcResultBoundingRect( const QVariant& theObj1,
  76                                          const QVariant& theObj2 ) const = 0;
  77
  78   /**
  79     Draw result image using the given painter
  80     @param thePainter the painter on the result image
  81     @param theObj1 the first object to compose
  82     @param theObj2 the second object to compose
  83   */
  84   virtual void drawResult( QPainter& thePainter, const QVariant& theObj1,
  85                                                  const QVariant& theObj2 ) const = 0;
  86
  87   virtual void storeArgs( QDataStream& theStream ) const;
  88   virtual void restoreArgs( QDataStream& theStream );
  89
  90 private:
  91   friend class ImageComposerTests_TestOperators;
  92
  93   QColor myBackground;  ///< the background color for result image
  94 };
  95
  96 #endif