src/GeomDataAPI/GeomDataAPI_Point2DArray.h

   1 // Copyright (C) 2019-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 GeomDataAPI_Point2DArray_H_
  21 #define GeomDataAPI_Point2DArray_H_
  22
  23 #include <GeomDataAPI.h>
  24 #include <ModelAPI_Attribute.h>
  25
  26 class GeomAPI_Pnt2d;
  27
  28 /**\class GeomDataAPI_Point2DArray
  29  * \ingroup DataModel
  30  * \brief Attribute that contains array of 2D point coordinates.
  31  */
  32
  33 class GeomDataAPI_Point2DArray : public ModelAPI_Attribute
  34 {
  35 public:
  36   /// Copy values from another array
  37   /// \return \c true if the copy was successful
  38   GEOMDATAAPI_EXPORT virtual bool assign(std::shared_ptr<GeomDataAPI_Point2DArray> theOther) = 0;
  39
  40   /// Returns the size of the array (zero means that it is empty)
  41   GEOMDATAAPI_EXPORT virtual int size() = 0;
  42
  43   /// Sets the new size of the array. The previous data is erased.
  44   GEOMDATAAPI_EXPORT virtual void setSize(const int theSize) = 0;
  45
  46   /// Defines the value of the array by index [0; size-1]
  47   GEOMDATAAPI_EXPORT virtual void setPnt(const int theIndex,
  48                                          const double theX, const double theY) = 0;
  49
  50   /// Defines the value of the array by index [0; size-1]
  51   GEOMDATAAPI_EXPORT virtual void setPnt(const int theIndex,
  52                                          const std::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
  53
  54   /// Returns the value by the index
  55   GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt2d> pnt(const int theIndex) = 0;
  56
  57   /// Returns the type of this class of attributes
  58   static std::string typeId()
  59   {
  60     return std::string("Point2DArray");
  61   }
  62
  63   /// Returns the type of this class of attributes, not static method
  64   GEOMDATAAPI_EXPORT virtual std::string attributeType();
  65
  66 protected:
  67   /// Objects are created for features automatically
  68   GEOMDATAAPI_EXPORT GeomDataAPI_Point2DArray();
  69   GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point2DArray();
  70 };
  71
  72 typedef std::shared_ptr<GeomDataAPI_Point2DArray> AttributePoint2DArrayPtr;
  73
  74 #endif