]> SALOME platform Git repositories - modules/shaper.git/blob - src/BuildPlugin/BuildPlugin_SubShapes.h
Salome HOME
Issue #2358: Preserve state of folders on move in/out objects to a folder
[modules/shaper.git] / src / BuildPlugin / BuildPlugin_SubShapes.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef BuildPlugin_SubShapes_H_
22 #define BuildPlugin_SubShapes_H_
23
24 #include "BuildPlugin.h"
25
26 #include <ModelAPI_Feature.h>
27
28 /// \class BuildPlugin_SubShapes
29 /// \ingroup Plugins
30 /// \brief Feature for adding or removing sub-shapes from shape.
31 class BuildPlugin_SubShapes: public ModelAPI_Feature
32 {
33 public:
34   /// Use plugin manager for features creation
35   BuildPlugin_SubShapes();
36
37   /// Feature kind.
38   inline static const std::string& ID()
39   {
40     static const std::string MY_ID("SubShapes");
41     return MY_ID;
42   }
43
44   /// Attribute name of base shape.
45   inline static const std::string& BASE_SHAPE_ID()
46   {
47     static const std::string MY_BASE_SHAPE_ID("base_shape");
48     return MY_BASE_SHAPE_ID;
49   }
50
51   /// Attribute name of sub-shapes.
52   inline static const std::string& SUBSHAPES_ID()
53   {
54     static const std::string MY_SUBSHAPES_ID("subshapes");
55     return MY_SUBSHAPES_ID;
56   }
57
58   /// \return the kind of a feature.
59   BUILDPLUGIN_EXPORT virtual const std::string& getKind()
60   {
61     static std::string MY_KIND = BuildPlugin_SubShapes::ID();
62     return MY_KIND;
63   }
64
65   /// Request for initialization of data model of the feature: adding all attributes.
66   BUILDPLUGIN_EXPORT virtual void initAttributes();
67
68   /// Called on change of any argument-attribute of this object.
69   /// \param[in] theID identifier of changed attribute.
70   BUILDPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
71
72   /// Creates a new part document if needed.
73   BUILDPLUGIN_EXPORT virtual void execute();
74 };
75
76 #endif