Salome HOME
Copyright update 2022
[modules/shaper.git] / src / BuildPlugin / BuildPlugin_Solid.h
1 // Copyright (C) 2017-2022  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef BuildPlugin_Solid_H_
21 #define BuildPlugin_Solid_H_
22
23 #include "BuildPlugin.h"
24 #include "BuildPlugin_Shape.h"
25
26 /// \class BuildPlugin_Solid
27 /// \ingroup Plugins
28 /// \brief Feature for creation of solid from faces or shells.
29 class BuildPlugin_Solid: public BuildPlugin_Shape
30 {
31 public:
32   /// Use plugin manager for features creation
33   BuildPlugin_Solid();
34
35   /// Feature kind.
36   inline static const std::string& ID()
37   {
38     static const std::string MY_ID("Solid");
39     return MY_ID;
40   }
41
42   /// Attribute name of base objects.
43   inline static const std::string& BASE_OBJECTS_ID()
44   {
45     static const std::string MY_BASE_OBJECTS_ID("base_objects");
46     return MY_BASE_OBJECTS_ID;
47   }
48
49   /// \return the kind of a feature.
50   BUILDPLUGIN_EXPORT virtual const std::string& getKind()
51   {
52     static std::string MY_KIND = BuildPlugin_Solid::ID();
53     return MY_KIND;
54   }
55
56   /// Request for initialization of data model of the feature: adding all attributes.
57   BUILDPLUGIN_EXPORT virtual void initAttributes();
58
59   /// Creates a new part document if needed.
60   BUILDPLUGIN_EXPORT virtual void execute();
61
62 protected:
63   /// Explode compound to get single shape
64   GeomShapePtr getSingleSubshape(const GeomShapePtr& theCompound);
65 };
66
67 #endif