src/SketchSolver/SketchSolver_ConstraintCoincidence.h

   1 // Copyright (C) 2014-2021  CEA/DEN, EDF R&D
   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 SketchSolver_ConstraintCoincidence_H_
  21 #define SketchSolver_ConstraintCoincidence_H_
  22
  23 #include <SketchSolver_Constraint.h>
  24
  25 /** \class   SketchSolver_ConstraintCoincidence
  26  *  \ingroup Plugins
  27  *  \brief   Convert coincidence constraint to SolveSpace structure
  28  */
  29 class SketchSolver_ConstraintCoincidence : public SketchSolver_Constraint
  30 {
  31 public:
  32   /// Constructor based on SketchPlugin constraint
  33   SketchSolver_ConstraintCoincidence(ConstraintPtr theConstraint) :
  34       SketchSolver_Constraint(theConstraint),
  35       myInSolver(false)
  36   {}
  37
  38   /// \brief Notify this object about the feature is changed somewhere
  39   virtual void notify(const FeaturePtr&      theFeature,
  40                       PlaneGCSSolver_Update* theUpdater);
  41
  42   /// \brief Remove constraint
  43   virtual bool remove();
  44
  45 protected:
  46   /// \brief Converts SketchPlugin constraint to a list of solver constraints
  47   virtual void process();
  48
  49   /// \brief Generate list of attributes of constraint in order useful for constraints
  50   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
  51   /// \param[out] theAttributes list of attributes to be filled
  52   virtual void getAttributes(EntityWrapperPtr&              theValue,
  53                              std::vector<EntityWrapperPtr>& theAttributes);
  54
  55   /// \brief This method is used in derived objects to check consistency of constraint.
  56   ///        E.g. the distance between line and point may be signed.
  57   virtual void adjustConstraint();
  58
  59 protected:
  60   bool myInSolver; ///< shows the constraint is added to the solver
  61   EntityWrapperPtr myFeatureExtremities[2]; ///< extremities of a feature, a point is coincident to
  62   ScalarWrapperPtr myAuxValue; ///< parameter on B-spline curve
  63 };
  64
  65 #endif