1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SketchPlugin_ConstraintCoincidence_H_
22 #define SketchPlugin_ConstraintCoincidence_H_
24 #include "SketchPlugin.h"
25 #include "SketchPlugin_ConstraintBase.h"
26 #include <SketchPlugin_Sketch.h>
29 class GeomDataAPI_Point2D;
31 /** \class SketchPlugin_ConstraintCoincidence
33 * \brief Feature for creation of a new constraint which defines equivalence of two points
35 * This constraint has two attributes:
36 * SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
38 class SketchPlugin_ConstraintCoincidence : public SketchPlugin_ConstraintBase
41 /// Coincidence constraint kind
42 inline static const std::string& ID()
44 static const std::string MY_CONSTRAINT_COINCIDENCE_ID("SketchConstraintCoincidence");
45 return MY_CONSTRAINT_COINCIDENCE_ID;
47 /// \brief Returns the kind of a feature
48 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
50 static std::string MY_KIND = SketchPlugin_ConstraintCoincidence::ID();
54 /// Returns the AIS preview
55 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
57 /// \brief Creates a new part document if needed
58 SKETCHPLUGIN_EXPORT virtual void execute();
60 /// \brief Request for initialization of data model of the feature: adding all attributes
61 SKETCHPLUGIN_EXPORT virtual void initAttributes();
63 /// Returns coincident feature if there is a coincidence built on the given features
64 /// \param theFeature1 the first feature
65 /// \param theFeature2 the second feature
66 static FeaturePtr findCoincidenceFeature(const FeaturePtr& theFeature1,
67 const FeaturePtr& theFeature2);
69 /// Creates a constraint on two points
70 /// \param theSketch a sketch feature
71 /// \param thePoint1 the first point
72 /// \param thePoint2 the second point
73 static void createCoincidenceFeature(SketchPlugin_Sketch* theSketch,
74 const std::shared_ptr<GeomDataAPI_Point2D>& thePoint1,
75 const std::shared_ptr<GeomDataAPI_Point2D>& thePoint2);
77 /// Returns point of coincidence feature
78 /// \param theFeature a coincidence feature
79 /// \return point 2d attribute. Coincidence always has at least one point 2d attribute
80 static std::shared_ptr<GeomDataAPI_Point2D> getPoint(const FeaturePtr& theFeature);
82 /// \brief Use plugin manager for features creation
83 SketchPlugin_ConstraintCoincidence();