]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Boolean.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Boolean.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_Boolean_H_
21 #define FeaturesPlugin_Boolean_H_
22
23 #include "FeaturesPlugin_VersionedBoolean.h"
24
25 /// \class FeaturesPlugin_Boolean
26 /// \ingroup Plugins
27 /// \brief Feature for applying of Boolean operations on Solids.
28 /// Supports four kinds of Boolean operations: Cut, Fuse, Common and Smash.
29 class FeaturesPlugin_Boolean : public FeaturesPlugin_VersionedBoolean
30 {
31 public:
32   enum OperationType {
33     BOOL_CUT,
34     BOOL_FUSE,
35     BOOL_COMMON,
36     BOOL_FILL,
37     BOOL_SMASH
38   };
39
40   /// Attribute name of main objects.
41   inline static const std::string& OBJECT_LIST_ID()
42   {
43     static const std::string MY_OBJECT_LIST_ID("main_objects");
44     return MY_OBJECT_LIST_ID;
45   }
46
47   /// Attribute name of tool objects.
48   inline static const std::string& TOOL_LIST_ID()
49   {
50     static const std::string MY_TOOL_LIST_ID("tool_objects");
51     return MY_TOOL_LIST_ID;
52   }
53
54   /// Attribute name of use fuzzy parameter.
55   inline static const std::string& USE_FUZZY_ID()
56   {
57     static const std::string MY_USE_FUZZY_ID("use_fuzzy");
58     return MY_USE_FUZZY_ID;
59   }
60
61   /// Attribute name of fuzzy parameter.
62   inline static const std::string& FUZZY_PARAM_ID()
63   {
64     static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
65     return MY_FUZZY_PARAM_ID;
66   }
67
68   /// \return boolean operation type.
69   FEATURESPLUGIN_EXPORT OperationType operationType();
70
71   /// Request for initialization of data model of the feature: adding all attributes.
72   FEATURESPLUGIN_EXPORT virtual void initAttributes();
73
74 protected:
75
76   /// Use plugin manager for features creation.
77   FeaturesPlugin_Boolean(const OperationType theOperationType);
78
79   /// Load Naming data structure of the feature to the document
80   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
81                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
82                     const ListOfShape& theTools,
83                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
84                     const GeomMakeShapePtr& theMakeShape);
85
86   /// Store result shape if it is not empty and increase results counter
87   void storeResult(const ListOfShape& theObjects,
88                    const ListOfShape& theTools,
89                    const GeomShapePtr theResultShape,
90                    int& theResultIndex,
91                    std::shared_ptr<GeomAlgoAPI_MakeShapeList> theMakeShapeList,
92                    std::vector<ModelAPI_Tools::ResultBaseAlgo>& theResultBaseAlgoList);
93
94 private:
95   OperationType myOperationType;
96 };
97
98 #endif