src/SketchSolver/SketchSolver_ConstraintEqual.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 SketchSolver_ConstraintEqual_H_
  21 #define SketchSolver_ConstraintEqual_H_
  22
  23 #include <SketchSolver_Constraint.h>
  24
  25 /** \class   SketchSolver_ConstraintEqual
  26  *  \ingroup Plugins
  27  *  \brief   Convert equality constraint to SolveSpace structure
  28  */
  29 class SketchSolver_ConstraintEqual : public SketchSolver_Constraint
  30 {
  31 public:
  32   /// Constructor based on SketchPlugin constraint
  33   SketchSolver_ConstraintEqual(ConstraintPtr theConstraint) :
  34       SketchSolver_Constraint(theConstraint)
  35   {}
  36
  37   /// \brief Tries to remove constraint
  38   /// \return \c false, if current constraint contains another SketchPlugin constraints
  39   /// (like for multiple coincidence)
  40   virtual bool remove();
  41
  42 protected:
  43   /// \brief Generate list of attributes of constraint in order useful for constraints
  44   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
  45   /// \param[out] theAttributes list of attributes to be filled
  46   virtual void getAttributes(EntityWrapperPtr&              theValue,
  47                              std::vector<EntityWrapperPtr>& theAttributes);
  48
  49 private:
  50   ScalarWrapperPtr myAuxValue; ///< scalar value to store ellipses focus distance
  51 };
  52
  53 #endif