1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketchSolver_ConstraintRigid.h
4 // Created: 30 Mar 2015
5 // Author: Artem ZHIDKOV
7 #ifndef SketchSolver_ConstraintRigid_H_
8 #define SketchSolver_ConstraintRigid_H_
10 #include "SketchSolver.h"
11 #include <SketchSolver_Constraint.h>
13 /** \class SketchSolver_ConstraintRigid
15 * \brief Stores data of Rigid (Fixed) constraint
17 * Rigid constraint may have NULL basic SketchPlugin constraint,
18 * because the Rigid constraint may be temporary for correct moving of objects
20 class SketchSolver_ConstraintRigid : public SketchSolver_Constraint
23 /// Creates constraint to manage the given constraint from plugin
24 SketchSolver_ConstraintRigid(ConstraintPtr theConstraint)
25 : SketchSolver_Constraint(theConstraint)
27 /// Creates temporary constraint based on feature
28 SketchSolver_ConstraintRigid(FeaturePtr theFeature);
30 /// \brief Tries to remove constraint
31 /// \return \c false, if current constraint contains another SketchPlugin constraints (like for multiple coincidence)
32 virtual bool remove(ConstraintPtr theConstraint = ConstraintPtr());
34 /// \brief Returns the type of constraint
35 virtual int getType() const
36 { return SLVS_C_WHERE_DRAGGED; }
39 /// \brief Converts SketchPlugin constraint to a list of SolveSpace constraints
40 virtual void process();
42 /// \brief Generate list of attributes of constraint in order useful for SolveSpace constraints
43 /// \param[out] theValue numerical characteristic of constraint (e.g. distance)
44 /// \param[out] theAttributes list of attributes to be filled
45 virtual void getAttributes(double& theValue, std::vector<Slvs_hEntity>& theAttributes);
47 /// \brief This method is used in derived objects to check consistence of constraint.
48 /// E.g. the distance between line and point may be signed.
49 virtual void adjustConstraint();
52 /// \brief Fixing line position (start and end points)
53 void fixLine(const Slvs_Entity& theLine);
54 /// \brief Fixing circle (center and radius)
55 void fixCircle(const Slvs_Entity& theCircle);
56 /// \brief The arc is fixed differently to avoid SolveSpace problems (overconstraint)
58 /// There will be fixed start and end points and the radius of the arc.
59 void fixArc(const Slvs_Entity& theArc);
61 /// \brief Fix given point
62 void fixPoint(const Slvs_hEntity& thePointID);
64 /// \brief Verifies the entity is used in any equal constraint
65 /// \param[in] theEntity entity to be found
66 /// \param[out] theEqual constraint, which uses the entity
67 /// \return \c true, if the Equal constrait is found
68 bool isUsedInEqual(const Slvs_Entity& theEntity, Slvs_Constraint& theEqual) const;
70 /// \brief Verifies the entity is already fixed
71 bool isFixed(const Slvs_Entity& theEntity) const;
74 FeaturePtr myBaseFeature; ///< fixed feature (when it is set, myBaseConstraint should be NULL)