src/Model/Model_AttributeImage.h

   1 // Copyright (C) 2014-2021  CEA/DEN, EDF R&D
   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 MODEL_ATTRIBUTEIMAGE_H_
  21 #define MODEL_ATTRIBUTEIMAGE_H_
  22
  23 #include <Model.h>
  24 #include <ModelAPI_AttributeImage.h>
  25
  26 #include <TDF_Label.hxx>
  27
  28 #include <string>
  29
  30 /**\class Model_AttributeImage
  31  * \ingroup DataModel
  32  * \brief API for the attribute that contains image inside.
  33  * Represented as the following OCCT attributes:
  34  *   TDataStd_ByteArray for the pixmap texture data,
  35  *   TDataStd_IntArray(2) for image dimensions (widht and height),
  36  *   TDataStd_String for image format.
  37  */
  38
  39 class Model_AttributeImage : public ModelAPI_AttributeImage
  40 {
  41   /// Stores the label as the only reference to all data
  42   TDF_Label myLab;
  43
  44  public:
  45   /// Defines the value of the image attribute
  46   MODEL_EXPORT virtual void setTexture(const int theWidth,
  47                                        const int theHeight,
  48                                        const std::list<unsigned char>& theByteArray,
  49                                        const std::string& theFormat,
  50                                        const bool sendUpdated = true);
  51
  52   /// Returns true, if texture width and height are non-zero
  53   MODEL_EXPORT virtual bool hasTexture();
  54
  55   /// Returns the value of the image attribute
  56   MODEL_EXPORT virtual bool texture(int& theWidth,
  57                                     int& theHeight,
  58                                     std::list<unsigned char>& theByteArray,
  59                                     std::string& theFormat);
  60
  61   /// Copy the image data to the destination attribute
  62   virtual void copyTo(std::shared_ptr<ModelAPI_AttributeImage> theTarget) const;
  63
  64  protected:
  65   /// Initializes attibutes
  66   Model_AttributeImage(TDF_Label& theLabel);
  67   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  68   virtual void reinit();
  69
  70   friend class Model_Data;
  71 };
  72
  73 #endif