src/SketchSolver/SketchSolver_ConstraintFixed.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    SketchSolver_ConstraintFixed.h
   4 // Created: 30 Mar 2015
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchSolver_ConstraintFixed_H_
   8 #define SketchSolver_ConstraintFixed_H_
   9
  10 #include "SketchSolver.h"
  11 #include <SketchSolver_Constraint.h>
  12
  13 /** \class   SketchSolver_ConstraintFixed
  14  *  \ingroup Plugins
  15  *  \brief   Stores data of the Fixed constraint
  16  *
  17  *  Fixed constraint may have NULL basic SketchPlugin constraint,
  18  *  because the Fixed constraint may be temporary for correct moving of objects.
  19  *
  20  *  Fixed constraint does not create a constraint, but builds the entities in separate group,
  21  *  so they will not be moved while resolving the set of constraints.
  22  */
  23 class SketchSolver_ConstraintFixed : public SketchSolver_Constraint
  24 {
  25 public:
  26   /// Creates constraint to manage the given constraint from plugin
  27   SketchSolver_ConstraintFixed(ConstraintPtr theConstraint);
  28   /// Creates temporary constraint based on feature
  29   SketchSolver_ConstraintFixed(FeaturePtr theFeature);
  30
  31   /// \brief Tries to remove constraint
  32   /// \return \c false, if current constraint contains another
  33   /// SketchPlugin constraints (like for multiple coincidence)
  34   virtual bool remove();
  35
  36 protected:
  37   /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
  38   virtual void process();
  39
  40   /// \brief Generate list of attributes of constraint in order useful for constraints
  41   /// \param[out] theValue      numerical characteristic of constraint (e.g. distance)
  42   /// \param[out] theAttributes list of attributes to be filled
  43   virtual void getAttributes(ParameterWrapperPtr& theValue,
  44                              std::vector<EntityWrapperPtr>& theAttributes);
  45
  46   /// \brief Fixed feature basing on its type
  47   /// \param theFeature [in]  feature, converted to solver specific format
  48   virtual void fixFeature(EntityWrapperPtr theFeature);
  49
  50 protected:
  51   FeaturePtr myBaseFeature; ///< fixed feature (when it is set, myBaseConstraint should be NULL)
  52
  53 private:
  54   AttributePtr myFixedAttribute; ///< possible attribute of a fixed constraint (for correct remove)
  55   FeaturePtr   myFixedFeature;   ///< possible attribute of a fixed constraint (for correct remove)
  56 };
  57
  58 #endif