]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/FeaturesPlugin_Copy.h
Salome HOME
La part
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Copy.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 FeaturesPlugin_Copy_H_
21 #define FeaturesPlugin_Copy_H_
22
23 #include "FeaturesPlugin.h"
24
25 #include <ModelAPI_Feature.h>
26
27 /// \class FeaturesPlugin_Copy
28 /// \ingroup Plugins
29 /// \brief This feature copies the selected results and sub-results (for the whole feature selected
30 ///        all results of this feature are copied). The referenced arguments of this feature are
31 ///        not concealed. The difference with \94Recover\94 feature is that not concealed results may
32 ///        be selected and in the history behavior: the \93Move to the End\94 of groups will move to
33 ///        all copy-results.
34
35 class FeaturesPlugin_Copy : public ModelAPI_Feature, public ModelAPI_FeatureCopyInterface
36 {
37 public:
38   /// Feature kind.
39   inline static const std::string& ID()
40   {
41     static const std::string MY_ID("Copy");
42     return MY_ID;
43   }
44
45   /// \return the kind of a feature.
46   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
47   {
48     static std::string MY_KIND = FeaturesPlugin_Copy::ID();
49     return MY_KIND;
50   }
51
52   /// Selection list attribute that contains all copied shapes selection.
53   inline static const std::string& OBJECTS()
54   {
55     static const std::string MY_OBJECTS("objects");
56     return MY_OBJECTS;
57   }
58   /// Integer attribute that contains the number of resulting copies needed
59   inline static const std::string NUMBER()
60   {
61     static std::string MY_NUMBER("number");
62     return MY_NUMBER;
63   }
64
65   /// Performs the algorithm and stores results it in the data structure.
66   FEATURESPLUGIN_EXPORT virtual void execute();
67
68   /// Request for initialization of data model of the feature: adding all attributes.
69   FEATURESPLUGIN_EXPORT virtual void initAttributes();
70
71   /// To update the group feature which is moved over this copy feature (to add copies to selection)
72   FEATURESPLUGIN_EXPORT virtual void getCopies(
73     ObjectPtr theContext, std::shared_ptr<GeomAPI_Shape> theValue,
74     std::list<ObjectPtr>& theCopyContext, std::list<std::shared_ptr<GeomAPI_Shape> >& theCopyVals);
75
76   /// Use plugin manager for features creation.
77   FeaturesPlugin_Copy() {}
78 };
79
80 #endif