]> SALOME platform Git repositories - modules/shaper.git/blob - src/BuildAPI/BuildAPI_Edge.h
Salome HOME
Task 3.10. BuildEdge from two points
[modules/shaper.git] / src / BuildAPI / BuildAPI_Edge.h
1 // Copyright (C) 2014-2019  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
47   /// Constructor by points.
48   BUILDAPI_EXPORT
49   explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature,
50                          const ModelHighAPI_Selection& theFirstPoint,
51                          const ModelHighAPI_Selection& theSecondPoint);
52
53   /// Destructor.
54   BUILDAPI_EXPORT
55   virtual ~BuildAPI_Edge();
56
57   INTERFACE_4(BuildPlugin_Edge::ID(),
58               baseObjects, BuildPlugin_Edge::BASE_OBJECTS_ID(),
59               ModelAPI_AttributeSelectionList, /** Base objects */,
60               creationMethod, BuildPlugin_Edge::CREATION_METHOD(),
61               ModelAPI_AttributeString, /** Creation method */,
62               firstPoint, BuildPlugin_Edge::FIRST_POINT(),
63               ModelAPI_AttributeSelection, /** First point */,
64               secondPoint, BuildPlugin_Edge::SECOND_POINT(),
65               ModelAPI_AttributeSelection, /** Second point */)
66
67   /// Modify base attribute of the feature.
68   BUILDAPI_EXPORT
69   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
70
71   /// Dump wrapped feature
72   BUILDAPI_EXPORT
73   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
74 };
75
76 /// Pointer on Edge object.
77 typedef std::shared_ptr<BuildAPI_Edge> EdgePtr;
78
79 /// \ingroup CPPHighAPI
80 /// \brief Create Edge feature.
81 BUILDAPI_EXPORT
82 EdgePtr addEdge(const std::shared_ptr<ModelAPI_Document>& thePart,
83                 const std::list<ModelHighAPI_Selection>& theBaseObjects);
84 /// \ingroup CPPHighAPI
85 /// \brief Create Edge feature.
86 BUILDAPI_EXPORT
87 EdgePtr addEdge(const std::shared_ptr<ModelAPI_Document>& thePart,
88                 const ModelHighAPI_Selection& theFirstPoint,
89                 const ModelHighAPI_Selection& theSecondPoint);
90
91 #endif // BuildAPI_Edge_H_