src/SketchSolver/SketchSolver_ConstraintFixed.h

   1 // Copyright (C) 2014-2023  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_ConstraintFixed_H_
  21 #define SketchSolver_ConstraintFixed_H_
  22
  23 #include <SketchSolver_Constraint.h>
  24
  25 /** \class   SketchSolver_ConstraintFixed
  26  *  \ingroup Plugins
  27  *  \brief   Stores data of the Fixed constraint
  28  */
  29 class SketchSolver_ConstraintFixed : public SketchSolver_Constraint
  30 {
  31 public:
  32   /// Creates constraint to manage the given constraint from plugin
  33   SketchSolver_ConstraintFixed(ConstraintPtr theConstraint);
  34
  35   /// \brief Block or unblock events from this constraint
  36   virtual void blockEvents(bool isBlocked);
  37
  38 protected:
  39   /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
  40   virtual void process();
  41
  42   /// \brief Generate list of attributes of constraint in order useful for constraints
  43   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
  44   /// \param[out] theAttributes list of attributes to be filled
  45   virtual void getAttributes(EntityWrapperPtr& , std::vector<EntityWrapperPtr>& )
  46   {}
  47
  48   /// \brief Obtain entity to be fixed
  49   EntityWrapperPtr entityToFix();
  50
  51   /// \brief Create Fixed constraint for the feature basing on its type
  52   /// \param theFeature [in]  feature, converted to solver specific format
  53   /// \return Fixed constraint
  54   ConstraintWrapperPtr fixFeature(EntityWrapperPtr theFeature);
  55
  56 protected:
  57   std::vector<double> myFixedValues;
  58 };
  59
  60 #endif