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  *  Fixed constraint may have NULL basic SketchPlugin constraint,
  31  *  because the Fixed constraint may be temporary for correct moving of objects.
  32  */
  33 class SketchSolver_ConstraintFixed : public SketchSolver_Constraint
  34 {
  35 public:
  36   /// Creates constraint to manage the given constraint from plugin
  37   SketchSolver_ConstraintFixed(ConstraintPtr theConstraint);
  38   /// Creates temporary constraint based on feature (useful while the feature is being moved)
  39   SketchSolver_ConstraintFixed(FeaturePtr theFeature);
  40
  41   /// \brief Block or unblock events from this constraint
  42   virtual void blockEvents(bool isBlocked);
  43
  44   /// \brief Set coordinates of fixed feature to the values where it has been dragged.
  45   ///        Useful when the feature is being moved.
  46   void moveFeature();
  47
  48 protected:
  49   /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
  50   virtual void process();
  51
  52   /// \brief Generate list of attributes of constraint in order useful for constraints
  53   /// \param[out] theBaseEntity  the entity which coordinates should be fixed
  54   /// \param[out] theFixedEntity the entity containing fixed values
  55   virtual void getAttributes(EntityWrapperPtr& theBaseEntity,
  56                              EntityWrapperPtr& theFixedEntity);
  57
  58   /// \brief Fixed feature basing on its type
  59   /// \param theFeature [in]  feature, converted to solver specific format
  60   virtual void fixFeature(EntityWrapperPtr theFeature);
  61
  62 private:
  63   FeaturePtr myBaseFeature; ///< fixed feature (when it is set, myBaseConstraint should be NULL)
  64
  65   ConstraintWrapperPtr myConstraint;
  66   std::vector<double> myFixedValues;
  67   EntityWrapperPtr    myFixedEntity;
  68 };
  69
  70 #endif