]> SALOME platform Git repositories - modules/shaper.git/blob - src/BuildPlugin/BuildPlugin_Edge.h
Salome HOME
bos #20661 EDF 22847 - Move to the end
[modules/shaper.git] / src / BuildPlugin / BuildPlugin_Edge.h
1 // Copyright (C) 2014-2020  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 BuildPlugin_Edge_H_
21 #define BuildPlugin_Edge_H_
22
23 #include "BuildPlugin.h"
24
25 #include <ModelAPI_Feature.h>
26
27 /// \class BuildPlugin_Edge
28 /// \ingroup Plugins
29 /// \brief Feature for creation of edge from sketch edge or existing edges.
30 class BuildPlugin_Edge: public ModelAPI_Feature
31 {
32 public:
33   /// Use plugin manager for features creation
34   BuildPlugin_Edge();
35
36   /// Feature kind.
37   inline static const std::string& ID()
38   {
39     static const std::string MY_ID("Edge");
40     return MY_ID;
41   }
42
43   /// Attribute name of base objects.
44   inline static const std::string& BASE_OBJECTS_ID()
45   {
46     static const std::string MY_BASE_OBJECTS_ID("base_objects");
47     return MY_BASE_OBJECTS_ID;
48   }
49
50   /// \return the kind of a feature.
51   BUILDPLUGIN_EXPORT virtual const std::string& getKind()
52   {
53     static std::string MY_KIND = BuildPlugin_Edge::ID();
54     return MY_KIND;
55   }
56
57   /// Attribute name for creation method.
58   inline static const std::string& CREATION_METHOD()
59   {
60     static const std::string MY_CREATION_METHOD_ID("creation_method");
61     return MY_CREATION_METHOD_ID;
62   }
63
64   /// Value for creation method.
65   inline static const std::string& CREATION_BY_SEGMENTS()
66   {
67     static const std::string MY_CREATION_METHOD_ID("by_segments");
68     return MY_CREATION_METHOD_ID;
69   }
70
71   /// Value for creation method.
72   inline static const std::string& CREATION_BY_POINTS()
73   {
74     static const std::string MY_CREATION_METHOD_ID("by_points");
75     return MY_CREATION_METHOD_ID;
76   }
77
78   /// Attribute name for the first point.
79   inline static const std::string& FIRST_POINT()
80   {
81     static const std::string MY_FIRST_POINT_ID("first_point");
82     return MY_FIRST_POINT_ID;
83   }
84
85   /// Attribute name for the second point.
86   inline static const std::string& SECOND_POINT()
87   {
88     static const std::string MY_SECOND_POINT_ID("second_point");
89     return MY_SECOND_POINT_ID;
90   }
91
92   /// Attribute name of "Compute intersections" checkbox.
93   inline static const std::string& INTERSECT_ID()
94   {
95     static const std::string MY_INTERSECT_ID("intersect");
96     return MY_INTERSECT_ID;
97   }
98
99   /// Request for initialization of data model of the feature: adding all attributes.
100   BUILDPLUGIN_EXPORT virtual void initAttributes();
101
102   /// Creates a new part document if needed.
103   BUILDPLUGIN_EXPORT virtual void execute();
104
105 private:
106   /// Build edges by the set of segments
107   void edgesBySegments();
108   /// Build edge by two points.
109   void edgeByPoints();
110 };
111
112 #endif