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
19 class FeaturesPlugin_CompositeBoolean : public ModelAPI_CompositeFeature
22 /// Attribute name of sketch feature.
23 inline static const std::string& SKETCH_OBJECT_ID()
25 static const std::string MY_SKETCH_OBJECT_ID("sketch");
26 return MY_SKETCH_OBJECT_ID;
29 /// Attribute name of sketch feature.
30 inline static const std::string& SKETCH_SELECTION_ID()
32 static const std::string MY_SKETCH_SELECTION_ID("sketch_selection");
33 return MY_SKETCH_SELECTION_ID;
36 /// Attribute name of objects for boolean operation.
37 inline static const std::string& BOOLEAN_OBJECTS_ID()
39 static const std::string MY_BOOLEAN_OBJECTS_ID("boolean_objects");
40 return MY_BOOLEAN_OBJECTS_ID;
43 /// Creates a new part document if needed.
44 FEATURESPLUGIN_EXPORT virtual void execute();
46 /// Request for initialization of data model of the feature: adding all attributes.
47 FEATURESPLUGIN_EXPORT virtual void initAttributes();
49 /// Appends a feature to the sketch sub-elements container.
50 FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
52 /// \return the number of sub-elements.
53 FEATURESPLUGIN_EXPORT virtual int numberOfSubs(bool forTree = false) const;
55 /// \return the sub-feature by zero-base index.
56 FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex, bool forTree = false);
58 /// \return the sub-feature unique identifier in this composite feature by zero-base index.
59 FEATURESPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
61 /// \return true if feature or reuslt belong to this composite feature as subs.
62 FEATURESPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
64 /// This method to inform that sub-feature is removed and must be removed from the internal data
65 /// structures of the owner (the remove from the document will be done outside just after)
66 FEATURESPLUGIN_EXPORT virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
68 /// removes also all sub-sketch
69 FEATURESPLUGIN_EXPORT virtual void erase();
72 FeaturesPlugin_CompositeBoolean(){};
74 /// Define this function to init attributes for extrusion/revolution.
75 virtual void initMakeSolidsAttributes() = 0;
77 /// Define this function to create solids from faces with extrusion/revolution.
78 virtual void makeSolids(const ListOfShape& theFaces,
79 ListOfShape& theResults,
80 std::list<std::shared_ptr<GeomAPI_Interface>>& theAlgos) = 0;
82 void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
83 const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
84 const ListOfShape& theShells,
85 const std::list<std::shared_ptr<GeomAPI_Interface>>& theAlgos,
86 const ListOfShape& theTools,
87 const GeomAlgoAPI_Boolean& theAlgo);
90 GeomAlgoAPI_Boolean::OperationType myBooleanOperationType;