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