1 // Copyright (C) 2014-2022 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef FeaturesPlugin_Boolean_H_
21 #define FeaturesPlugin_Boolean_H_
23 #include "FeaturesPlugin_VersionedBoolean.h"
25 /// \class FeaturesPlugin_Boolean
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
40 /// Attribute name of main objects.
41 inline static const std::string& OBJECT_LIST_ID()
43 static const std::string MY_OBJECT_LIST_ID("main_objects");
44 return MY_OBJECT_LIST_ID;
47 /// Attribute name of tool objects.
48 inline static const std::string& TOOL_LIST_ID()
50 static const std::string MY_TOOL_LIST_ID("tool_objects");
51 return MY_TOOL_LIST_ID;
54 /// Attribute name of fuzzy parameter.
55 inline static const std::string& FUZZY_PARAM_ID()
57 static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
58 return MY_FUZZY_PARAM_ID;
61 /// \return boolean operation type.
62 FEATURESPLUGIN_EXPORT OperationType operationType();
64 /// Request for initialization of data model of the feature: adding all attributes.
65 FEATURESPLUGIN_EXPORT virtual void initAttributes();
69 /// Use plugin manager for features creation.
70 FeaturesPlugin_Boolean(const OperationType theOperationType);
72 /// Load Naming data structure of the feature to the document
73 void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
74 const std::shared_ptr<GeomAPI_Shape> theBaseShape,
75 const ListOfShape& theTools,
76 const std::shared_ptr<GeomAPI_Shape> theResultShape,
77 const GeomMakeShapePtr& theMakeShape);
79 /// Store result shape if it is not empty and increase results counter
80 void storeResult(const ListOfShape& theObjects,
81 const ListOfShape& theTools,
82 const GeomShapePtr theResultShape,
84 std::shared_ptr<GeomAlgoAPI_MakeShapeList> theMakeShapeList,
85 std::vector<ModelAPI_Tools::ResultBaseAlgo>& theResultBaseAlgoList);
88 OperationType myOperationType;