SHAPER  9.12.0
ModelAPI_AttributeImage.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 ModelAPI_AttributeImage_H_
21 #define ModelAPI_AttributeImage_H_
22 
23 #include <ModelAPI.h>
24 #include <ModelAPI_Attribute.h>
25 
26 #include <string>
27 #include <list>
28 
29 
37 {
38  public:
40  MODELAPI_EXPORT virtual void setTexture(const int theWidth,
41  const int theHeight,
42  const std::list<unsigned char>& theByteArray,
43  const std::string& theFormat,
44  const bool sendUpdated = true) = 0;
45 
47  MODELAPI_EXPORT virtual bool hasTexture() = 0;
48 
50  MODELAPI_EXPORT virtual bool texture(int& theWidth,
51  int& theHeight,
52  std::list<unsigned char>& theByteArray,
53  std::string& theFormat) = 0;
54 
56  virtual void copyTo(std::shared_ptr<ModelAPI_AttributeImage> theTarget) const = 0;
57 
59  MODELAPI_EXPORT static std::string typeId()
60  {
61  return "Image";
62  }
63 
65  MODELAPI_EXPORT virtual std::string attributeType();
66 
68  MODELAPI_EXPORT virtual ~ModelAPI_AttributeImage();
69 
70  protected:
72  MODELAPI_EXPORT ModelAPI_AttributeImage();
73 };
74 
76 typedef std::shared_ptr<ModelAPI_AttributeImage> AttributeImagePtr;
77 
78 #endif
API for the attribute that contains binary data.
Definition: ModelAPI_AttributeImage.h:37
virtual MODELAPI_EXPORT ~ModelAPI_AttributeImage()
To virtually destroy the fields of successors.
Definition: ModelAPI_AttributeImage.cpp:29
virtual MODELAPI_EXPORT void setTexture(const int theWidth, const int theHeight, const std::list< unsigned char > &theByteArray, const std::string &theFormat, const bool sendUpdated=true)=0
Defines the value of the image attribute.
virtual MODELAPI_EXPORT std::string attributeType()
Returns the type of this class of attributes, not static method.
Definition: ModelAPI_AttributeImage.cpp:23
virtual MODELAPI_EXPORT bool texture(int &theWidth, int &theHeight, std::list< unsigned char > &theByteArray, std::string &theFormat)=0
Returns the value of the image attribute.
virtual MODELAPI_EXPORT bool hasTexture()=0
Returns true, if texture width and height are non-zero.
MODELAPI_EXPORT ModelAPI_AttributeImage()
Objects are created for features automatically.
Definition: ModelAPI_AttributeImage.cpp:33
virtual void copyTo(std::shared_ptr< ModelAPI_AttributeImage > theTarget) const =0
Copy the image data to the destination attribute.
static MODELAPI_EXPORT std::string typeId()
Returns the type of this class of attributes.
Definition: ModelAPI_AttributeImage.h:59
Generic attribute of the Object.
Definition: ModelAPI_Attribute.h:34