Salome HOME
Avoid SketchSolver documentation warnings
[modules/shaper.git] / src / SketchSolver / SketchSolver_ConstraintDistance.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:    SketchSolver_ConstraintDistance.h
4 // Created: 31 Mar 2015
5 // Author:  Artem ZHIDKOV
6
7 #ifndef SketchSolver_ConstraintDistance_H_
8 #define SketchSolver_ConstraintDistance_H_
9
10 #include "SketchSolver.h"
11 #include <SketchSolver_Constraint.h>
12
13 /** \class   SketchSolver_ConstraintDistance
14  *  \ingroup Plugins
15  *  \brief   Convert distance constraint to SolveSpace structure
16  */
17 class SketchSolver_ConstraintDistance : public SketchSolver_Constraint
18 {
19 public:
20   /// Constructor based on SketchPlugin constraint
21   SketchSolver_ConstraintDistance(ConstraintPtr theConstraint) :
22       SketchSolver_Constraint(theConstraint),
23       myType(SLVS_C_UNKNOWN),
24       myIsNegative(false)
25   {}
26
27   /// \brief Update constraint
28   virtual void update(ConstraintPtr theConstraint = ConstraintPtr());
29
30   virtual int getType() const
31   {return myType; }
32
33 protected:
34   /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
35   virtual void process();
36
37   /// \brief This method is used in derived objects to check consistence of constraint.
38   ///        E.g. the distance between line and point may be signed.
39   virtual void adjustConstraint();
40
41 private:
42   int myType; ///< type of constraint (applicable: SLVS_C_PT_PT_DISTANCE, SLVS_C_PT_LINE_DISTANCE)
43   double myPrevValue; ///< previous value of distance (for correct calculation of a distance sign)
44   bool myIsNegative;  ///< \c true, if the point if placed rightside of line direction (SLVS_C_PT_LINE_DISTANCE only)
45 };
46
47 #endif