]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Partition.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Partition.h
1 // Copyright (C) 2014-2022  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_Partition_H_
21 #define FeaturesPlugin_Partition_H_
22
23 #include "FeaturesPlugin_VersionedBoolean.h"
24 #include <ModelAPI_Feature.h>
25
26 #include <GeomAlgoAPI_Partition.h>
27
28 /// \class FeaturesPlugin_Partition
29 /// \ingroup Plugins
30 /// \brief Feature for applying of Partition operations on Shapes. Partition makes conjunctional
31 /// faces of solids as shared. The result of partitions is a compsolid.
32 class FeaturesPlugin_Partition : public FeaturesPlugin_VersionedBoolean
33 {
34 public:
35   /// Feature kind.
36   inline static const std::string& ID()
37   {
38     static const std::string MY_ID("Partition");
39     return MY_ID;
40   }
41
42   /// Attribute name of base objects.
43   inline static const std::string& BASE_OBJECTS_ID()
44   {
45     static const std::string MY_BASE_OBJECTS_ID("base_objects");
46     return MY_BASE_OBJECTS_ID;
47   }
48
49   /// Attribute name of use fuzzy parameter.
50   inline static const std::string& USE_FUZZY_ID()
51   {
52     static const std::string MY_USE_FUZZY_ID("use_fuzzy");
53     return MY_USE_FUZZY_ID;
54   }
55
56   /// Attribute name of fuzzy parameter.
57   inline static const std::string& FUZZY_PARAM_ID()
58   {
59     static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
60     return MY_FUZZY_PARAM_ID;
61   }
62
63   /// \return the kind of a feature.
64   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
65   {
66     static std::string MY_KIND = FeaturesPlugin_Partition::ID();
67     return MY_KIND;
68   }
69
70   /// Performs the algorithm and stores results it in the data structure.
71   FEATURESPLUGIN_EXPORT virtual void execute();
72
73   /// Request for initialization of data model of the feature: adding all attributes
74   FEATURESPLUGIN_EXPORT virtual void initAttributes();
75
76   /// Use plugin manager for features creation
77   FeaturesPlugin_Partition();
78
79 private:
80   /// Stores result of generation.
81   void storeResult(ListOfShape& theObjects,
82                    ListOfShape& thePlanes,
83                    const GeomShapePtr theResultShape,
84                    const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
85                    const int theIndex = 0);
86
87   /// Cut all of unused subs of compsolids by the full compsolid of the first selected object,
88   /// and vice versa, cut all objects of Partition by not used subs of the first selected object.
89   /// Store results of operation to the separated lists of shapes.
90   bool cutSubs(GeomAPI_ShapeHierarchy& theHierarchy,
91                ListOfShape& theUsed,
92                ListOfShape& theNotUsed,
93                const double theFuzzy,
94                std::shared_ptr<GeomAlgoAPI_MakeShapeList>& theMakeShapeList,
95                std::string& theError);
96 };
97
98 #endif