]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchPlugin/SketchPlugin_ConstraintCoincidence.h
Salome HOME
[bos #37570] [CEA] SHAPER hdf tests are failing. Fix Sphere feature attributes order.
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintCoincidence.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_ConstraintCoincidence_H_
21 #define SketchPlugin_ConstraintCoincidence_H_
22
23 #include "SketchPlugin.h"
24 #include "SketchPlugin_ConstraintBase.h"
25 #include <SketchPlugin_Sketch.h>
26 #include <list>
27
28 class GeomDataAPI_Point2D;
29
30 /** \class SketchPlugin_ConstraintCoincidence
31  *  \ingroup Plugins
32  *  \brief Feature for creation of a new constraint which defines equivalence of two points
33  *
34  *  This constraint has two attributes:
35  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
36  */
37 class SketchPlugin_ConstraintCoincidence : public SketchPlugin_ConstraintBase
38 {
39  public:
40   /// Coincidence constraint kind
41   inline static const std::string& ID()
42   {
43     static const std::string MY_CONSTRAINT_COINCIDENCE_ID("SketchConstraintCoincidence");
44     return MY_CONSTRAINT_COINCIDENCE_ID;
45   }
46   /// \brief Returns the kind of a feature
47   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
48   {
49     static std::string MY_KIND = SketchPlugin_ConstraintCoincidence::ID();
50     return MY_KIND;
51   }
52
53   /// Returns the AIS preview
54   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
55
56   /// \brief Creates a new part document if needed
57   SKETCHPLUGIN_EXPORT virtual void execute();
58
59   /// \brief Request for initialization of data model of the feature: adding all attributes
60   SKETCHPLUGIN_EXPORT virtual void initAttributes();
61
62   /// Creates a constraint on two points
63   /// \param theSketch a sketch feature
64   /// \param thePoint1 the first point
65   /// \param thePoint2 the second point
66   static void createCoincidenceFeature(SketchPlugin_Sketch* theSketch,
67                                 const std::shared_ptr<GeomDataAPI_Point2D>& thePoint1,
68                                 const std::shared_ptr<GeomDataAPI_Point2D>& thePoint2);
69
70   /// Returns point of coincidence feature
71   /// \param theFeature a coincidence feature
72   /// \return point 2d attribute. Coincidence always has at least one point 2d attribute
73   static std::shared_ptr<GeomDataAPI_Point2D> getPoint(const FeaturePtr& theFeature);
74
75   /// \brief Use plugin manager for features creation
76   SketchPlugin_ConstraintCoincidence();
77 };
78
79 #endif