]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintEqual.h
Salome HOME
Revert change for MacroArc attribute names
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintEqual.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
2
3 // File:    SketchPlugin_ConstraintEqual.h
4 // Created: 16 Mar 2015
5 // Author:  Artem ZHIDKOV
6
7 #ifndef SketchPlugin_ConstraintEqual_H_
8 #define SketchPlugin_ConstraintEqual_H_
9
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_Sketch.h>
12 #include "SketchPlugin_ConstraintBase.h"
13
14 /** \class SketchPlugin_ConstraintEqual
15  *  \ingroup Plugins
16  *  \brief Feature for creation of a new constraint specifying equality of lengths of two lines
17  *         or equality of radii of two circular arcs (full circles)
18  *
19  *  This constraint has two attributes:
20  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
21  */
22 class SketchPlugin_ConstraintEqual : public SketchPlugin_ConstraintBase
23 {
24  public:
25   /// Equal constraint kind
26   inline static const std::string& ID()
27   {
28     static const std::string MY_CONSTRAINT_EQUAL_ID("SketchConstraintEqual");
29     return MY_CONSTRAINT_EQUAL_ID;
30   }
31   /// \brief Returns the kind of a feature
32   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
33   {
34     static std::string MY_KIND = SketchPlugin_ConstraintEqual::ID();
35     return MY_KIND;
36   }
37
38   /// \brief Creates a new part document if needed
39   SKETCHPLUGIN_EXPORT virtual void execute();
40
41   /// \brief Request for initialization of data model of the feature: adding all attributes
42   SKETCHPLUGIN_EXPORT virtual void initAttributes();
43
44   /// Returns the AIS preview
45   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
46
47   /// \brief Use plugin manager for features creation
48   SketchPlugin_ConstraintEqual();
49 };
50
51 #endif