src/SketchSolver/SketchSolver_IConstraintWrapper.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:    SketchSolver_IConstraintWrapper.h
   4 // Created: 30 Nov 2015
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchSolver_IConstraintWrapper_H_
   8 #define SketchSolver_IConstraintWrapper_H_
   9
  10 #include <SketchSolver_IEntityWrapper.h>
  11
  12 #include <SketchPlugin_Constraint.h>
  13
  14 #include <list>
  15 #include <memory>
  16
  17 /// Types of constraints
  18 enum SketchSolver_ConstraintType {
  19   CONSTRAINT_UNKNOWN = 0,
  20   CONSTRAINT_COINCIDENCE,      // base coincidence if we don't know exact type yet
  21   CONSTRAINT_PT_PT_COINCIDENT,
  22   CONSTRAINT_PT_ON_LINE,
  23   CONSTRAINT_PT_ON_CIRCLE,
  24   CONSTRAINT_MIDDLE_POINT,
  25   CONSTRAINT_DISTANCE,         // base distance if we don't know the measured objects yet
  26   CONSTRAINT_PT_PT_DISTANCE,
  27   CONSTRAINT_PT_LINE_DISTANCE,
  28   CONSTRAINT_RADIUS,
  29   CONSTRAINT_ANGLE,
  30   CONSTRAINT_FIXED,
  31   CONSTRAINT_HORIZONTAL,
  32   CONSTRAINT_VERTICAL,
  33   CONSTRAINT_PARALLEL,
  34   CONSTRAINT_PERPENDICULAR,
  35   CONSTRAINT_SYMMETRIC,
  36   CONSTRAINT_EQUAL,           // base equality if we don't know the measured objects yet
  37   CONSTRAINT_EQUAL_LINES,
  38   CONSTRAINT_EQUAL_LINE_ARC,
  39   CONSTRAINT_EQUAL_RADIUS,
  40   CONSTRAINT_TANGENT,         // base tangency if we don't know the measured objects yet
  41   CONSTRAINT_TANGENT_ARC_LINE,
  42   CONSTRAINT_TANGENT_CIRCLE_LINE,
  43   CONSTRAINT_TANGENT_ARC_ARC,
  44   CONSTRAINT_COLLINEAR,
  45   CONSTRAINT_MULTI_TRANSLATION,
  46   CONSTRAINT_MULTI_ROTATION
  47 };
  48
  49 /**
  50  *  Wrapper providing operations with constraints regardless the solver.
  51  */
  52 class SketchSolver_IConstraintWrapper
  53 {
  54 public:
  55   virtual ~SketchSolver_IConstraintWrapper() {}
  56
  57   /// \brief Return ID of current constraint
  58   const ConstraintID& id() const
  59   { return myID; }
  60   /// \brief Change constraint ID
  61   virtual void setId( const ConstraintID& theID) = 0;
  62
  63   /// \brief Return type of current entity
  64   virtual SketchSolver_ConstraintType type() const = 0;
  65
  66   /// \brief Assign numeric parameter of constraint
  67   virtual void setValue(const double& theValue) = 0;
  68   /// \brief Return numeric parameter of constraint
  69   virtual double value() const = 0;
  70
  71 protected:
  72   ConstraintID myID;
  73 };
  74
  75 typedef std::shared_ptr<SketchSolver_IConstraintWrapper> ConstraintWrapperPtr;
  76
  77 #endif