src/BuildAPI/BuildAPI_Edge.h

   1 // Copyright (C) 2014-2023  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 BuildAPI_Edge_H_
  21 #define BuildAPI_Edge_H_
  22
  23 #include "BuildAPI.h"
  24
  25 #include <BuildPlugin_Edge.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Selection;
  31
  32 /// \class BuildAPI_Edge
  33 /// \ingroup CPPHighAPI
  34 /// \brief Interface for Edge feature.
  35 class BuildAPI_Edge: public ModelHighAPI_Interface
  36 {
  37 public:
  38   /// Constructor without values.
  39   BUILDAPI_EXPORT
  40   explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  41
  42   /// Constructor with values.
  43   BUILDAPI_EXPORT
  44   explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  45                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
  46                          const bool theComputeIntersections = false);
  47
  48   /// Constructor by points.
  49   BUILDAPI_EXPORT
  50   explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  51                          const ModelHighAPI_Selection& theFirstPoint,
  52                          const ModelHighAPI_Selection& theSecondPoint);
  53
  54   /// Destructor.
  55   BUILDAPI_EXPORT
  56   virtual ~BuildAPI_Edge();
  57
  58   INTERFACE_5(BuildPlugin_Edge::ID(),
  59               baseObjects, BuildPlugin_Edge::BASE_OBJECTS_ID(),
  60               ModelAPI_AttributeSelectionList, /** Base objects */,
  61               creationMethod, BuildPlugin_Edge::CREATION_METHOD(),
  62               ModelAPI_AttributeString, /** Creation method */,
  63               firstPoint, BuildPlugin_Edge::FIRST_POINT(),
  64               ModelAPI_AttributeSelection, /** First point */,
  65               secondPoint, BuildPlugin_Edge::SECOND_POINT(),
  66               ModelAPI_AttributeSelection, /** Second point */,
  67               computeIntersections, BuildPlugin_Edge::INTERSECT_ID(),
  68               ModelAPI_AttributeBoolean, /** Intersect edges */)
  69
  70   /// Modify base attribute of the feature.
  71   BUILDAPI_EXPORT
  72   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
  73
  74   /// Dump wrapped feature
  75   BUILDAPI_EXPORT
  76   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  77 };
  78
  79 /// Pointer on Edge object.
  80 typedef std::shared_ptr<BuildAPI_Edge> EdgePtr;
  81
  82 /// \ingroup CPPHighAPI
  83 /// \brief Create Edge feature.
  84 BUILDAPI_EXPORT
  85 EdgePtr addEdge(const std::shared_ptr<ModelAPI_Document>& thePart,
  86                 const std::list<ModelHighAPI_Selection>& theBaseObjects,
  87                 const bool theComputeIntersection = false);
  88 /// \ingroup CPPHighAPI
  89 /// \brief Create Edge feature.
  90 BUILDAPI_EXPORT
  91 EdgePtr addEdge(const std::shared_ptr<ModelAPI_Document>& thePart,
  92                 const ModelHighAPI_Selection& theFirstPoint,
  93                 const ModelHighAPI_Selection& theSecondPoint);
  94
  95 #endif // BuildAPI_Edge_H_