1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: FeaturesPlugin_CompositeBoolean.h
4 // Created: 11 June 2015
5 // Author: Dmitry Bobylev
7 #ifndef FeaturesPlugin_CompositeBoolean_H_
8 #define FeaturesPlugin_CompositeBoolean_H_
10 #include <FeaturesPlugin.h>
12 #include <ModelAPI_CompositeFeature.h>
14 #include <GeomAlgoAPI_Boolean.h>
16 /** \class FeaturesPlugin_CompositeBoolean
18 * \brief Interface for the composite boolean feature.
20 class FeaturesPlugin_CompositeBoolean : public ModelAPI_CompositeFeature
23 /// Attribute name of sketch feature.
24 inline static const std::string& SKETCH_OBJECT_ID()
26 static const std::string MY_SKETCH_OBJECT_ID("sketch");
27 return MY_SKETCH_OBJECT_ID;
30 /// Attribute name of sketch feature.
31 inline static const std::string& SKETCH_SELECTION_ID()
33 static const std::string MY_SKETCH_SELECTION_ID("sketch_selection");
34 return MY_SKETCH_SELECTION_ID;
37 /// Attribute name of objects for boolean operation.
38 inline static const std::string& BOOLEAN_OBJECTS_ID()
40 static const std::string MY_BOOLEAN_OBJECTS_ID("boolean_objects");
41 return MY_BOOLEAN_OBJECTS_ID;
44 /// Creates a new part document if needed.
45 FEATURESPLUGIN_EXPORT virtual void execute();
47 /// Request for initialization of data model of the feature: adding all attributes.
48 FEATURESPLUGIN_EXPORT virtual void initAttributes();
50 /// Appends a feature to the sketch sub-elements container.
51 FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
53 /// \return the number of sub-elements.
54 FEATURESPLUGIN_EXPORT virtual int numberOfSubs(bool forTree = false) const;
56 /// \return the sub-feature by zero-base index.
57 FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex, bool forTree = false);
59 /// \return the sub-feature unique identifier in this composite feature by zero-base index.
60 FEATURESPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
62 /// \return true if feature or reuslt belong to this composite feature as subs.
63 FEATURESPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
65 /// This method to inform that sub-feature is removed and must be removed from the internal data
66 /// structures of the owner (the remove from the document will be done outside just after)
67 FEATURESPLUGIN_EXPORT virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
69 /// removes also all sub-sketch
70 FEATURESPLUGIN_EXPORT virtual void erase();
73 FeaturesPlugin_CompositeBoolean(){};
75 /// Define this function to init attributes for extrusion/revolution.
76 virtual void initMakeSolidsAttributes() = 0;
78 /// Define this function to create solids from faces with extrusion/revolution.
79 virtual void makeSolids(const ListOfShape& theFaces,
80 ListOfShape& theResults,
81 ListOfMakeShape& theAlgos) = 0;
84 void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
85 const ListOfShape& theShells,
86 ListOfMakeShape& theSolidsAlgos,
87 const std::shared_ptr<GeomAPI_Shape> theBaseShape,
88 const ListOfShape& theTools,
89 const std::shared_ptr<GeomAPI_Shape> theResultShape,
90 GeomAlgoAPI_MakeShape& theMakeShape,
91 GeomAPI_DataMapOfShapeShape& theMapOfShapes);
94 /// Type of boolean operation.
95 GeomAlgoAPI_Boolean::OperationType myBooleanOperationType;