SHAPER  9.12.0
SketchPlugin_MultiTranslation.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 SketchPlugin_MultiTranslation_H_
21 #define SketchPlugin_MultiTranslation_H_
22 
23 #include "SketchPlugin.h"
24 #include <SketchPlugin_Sketch.h>
25 #include "SketchPlugin_ConstraintBase.h"
26 
40 {
41  public:
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  }
49  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
50  {
51  static std::string MY_KIND = SketchPlugin_MultiTranslation::ID();
52  return MY_KIND;
53  }
54 
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 
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 
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 
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 
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 
91  SKETCHPLUGIN_EXPORT virtual void execute();
92 
94  SKETCHPLUGIN_EXPORT virtual void initAttributes();
95 
98  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
99 
101  SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
102 
104  SKETCHPLUGIN_EXPORT virtual void erase();
105 
108 
109 private:
110  ObjectPtr copyFeature(ObjectPtr theObject);
111 
112 };
113 
114 #endif
Feature for creation of a new constraint between other features.
Definition: SketchPlugin_ConstraintBase.h:56
Feature for creation of a number of shifted copies of a list of objects.
Definition: SketchPlugin_MultiTranslation.h:40
virtual void initAttributes()
Request for initialization of data model of the feature: adding all attributes.
Definition: SketchPlugin_MultiTranslation.cpp:44
static const std::string & VALUE_TYPE()
attribute name for first point
Definition: SketchPlugin_MultiTranslation.h:63
virtual void execute()
Creates a new part document if needed.
Definition: SketchPlugin_MultiTranslation.cpp:61
static const std::string & END_POINT_ID()
End point of translation.
Definition: SketchPlugin_MultiTranslation.h:77
static const std::string & NUMBER_OF_OBJECTS_ID()
Total number of objects, initial and translated objects.
Definition: SketchPlugin_MultiTranslation.h:84
SketchPlugin_MultiTranslation()
Use plugin manager for features creation.
Definition: SketchPlugin_MultiTranslation.cpp:40
static const std::string & START_POINT_ID()
Start point of translation.
Definition: SketchPlugin_MultiTranslation.h:70
virtual const std::string & getKind()
Returns the kind of a feature.
Definition: SketchPlugin_MultiTranslation.h:49
virtual void attributeChanged(const std::string &theID)
Called on change of any argument-attribute of this object.
Definition: SketchPlugin_MultiTranslation.cpp:295
virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious)
Returns the AIS preview.
Definition: SketchPlugin_MultiTranslation.cpp:216
static const std::string & ID()
Multi-translation kind.
Definition: SketchPlugin_MultiTranslation.h:43
virtual void erase()
removes all fields from this feature: results, data, etc
Definition: SketchPlugin_MultiTranslation.cpp:226
static const std::string & TRANSLATION_LIST_ID()
List of objects to be mirrored.
Definition: SketchPlugin_MultiTranslation.h:56