]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_MultiTranslation.h
Salome HOME
updated copyright message
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_MultiTranslation.h
1 // Copyright (C) 2014-2023  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 SketchPlugin_MultiTranslation_H_
21 #define SketchPlugin_MultiTranslation_H_
22
23 #include "SketchPlugin.h"
24 #include <SketchPlugin_Sketch.h>
25 #include "SketchPlugin_ConstraintBase.h"
26
27 /** \class SketchPlugin_MultiTranslation
28  *  \ingroup Plugins
29  *  \brief Feature for creation of a number of shifted copies of a list of objects
30  *
31  *  This constraint has two attributes:
32  *  SketchPlugin_Constraint::ENTITY_A() for initial list of objects and
33  *  SketchPlugin_Constraint::ENTITY_B() for the list of created objects
34  *
35  *  The list of created objects contains initial and copied objects of each object given. The
36  *  number copies is the NUMBER_OF_OBJECTS_ID() minus 1. At the start of the list, there are
37  *  collected N copies of first object from initial list, then N copies of second object etc.
38  */
39 class SketchPlugin_MultiTranslation : public SketchPlugin_ConstraintBase
40 {
41  public:
42   /// Multi-translation kind
43   inline static const std::string& ID()
44   {
45     static const std::string MY_CONSTRAINT_TRANSLATION_ID("SketchMultiTranslation");
46     return MY_CONSTRAINT_TRANSLATION_ID;
47   }
48   /// \brief Returns the kind of a feature
49   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
50   {
51     static std::string MY_KIND = SketchPlugin_MultiTranslation::ID();
52     return MY_KIND;
53   }
54
55   /// List of objects to be mirrored
56   inline static const std::string& TRANSLATION_LIST_ID()
57   {
58     static const std::string MY_TRANSLATION_LIST_ID("MultiTranslationList");
59     return MY_TRANSLATION_LIST_ID;
60   }
61
62   /// attribute name for first point
63   inline static const std::string& VALUE_TYPE()
64   {
65     static const std::string VALUE_TYPE_ATTR("ValueType");
66     return VALUE_TYPE_ATTR;
67   }
68
69   /// Start point of translation
70   inline static const std::string& START_POINT_ID()
71   {
72     static const std::string MY_START_POINT_ID("MultiTranslationStartPoint");
73     return MY_START_POINT_ID;
74   }
75
76   /// End point of translation
77   inline static const std::string& END_POINT_ID()
78   {
79     static const std::string MY_END_POINT_ID("MultiTranslationEndPoint");
80     return MY_END_POINT_ID;
81   }
82
83   /// Total number of objects, initial and translated objects
84   inline static const std::string& NUMBER_OF_OBJECTS_ID()
85   {
86     static const std::string MY_NUMBER_OF_OBJECTS_ID("MultiTranslationObjects");
87     return MY_NUMBER_OF_OBJECTS_ID;
88   }
89
90   /// \brief Creates a new part document if needed
91   SKETCHPLUGIN_EXPORT virtual void execute();
92
93   /// \brief Request for initialization of data model of the feature: adding all attributes
94   SKETCHPLUGIN_EXPORT virtual void initAttributes();
95
96   /// Called on change of any argument-attribute of this object
97   /// \param theID identifier of changed attribute
98   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
99
100   /// Returns the AIS preview
101   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
102
103   /// removes all fields from this feature: results, data, etc
104   SKETCHPLUGIN_EXPORT virtual void erase();
105
106   /// \brief Use plugin manager for features creation
107   SketchPlugin_MultiTranslation();
108
109 private:
110   ObjectPtr copyFeature(ObjectPtr theObject);
111
112 };
113
114 #endif