]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintEqual.h
Salome HOME
[bos #37570] [CEA] SHAPER hdf tests are failing. Fix Sphere feature attributes order.
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintEqual.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_ConstraintEqual_H_
21 #define SketchPlugin_ConstraintEqual_H_
22
23 #include "SketchPlugin.h"
24 #include <SketchPlugin_Sketch.h>
25 #include "SketchPlugin_ConstraintBase.h"
26
27 /** \class SketchPlugin_ConstraintEqual
28  *  \ingroup Plugins
29  *  \brief Feature for creation of a new constraint specifying equality of lengths of two lines
30  *         or equality of radii of two circular arcs (full circles)
31  *
32  *  This constraint has two attributes:
33  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
34  */
35 class SketchPlugin_ConstraintEqual : public SketchPlugin_ConstraintBase
36 {
37  public:
38   /// Equal constraint kind
39   inline static const std::string& ID()
40   {
41     static const std::string MY_CONSTRAINT_EQUAL_ID("SketchConstraintEqual");
42     return MY_CONSTRAINT_EQUAL_ID;
43   }
44   /// \brief Returns the kind of a feature
45   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
46   {
47     static std::string MY_KIND = SketchPlugin_ConstraintEqual::ID();
48     return MY_KIND;
49   }
50
51   /// \brief Creates a new part document if needed
52   SKETCHPLUGIN_EXPORT virtual void execute();
53
54   /// \brief Request for initialization of data model of the feature: adding all attributes
55   SKETCHPLUGIN_EXPORT virtual void initAttributes();
56
57   /// Returns the AIS preview
58   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
59
60   /// \brief Use plugin manager for features creation
61   SketchPlugin_ConstraintEqual();
62 };
63
64 #endif