]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintFillet.h
Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintFillet.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
2
3 // File:    SketchPlugin_ConstraintFillet.h
4 // Created: 19 Mar 2015
5 // Author:  Artem ZHIDKOV
6
7 #ifndef SketchPlugin_ConstraintFillet_H_
8 #define SketchPlugin_ConstraintFillet_H_
9
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_Sketch.h>
12 #include "SketchPlugin_ConstraintBase.h"
13
14 /** \class SketchPlugin_ConstraintFillet
15  *  \ingroup Plugins
16  *  \brief Feature for creation of a new constraint filleting two objects which have coincident point
17  *
18  *  This constraint has three attributes:
19  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B() for the filleting objects;
20  *  SketchPlugin_Constraint::VALUE() contains radius of filleting circular arc
21  *
22  *  Also the constraint has attribute SketchPlugin_Constraint::ENTITY_C()
23  *  which contains created list objects forming the fillet
24  */
25 class SketchPlugin_ConstraintFillet : public SketchPlugin_ConstraintBase
26 {
27  public:
28   /// Fillet constraint kind
29   inline static const std::string& ID()
30   {
31     static const std::string MY_CONSTRAINT_FILLET_ID("SketchConstraintFillet");
32     return MY_CONSTRAINT_FILLET_ID;
33   }
34   /// \brief Returns the kind of a feature
35   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
36   {
37     static std::string MY_KIND = SketchPlugin_ConstraintFillet::ID();
38     return MY_KIND;
39   }
40
41   /// \brief Creates a new part document if needed
42   SKETCHPLUGIN_EXPORT virtual void execute();
43
44   /// \brief Request for initialization of data model of the feature: adding all attributes
45   SKETCHPLUGIN_EXPORT virtual void initAttributes();
46
47   /// Returns the AIS preview
48   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
49
50   /// \brief Use plugin manager for features creation
51   SketchPlugin_ConstraintFillet();
52 };
53
54 #endif