1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: FeaturesPlugin_ExtrusionCut.h
4 // Created: 12 May 2015
5 // Author: Dmitry Bobylev
7 #ifndef FeaturesPlugin_ExtrusionCut_H_
8 #define FeaturesPlugin_ExtrusionCut_H_
10 #include <FeaturesPlugin.h>
12 #include <ModelAPI_CompositeFeature.h>
14 #include <GeomAlgoAPI_Boolean.h>
16 /** \class FeaturesPlugin_ExtrusionCut
19 class FeaturesPlugin_ExtrusionCut : public ModelAPI_CompositeFeature
23 inline static const std::string& ID()
25 static const std::string MY_REVOLUTION_ID("ExtrusionCut");
26 return MY_REVOLUTION_ID;
29 /// attribute name of references sketch entities list, it should contain a sketch result or
30 /// a pair a sketch result to sketch face
31 inline static const std::string& CUTLIST_ID()
33 static const std::string MY_CUT_LIST_ID("cut_objects");
34 return MY_CUT_LIST_ID;
37 /// attribute name of an object to which the extrusion grows
38 inline static const std::string& SKETCH_OBJECT_ID()
40 static const std::string MY_TO_OBJECT_ID("sketch");
41 return MY_TO_OBJECT_ID;
44 /// attribute name of extrusion size
45 inline static const std::string& TO_SIZE_ID()
47 static const std::string MY_TO_SIZE_ID("to_size");
51 /// attribute name of an object to which the extrusion grows
52 inline static const std::string& TO_OBJECT_ID()
54 static const std::string MY_TO_OBJECT_ID("to_object");
55 return MY_TO_OBJECT_ID;
58 /// attribute name of tool object
59 inline static const std::string& FROM_OBJECT_ID()
61 static const std::string MY_FROM_OBJECT_ID("from_object");
62 return MY_FROM_OBJECT_ID;
65 /// attribute name of extrusion size
66 inline static const std::string& FROM_SIZE_ID()
68 static const std::string MY_FROM_SIZE_ID("from_size");
69 return MY_FROM_SIZE_ID;
72 /// Returns the kind of a feature
73 FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
75 static std::string MY_KIND = FeaturesPlugin_ExtrusionCut::ID();
79 /// Creates a new part document if needed.
80 FEATURESPLUGIN_EXPORT virtual void execute();
82 /// Request for initialization of data model of the feature: adding all attributes.
83 FEATURESPLUGIN_EXPORT virtual void initAttributes();
85 /// Use plugin manager for features creation.
86 FeaturesPlugin_ExtrusionCut();
88 /// appends a feature to the sketch sub-elements container
89 FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
91 /// Returns the number of sub-elements
92 FEATURESPLUGIN_EXPORT virtual int numberOfSubs() const;
94 /// Returns the sub-feature by zero-base index
95 FEATURESPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> subFeature(const int theIndex) const;
97 /// Returns the sub-feature unique identifier in this composite feature by zero-base index
98 FEATURESPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
100 /// Returns true if feature or reuslt belong to this composite feature as subs
101 FEATURESPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
103 /// This method to inform that sub-feature is removed and must be removed from the internal data
104 /// structures of the owner (the remove from the document will be done outside just after)
105 FEATURESPLUGIN_EXPORT virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
108 void LoadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
109 const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
110 const ListOfShape& theTools,
111 const GeomAlgoAPI_Boolean& theAlgo);