1 // Copyright (C) 2014-2019 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_CompositeSketch_H_
21 #define FeaturesPlugin_CompositeSketch_H_
23 #include "FeaturesPlugin.h"
25 #include <ModelAPI_CompositeFeature.h>
27 #include <ModelAPI_ResultBody.h>
29 /// \class FeaturesPlugin_CompositeSketch
31 /// \brief Interface for the composite sketch feature.
32 class FeaturesPlugin_CompositeSketch : public ModelAPI_CompositeFeature
35 /// Attribute name of sketch feature.
36 inline static const std::string& SKETCH_ID()
38 static const std::string MY_SKETCH_ID("sketch");
42 /// Attribute name of base objects.
43 inline static const std::string& BASE_OBJECTS_ID()
45 static const std::string MY_BASE_OBJECTS_ID("base");
46 return MY_BASE_OBJECTS_ID;
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
57 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 result 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 /// On change of attribute of the result update presentation of this result:
70 /// for the current moment there are only presentation attributes assigned to results
71 FEATURESPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
75 InitSketchLauncher = 1 << 0,
76 InitBaseObjectsList = 1 << 1
79 FeaturesPlugin_CompositeSketch(){};
81 /// Initializes composite sketch attributes.
82 void initCompositeSketchAttribtues(const int theInitFlags);
84 /// \brief Returns list of base shapes.
85 /// \param[out] theBaseShapesList list of base shapes (warning: list not cleared).
86 /// \param[in] theIsMakeShells if true make shells from faces with shared edges.
87 void getBaseShapes(ListOfShape& theBaseShapesList, const bool theIsMakeShells = true);
89 /// Stores result of generation.
90 void storeResult(const GeomShapePtr theBaseShape,
91 const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
92 const int theIndex = 0);
94 /// Stores generation history.
95 void storeGenerationHistory(ResultBodyPtr theResultBody,
96 const GeomShapePtr theBaseShape,
97 const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape);
99 /// Used to store from and to shapes: generated, or in common modified tag
100 void storeShapes(const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
101 ResultBodyPtr theResultBody,
102 const GeomAPI_Shape::ShapeType theBaseShapeType,
103 const ListOfShape& theShapes,
104 const std::string theName);
107 std::string myCurrentSelectionType; //< type of selection (vertex, edge or face)