Salome HOME
Copyright update 2021
[modules/shaper.git] / src / SketchSolver / SketchSolver_ConstraintCoincidence.h
index 5ff02a1b6a2b6b807f9dcc337f1ccd309a0eab45..e5a614b8e68ea699cfdd7a349a7a5d81211ef026 100644 (file)
@@ -1,13 +1,25 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:    SketchSolver_ConstraintCoincidence.h
-// Created: 29 Mar 2015
-// Author:  Artem ZHIDKOV
+// Copyright (C) 2014-2021  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef SketchSolver_ConstraintCoincidence_H_
 #define SketchSolver_ConstraintCoincidence_H_
 
-#include "SketchSolver.h"
 #include <SketchSolver_Constraint.h>
 
 /** \class   SketchSolver_ConstraintCoincidence
@@ -18,54 +30,36 @@ class SketchSolver_ConstraintCoincidence : public SketchSolver_Constraint
 {
 public:
   /// Constructor based on SketchPlugin constraint
-  SKETCHSOLVER_EXPORT SketchSolver_ConstraintCoincidence(ConstraintPtr theConstraint) :
-      SketchSolver_Constraint(theConstraint)
+  SketchSolver_ConstraintCoincidence(ConstraintPtr theConstraint) :
+      SketchSolver_Constraint(theConstraint),
+      myInSolver(false)
   {}
 
-////  /// \brief Tries to remove constraint
-////  /// \return \c false, if current constraint contains another SketchPlugin constraints (like for multiple coincidence)
-////  virtual bool remove(ConstraintPtr theConstraint = ConstraintPtr());
+  /// \brief Notify this object about the feature is changed somewhere
+  virtual void notify(const FeaturePtr&      theFeature,
+                      PlaneGCSSolver_Update* theUpdater);
 
-////  /// \brief Checks the constraint is used by current object
-////  virtual bool hasConstraint(ConstraintPtr theConstraint) const;
-////
-////  /// \brief Return list of SketchPlugin constraints attached to this object
-////  virtual std::list<ConstraintPtr> constraints() const;
-////
-////  /// \brief Verifies the two Coincidence constraints are intersects (have shared point)
-////  bool isCoincide(std::shared_ptr<SketchSolver_ConstraintCoincidence> theConstraint) const;
-////
-////  /// \brief Append all data of coincidence constraint to the current
-////  void attach(std::shared_ptr<SketchSolver_ConstraintCoincidence> theConstraint);
+  /// \brief Remove constraint
+  virtual bool remove();
 
 protected:
-////  /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
-////  virtual void process();
+  /// \brief Converts SketchPlugin constraint to a list of solver constraints
+  virtual void process();
 
   /// \brief Generate list of attributes of constraint in order useful for constraints
   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
   /// \param[out] theAttributes list of attributes to be filled
-  virtual void getAttributes(double& theValue, std::vector<EntityWrapperPtr>& theAttributes);
+  virtual void getAttributes(EntityWrapperPtr&              theValue,
+                             std::vector<EntityWrapperPtr>& theAttributes);
+
+  /// \brief This method is used in derived objects to check consistency of constraint.
+  ///        E.g. the distance between line and point may be signed.
+  virtual void adjustConstraint();
 
-////  /// \brief Generate list of attributes of constraint in order useful for SolveSpace constraints
-////  /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
-////  /// \param[out] theAttributes list of attributes to be filled
-////  virtual void getAttributes(double& theValue, std::vector<Slvs_hEntity>& theAttributes);
-////
-////private:
-////  /// \brief Creates new coincidence constraint
-////  Slvs_hConstraint addConstraint(Slvs_hEntity thePoint1, Slvs_hEntity thePoint2);
-////
-////  /// \brief Create full SolveSpace structure according to given constraint
-////  void addConstraint(ConstraintPtr theConstraint);
-////
-////  /// \brief Create constraint of point coincident to the line or circle
-////  Slvs_hConstraint addPointOnEntity(Slvs_hEntity thePoint, Slvs_hEntity theEntity);
-////
-////private:
-////  int myType; ///< type of constraint (applicable SLVS_C_POINTS_COINCIDENT or SLVS_C_PT_ON_LINE or SLVS_C_PT_ON_CIRCLE)
-////  std::map<ConstraintPtr, Slvs_hConstraint> myExtraCoincidence; ///< multiple coincidence of points
-////  std::set<AttributePtr> myCoincidentPoints; ///< list of points under the Coincidence constraint
+protected:
+  bool myInSolver; ///< shows the constraint is added to the solver
+  EntityWrapperPtr myFeatureExtremities[2]; ///< extremities of a feature, a point is coincident to
+  ScalarWrapperPtr myAuxValue; ///< parameter on B-spline curve
 };
 
 #endif