SHAPER  9.12.0
BuildAPI_Edge.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 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 
31 
36 {
37 public:
39  BUILDAPI_EXPORT
40  explicit BuildAPI_Edge(const std::shared_ptr<ModelAPI_Feature>& theFeature);
41 
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 
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 
55  BUILDAPI_EXPORT
56  virtual ~BuildAPI_Edge();
57 
58  INTERFACE_5(BuildPlugin_Edge::ID(),
69 
70 
71  BUILDAPI_EXPORT
72  void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
73 
75  BUILDAPI_EXPORT
76  virtual void dump(ModelHighAPI_Dumper& theDumper) const;
77 };
78 
80 typedef std::shared_ptr<BuildAPI_Edge> EdgePtr;
81 
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);
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_
Interface for Edge feature.
Definition: BuildAPI_Edge.h:36
virtual std::shared_ptr< ModelAPI_AttributeSelection > firstPoint() const
First point.
Definition: BuildAPI_Edge.h:68
void setBase(const std::list< ModelHighAPI_Selection > &theBaseObjects)
Modify base attribute of the feature.
Definition: BuildAPI_Edge.cpp:67
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > baseObjects() const
Base objects.
Definition: BuildAPI_Edge.h:68
virtual std::shared_ptr< ModelAPI_AttributeSelection > secondPoint() const
Second point.
Definition: BuildAPI_Edge.h:68
virtual std::shared_ptr< ModelAPI_AttributeString > creationMethod() const
Creation method.
Definition: BuildAPI_Edge.h:68
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: BuildAPI_Edge.cpp:75
virtual std::shared_ptr< ModelAPI_AttributeBoolean > computeIntersections() const
Intersect edges.
Definition: BuildAPI_Edge.h:68
BuildAPI_Edge(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: BuildAPI_Edge.cpp:26
virtual ~BuildAPI_Edge()
Destructor.
Definition: BuildAPI_Edge.cpp:61
static const std::string & INTERSECT_ID()
Attribute name of "Compute intersections" checkbox.
Definition: BuildPlugin_Edge.h:93
static const std::string & SECOND_POINT()
Attribute name for the second point.
Definition: BuildPlugin_Edge.h:86
static const std::string & ID()
Feature kind.
Definition: BuildPlugin_Edge.h:37
static const std::string & CREATION_METHOD()
Attribute name for creation method.
Definition: BuildPlugin_Edge.h:58
static const std::string & FIRST_POINT()
Attribute name for the first point.
Definition: BuildPlugin_Edge.h:79
static const std::string & BASE_OBJECTS_ID()
Attribute name of base objects.
Definition: BuildPlugin_Edge.h:44
Attribute that contains boolean value.
Definition: ModelAPI_AttributeBoolean.h:31
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
Attribute that contains reference to the sub-shape of some result, the selected shape.
Definition: ModelAPI_AttributeSelection.h:35
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
EdgePtr addEdge(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theBaseObjects, const bool theComputeIntersection=false)
Create Edge feature.
Definition: BuildAPI_Edge.cpp:99