]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Symmetry.h
Salome HOME
fb4b47da8a49e6fb11dabf1decabbad37500fdea
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Symmetry.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 FEATURESPLUGIN_SYMMETRY_H_
21 #define FEATURESPLUGIN_SYMMETRY_H_
22
23 #include <FeaturesPlugin.h>
24
25 #include <ModelAPI_Feature.h>
26
27 #include <GeomAlgoAPI_Symmetry.h>
28 #include <GeomAlgoAPI_MakeShapeList.h>
29
30 class GeomAPI_Trsf;
31
32 /** \class FeaturesPlugin_Symmetry
33  *  \ingroup Plugins
34  *  \brief Feature that performs reflection with respect to a point, axis, or plane.
35  */
36 class FeaturesPlugin_Symmetry : public ModelAPI_Feature
37 {
38  public:
39   /// Symmetry kind.
40   inline static const std::string& ID()
41   {
42     static const std::string MY_SYMMETRY_ID("Symmetry");
43     return MY_SYMMETRY_ID;
44   }
45
46   /// Attribute name for creation method.
47   inline static const std::string& CREATION_METHOD()
48   {
49     static const std::string MY_CREATION_METHOD_ID("CreationMethod");
50     return MY_CREATION_METHOD_ID;
51   }
52
53   /// Attribute name for creation method "ByPoint".
54   inline static const std::string& CREATION_METHOD_BY_POINT()
55   {
56     static const std::string MY_CREATION_METHOD_ID("ByPoint");
57     return MY_CREATION_METHOD_ID;
58   }
59
60   /// Attribute name for creation method "ByAxis".
61   inline static const std::string& CREATION_METHOD_BY_AXIS()
62   {
63     static const std::string MY_CREATION_METHOD_ID("ByAxis");
64     return MY_CREATION_METHOD_ID;
65   }
66
67   /// Attribute name for creation method "ByPlane".
68   inline static const std::string& CREATION_METHOD_BY_PLANE()
69   {
70     static const std::string MY_CREATION_METHOD_ID("ByPlane");
71     return MY_CREATION_METHOD_ID;
72   }
73
74   /// Attribute name of referenced objects.
75   inline static const std::string& OBJECTS_LIST_ID()
76   {
77     static const std::string MY_OBJECTS_LIST_ID("main_objects");
78     return MY_OBJECTS_LIST_ID;
79   }
80
81   /// Attribute name of a point.
82   inline static const std::string& POINT_OBJECT_ID()
83   {
84     static const std::string MY_POINT_OBJECT_ID("point_object");
85     return MY_POINT_OBJECT_ID;
86   }
87
88   /// Attribute name of an axis.
89   inline static const std::string& AXIS_OBJECT_ID()
90   {
91     static const std::string MY_AXIS_OBJECT_ID("axis_object");
92     return MY_AXIS_OBJECT_ID;
93   }
94
95   /// Attribute name of a plane.
96   inline static const std::string& PLANE_OBJECT_ID()
97   {
98     static const std::string MY_PLANE_OBJECT_ID("plane_object");
99     return MY_PLANE_OBJECT_ID;
100   }
101
102   /// Attribute name of keeping original shape.
103   inline static const std::string& KEEP_ORIGINAL_RESULT()
104   {
105     static const std::string MY_KEEP_ORIGINAL_RESULT_ID("keep_original");
106     return MY_KEEP_ORIGINAL_RESULT_ID;
107   }
108
109   /// \return the kind of a feature.
110   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
111   {
112     static std::string MY_KIND = FeaturesPlugin_Symmetry::ID();
113     return MY_KIND;
114   }
115
116   /// Creates a new part document if needed.
117   FEATURESPLUGIN_EXPORT virtual void execute();
118
119   /// Request for initialization of data model of the feature: adding all attributes.
120   FEATURESPLUGIN_EXPORT virtual void initAttributes();
121
122   /// Use plugin manager for features creation.
123   FeaturesPlugin_Symmetry();
124
125 private:
126   /// Obtain list of source objects of the mirror
127   bool collectSourceObjects(ListOfShape& theSourceShapes,
128                             std::list<std::shared_ptr<ModelAPI_Result>>& theSourceResults);
129
130   /// Perform symmetry with respect to a point.
131   void performSymmetryByPoint();
132
133   /// Perform symmetry with respect to an axis.
134   void performSymmetryByAxis();
135
136   /// Perform symmetry with respect to a plane.
137   void performSymmetryByPlane();
138
139   /// Create new result on given shapes and the index of result
140   void buildResult(std::shared_ptr<GeomAlgoAPI_Symmetry>& theSymmetryAlgo,
141                    std::shared_ptr<GeomAPI_Shape> theBaseShape,
142                    int theResultIndex);
143
144   /// Create new result for the given part and transformation
145   void buildResult(std::shared_ptr<ModelAPI_ResultPart> theOriginal,
146                    std::shared_ptr<GeomAPI_Trsf> theTrsf,
147                    int& theResultIndex);
148 };
149
150 #endif // FEATURESPLUGIN_SYMMETRY_H_