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