Salome HOME
2a9177783b35373e4f0282fc7a85d45678f2f8d5
[modules/shaper.git] / src / BuildAPI / BuildAPI_Wire.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_Wire_H_
21 #define BuildAPI_Wire_H_
22
23 #include "BuildAPI.h"
24
25 #include <BuildPlugin_Wire.h>
26
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29
30 class ModelHighAPI_Selection;
31
32 /// \class BuildAPI_Wire
33 /// \ingroup CPPHighAPI
34 /// \brief Interface for Wire feature.
35 class BuildAPI_Wire: public ModelHighAPI_Interface
36 {
37 public:
38   /// Constructor without values.
39   BUILDAPI_EXPORT
40   explicit BuildAPI_Wire(const std::shared_ptr<ModelAPI_Feature>& theFeature);
41
42   /// Constructor with values.
43   BUILDAPI_EXPORT
44   explicit BuildAPI_Wire(const std::shared_ptr<ModelAPI_Feature>& theFeature,
45                          const std::list<ModelHighAPI_Selection>& theBaseObjects,
46                          const bool theComputeIntersections = false);
47
48   /// Destructor.
49   BUILDAPI_EXPORT
50   virtual ~BuildAPI_Wire();
51
52   INTERFACE_2(BuildPlugin_Wire::ID(),
53               baseObjects, BuildPlugin_Wire::BASE_OBJECTS_ID(),
54               ModelAPI_AttributeSelectionList, /** Base objects */,
55               computeIntersections, BuildPlugin_Wire::INTERSECT_ID(),
56               ModelAPI_AttributeBoolean, /** Intersect edges */)
57
58   /// Modify base attribute of the feature.
59   BUILDAPI_EXPORT
60   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
61
62   /// Adds closed contour.
63   BUILDAPI_EXPORT
64   void addContour();
65
66   /// Dump wrapped feature
67   BUILDAPI_EXPORT
68   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
69 };
70
71 /// Pointer on Wire object.
72 typedef std::shared_ptr<BuildAPI_Wire> WirePtr;
73
74 /// \ingroup CPPHighAPI
75 /// \brief Create Wire feature.
76 BUILDAPI_EXPORT
77 WirePtr addWire(const std::shared_ptr<ModelAPI_Document>& thePart,
78                 const std::list<ModelHighAPI_Selection>& theBaseObjects,
79                 const bool theComputeIntersections = false);
80
81 #endif // BuildAPI_Wire_H_