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