src/SketchSolver/SketchSolver_ConstraintCoincidence.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SketchSolver_ConstraintCoincidence_H_
  22 #define SketchSolver_ConstraintCoincidence_H_
  23
  24 #include <SketchSolver_Constraint.h>
  25
  26 /** \class   SketchSolver_ConstraintCoincidence
  27  *  \ingroup Plugins
  28  *  \brief   Convert coincidence constraint to SolveSpace structure
  29  */
  30 class SketchSolver_ConstraintCoincidence : public SketchSolver_Constraint
  31 {
  32 public:
  33   /// Constructor based on SketchPlugin constraint
  34   SketchSolver_ConstraintCoincidence(ConstraintPtr theConstraint) :
  35       SketchSolver_Constraint(theConstraint),
  36       myInSolver(false)
  37   {}
  38
  39   /// \brief Notify this object about the feature is changed somewhere
  40   virtual void notify(const FeaturePtr&      theFeature,
  41                       PlaneGCSSolver_Update* theUpdater);
  42
  43   /// \brief Remove constraint
  44   virtual bool remove();
  45
  46 protected:
  47   /// \brief Converts SketchPlugin constraint to a list of solver constraints
  48   virtual void process();
  49
  50   /// \brief Generate list of attributes of constraint in order useful for constraints
  51   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
  52   /// \param[out] theAttributes list of attributes to be filled
  53   virtual void getAttributes(EntityWrapperPtr&              theValue,
  54                              std::vector<EntityWrapperPtr>& theAttributes);
  55
  56 protected:
  57   bool myInSolver; ///< shows the constraint is added to the solver
  58   EntityWrapperPtr myFeatureExtremities[2]; ///< extremities of a feature, a point is coincident to
  59 };
  60
  61 #endif