1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_MultiRotation.h
4 // Created: 21 Apr 2015
5 // Author: Artem ZHIDKOV
7 #ifndef SketchPlugin_MultiRotation_H_
8 #define SketchPlugin_MultiRotation_H_
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_Sketch.h>
12 #include "SketchPlugin_ConstraintBase.h"
14 /** \class SketchPlugin_MultiRotation
16 * \brief Feature for creation of a number of rotated copies of a list of objects
18 * This constraint has two attributes:
19 * SketchPlugin_Constraint::ENTITY_A() for initial list of objects and
20 * SketchPlugin_Constraint::ENTITY_B() for the list of created objects
22 * The list of created objects contains initial and copied objects of each object given. The
23 * number copies is the NUMBER_OF_OBJECTS_ID() minus 1. At the start of the list, there are
24 * collected N copies of first object from initial list, then N copies of second object etc.
26 class SketchPlugin_MultiRotation : public SketchPlugin_ConstraintBase
29 /// Multi-rotation kind
30 inline static const std::string& ID()
32 static const std::string MY_CONSTRAINT_ROTATION_ID("SketchMultiRotation");
33 return MY_CONSTRAINT_ROTATION_ID;
35 /// \brief Returns the kind of a feature
36 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
38 static std::string MY_KIND = SketchPlugin_MultiRotation::ID();
42 /// List of objects to be mirrored
43 inline static const std::string& ROTATION_LIST_ID()
45 static const std::string MY_ROTATION_LIST_ID("MultiRotationList");
46 return MY_ROTATION_LIST_ID;
49 /// Center of rotation
50 inline static const std::string& CENTER_ID()
52 static const std::string MY_CENTER_ID("MultiRotationCenter");
55 /// attribute name for first point
56 inline static const std::string& ANGLE_TYPE()
58 static const std::string ANGLE_TYPE_ATTR("AngleType");
59 return ANGLE_TYPE_ATTR;
62 /// End point of translation
63 inline static const std::string& ANGLE_ID()
65 static const std::string MY_ANGLE_ID("MultiRotationAngle");
68 /// End point of translation
69 inline static const std::string& ANGLE_FULL_ID()
71 static const std::string MY_ANGLE_FULL_ID("MultiRotationFullAngle");
72 return MY_ANGLE_FULL_ID;
75 /// Total number of objects, initial and translated objects
76 inline static const std::string& NUMBER_OF_OBJECTS_ID()
78 static const std::string MY_NUMBER_OF_OBJECTS_ID("MultiRotationObjects");
79 return MY_NUMBER_OF_OBJECTS_ID;
82 /// \brief Creates a new part document if needed
83 SKETCHPLUGIN_EXPORT virtual void execute();
85 /// \brief Request for initialization of data model of the feature: adding all attributes
86 SKETCHPLUGIN_EXPORT virtual void initAttributes();
88 /// Called on change of any argument-attribute of this object
89 /// \param theID identifier of changed attribute
90 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
92 /// Returns the AIS preview
93 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
95 /// \brief Use plugin manager for features creation
96 SketchPlugin_MultiRotation();
99 ObjectPtr copyFeature(ObjectPtr theObject);
100 void rotateFeature(ObjectPtr theInitial, ObjectPtr theTarget,
101 double theCenterX, double theCenterY, double theAngle);
103 bool updateFullAngleValue();
106 bool myBlockAngle; /// a boolean state to avoid recusive angle change in attributeChanged