SHAPER  9.12.0
FeaturesAPI_Copy.h
1 // Copyright (C) 2014-2023 CEA, EDF
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 FeaturesAPI_Copy_H_
21 #define FeaturesAPI_Copy_H_
22 
23 #include "FeaturesAPI.h"
24 
25 #include <FeaturesPlugin_Copy.h>
26 
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
29 
32 
37 {
38 public:
40  FEATURESAPI_EXPORT
41  explicit FeaturesAPI_Copy(const std::shared_ptr<ModelAPI_Feature>& theFeature);
42 
44  FEATURESAPI_EXPORT
45  explicit FeaturesAPI_Copy(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46  const std::list<ModelHighAPI_Selection>& theBaseObjects,
47  const int theNumber);
48 
50  FEATURESAPI_EXPORT virtual ~FeaturesAPI_Copy();
51 
52  INTERFACE_2(FeaturesPlugin_Copy::ID(),
57 
58 
59  FEATURESAPI_EXPORT void setObjects(const std::list<ModelHighAPI_Selection>& theBaseObjects);
60 
62  FEATURESAPI_EXPORT void setNumber(const int theNumber);
63 
65  FEATURESAPI_EXPORT virtual void dump(ModelHighAPI_Dumper& theDumper) const;
66 };
67 
69 typedef std::shared_ptr<FeaturesAPI_Copy> CopyPtr;
70 
73 FEATURESAPI_EXPORT
74 CopyPtr addCopy(const std::shared_ptr<ModelAPI_Document>& thePart,
75  const std::list<ModelHighAPI_Selection>& theObjects,
76  const int theNumber);
77 
78 #endif // FeaturesAPI_Copy_H_
Interface for Copy feature.
Definition: FeaturesAPI_Copy.h:37
virtual ~FeaturesAPI_Copy()
Destructor.
Definition: FeaturesAPI_Copy.cpp:45
void setObjects(const std::list< ModelHighAPI_Selection > &theBaseObjects)
Modify objects attribute of the feature.
Definition: FeaturesAPI_Copy.cpp:48
virtual void dump(ModelHighAPI_Dumper &theDumper) const
Dump wrapped feature.
Definition: FeaturesAPI_Copy.cpp:61
void setNumber(const int theNumber)
Modify number of copies attribute of the feature.
Definition: FeaturesAPI_Copy.cpp:54
virtual std::shared_ptr< ModelAPI_AttributeInteger > number() const
Number of copies.
Definition: FeaturesAPI_Copy.h:56
FeaturesAPI_Copy(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: FeaturesAPI_Copy.cpp:26
virtual std::shared_ptr< ModelAPI_AttributeSelectionList > objects() const
Source objects.
Definition: FeaturesAPI_Copy.h:56
static const std::string NUMBER()
Integer attribute that contains the number of resulting copies needed.
Definition: FeaturesPlugin_Copy.h:59
static const std::string & ID()
Feature kind.
Definition: FeaturesPlugin_Copy.h:39
static const std::string & OBJECTS()
Selection list attribute that contains all copied shapes selection.
Definition: FeaturesPlugin_Copy.h:53
API for the attribute that contains integer (int).
Definition: ModelAPI_AttributeInteger.h:34
Attribute that contains list of references to the sub-shapes with possibility to manage them.
Definition: ModelAPI_AttributeSelectionList.h:37
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Dump engine for the model.
Definition: ModelHighAPI_Dumper.h:81
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
CopyPtr addCopy(const std::shared_ptr< ModelAPI_Document > &thePart, const std::list< ModelHighAPI_Selection > &theObjects, const int theNumber)
Create Copy feature.
Definition: FeaturesAPI_Copy.cpp:74