1 // File: SketchSolver_ConstraintManager.h
2 // Created: 08 May 2014
3 // Author: Artem ZHIDKOV
5 #ifndef SketchSolver_ConstraintManager_Headerfile
6 #define SketchSolver_ConstraintManager_Headerfile
8 #include "SketchSolver.h"
9 #include <SketchSolver_Solver.h>
11 #include <Events_Listener.h>
12 #include <SketchPlugin_Constraint.h>
22 // Unknown constraint (for error reporting)
23 #define SLVS_C_UNKNOWN 0
25 #define SLVS_E_UNKNOWN 0
27 /** \class SketchSolver_ConstraintManager
29 * \brief Listens the changes of SketchPlugin features and transforms the Constraint
30 * feature into the format understandable by SolveSpace library.
32 * Constraints created for SolveSpace library are divided into the groups.
33 * The division order based on connectedness of the features by the constraints.
34 * The groups may be fused or separated according to the new constraints.
36 * \remark This is a singleton.
38 class SketchSolver_ConstraintManager : public Events_Listener
41 /** \brief Main method to create constraint manager
42 * \return pointer to the singleton
44 static SketchSolver_ConstraintManager* Instance();
46 /** \brief Implementation of Event Listener method
47 * \param[in] theMessage the data of the event
49 virtual void processEvent(const Events_Message* theMessage);
52 SketchSolver_ConstraintManager();
53 ~SketchSolver_ConstraintManager();
55 /** \brief Adds or updates a constraint in the suitable group
56 * \param[in] theConstraint constraint to be changed
57 * \return \c true if the constraint changed successfully
59 bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
61 /** \brief Removes a constraint from the manager
62 * \param[in] theConstraint constraint to be removed
63 * \return \c true if the constraint removed successfully
65 bool removeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
67 /** \brief Adds or updates a workplane in the manager
68 * \param[in] theSketch the feature to create or update workplane
69 * \return \c true if the workplane cahnged successfully
71 bool changeWorkplane(boost::shared_ptr<SketchPlugin_Sketch> theSketch);
73 /** \brief Removes a workplane from the manager.
74 * All groups based on such workplane will be removed too.
75 * \param[in] theSketch the feature to be removed
76 * \return \c true if the workplane removed successfully
78 bool removeWorkplane(boost::shared_ptr<SketchPlugin_Sketch> theSketch);
80 /** \brief Updates entity which is neither workplane nor constraint
81 * \param[in] theFeature entity to be updated
83 void updateEntity(boost::shared_ptr<SketchPlugin_Feature> theFeature);
85 /** \brief Goes through the list of groups and solve the constraints
87 void ResolveConstraints();
90 class SketchSolver_ConstraintGroup;
92 /** \brief Searches list of groups which interact with specified constraint
93 * \param[in] theConstraint constraint to be found
94 * \param[out] theGroups list of group indexes interacted with constraint
96 void findGroups(boost::shared_ptr<SketchPlugin_Constraint> theConstraint,
97 std::vector<Slvs_hGroup>& theGroupIDs) const;
99 /** \brief Searches in the list of groups the workplane which constains specified constraint
100 * \param[in] theConstraint constraint to be found
101 * \return workplane contains the constraint
103 boost::shared_ptr<SketchPlugin_Sketch> findWorkplaneForConstraint(
104 boost::shared_ptr<SketchPlugin_Constraint> theConstraint) const;
107 static SketchSolver_ConstraintManager* _self; ///< Self pointer to implement singleton functionality
108 std::vector<SketchSolver_ConstraintGroup*> myGroups; ///< Groups of constraints
112 /** \class SketchSolver_ConstraintGroup
114 * \brief Keeps the group of constraints which based on the same entities
116 class SketchSolver_ConstraintManager::SketchSolver_ConstraintGroup
119 /** \brief New group based on specified workplane
121 SketchSolver_ConstraintGroup(boost::shared_ptr<SketchPlugin_Sketch> theWorkplane);
123 ~SketchSolver_ConstraintGroup();
125 /// \brief Returns group's unique identifier
126 const Slvs_hGroup& getId() const
129 /** \brief Adds or updates a constraint in the group
130 * \param[in] theConstraint constraint to be changed
131 * \return \c true if the constraint added or updated successfully
133 bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
135 /** \brief Removes a constraint into the group
136 * \param[in] theConstraint constraint to be removed
137 * \return \c true if the constraint removed successfully
139 bool removeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
141 /** \brief Verifies the constraint uses the objects from this group
142 * \param[in] theConstraint constraint for verification of interaction
143 * \return \c true if the constrained objects are used in current group
145 bool isInteract(boost::shared_ptr<SketchPlugin_Constraint> theConstraint) const;
147 /** \brief Verifies the specified workplane is the same as a base workplane for this group
148 * \param[in] theWorkplane workplane to be compared
149 * \return \c true if workplanes are the same
151 bool isBaseWorkplane(boost::shared_ptr<SketchPlugin_Sketch> theWorkplane) const;
153 boost::shared_ptr<SketchPlugin_Sketch> getWorkplane() const
156 /** \brief Update parameters of workplane. Should be called when Update event is coming.
157 * \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
159 bool updateWorkplane();
161 /** \brief If the entity is in this group it will updated
162 * \param[in] theEntity attribute, which values should update SolveSpace entity
164 void updateEntityIfPossible(boost::shared_ptr<ModelAPI_Attribute> theEntity);
166 /** \brief Start solution procedure if necessary and update attributes of features
168 void ResolveConstraints();
171 /** \brief Adds or updates an entity in the group
173 * The parameters of entity will be parsed and added to the list of SolveSpace parameters.
174 * Parameters of certain entity will be placed sequentially in the list.
176 * \param[in] theEntity the object of constraint
177 * \return identifier of changed entity or 0 if entity could not be changed
179 Slvs_hEntity changeEntity(boost::shared_ptr<ModelAPI_Attribute> theEntity);
181 /** \brief Adds or updates a normal in the group
183 * Normal is a special entity in SolveSpace, which defines a direction in 3D and
184 * a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
186 * To define a normal there should be specified two coordinate axis
187 * on the plane transversed to created normal.
189 * \param[in] theDirX first coordinate axis of the plane
190 * \param[in] theDirY second coordinate axis of the plane
191 * \param[in] theNorm attribute for the normal (used to identify newly created entity)
192 * \return identifier of created or updated normal
194 Slvs_hEntity changeNormal(boost::shared_ptr<ModelAPI_Attribute> theDirX,
195 boost::shared_ptr<ModelAPI_Attribute> theDirY,
196 boost::shared_ptr<ModelAPI_Attribute> theNorm);
198 /** \brief Adds or updates a parameter in the group
199 * \param[in] theParam the value of parameter
200 * \param[in] thePrmIter the cell in the list of parameters which should be changed
201 * (the iterator will be increased if it does not reach the end of the list)
202 * \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
204 Slvs_hParam changeParameter(const double& theParam,
205 std::vector<Slvs_Param>::const_iterator& thePrmIter);
207 /** \brief Compute constraint type according to SolveSpace identifiers
208 * and verify that constraint parameters are correct
209 * \param[in] theConstraint constraint which type should be determined
210 * \return identifier of constraint type or SLVS_C_UNKNOWN if the type is wrong
212 int getConstraintType(const boost::shared_ptr<SketchPlugin_Constraint>& theConstraint) const;
214 /** \brief Change values of attribute by parameters received from SolveSpace solver
215 * \param[in,out] theAttribute pointer to the attribute to be changed
216 * \param[in] theEntityID identifier of SolveSpace entity, which contains updated data
218 void updateAttribute(boost::shared_ptr<ModelAPI_Attribute> theAttribute, const Slvs_hEntity& theEntityID);
220 /** \brief Adds a constraint for a point which should not be changed during computations
221 * \param[in] theEntity the base for the constraint
223 void addTemporaryConstraintWhereDragged(boost::shared_ptr<ModelAPI_Attribute> theEntity);
225 /** \brief Remove all temporary constraint after computation finished
227 void removeTemporaryConstraints();
230 /** \brief Creates a workplane from the sketch parameters
231 * \param[in] theSketch parameters of workplane are the attributes of this sketch
232 * \return \c true if success, \c false if workplane parameters are not consistent
234 bool addWorkplane(boost::shared_ptr<SketchPlugin_Sketch> theSketch);
237 // SolveSpace entities
238 Slvs_hGroup myID; ///< the index of the group
239 Slvs_Entity myWorkplane; ///< Workplane for the current group
240 std::vector<Slvs_Param> myParams; ///< List of parameters of the constraints
241 Slvs_hParam myParamMaxID; ///< Actual maximal ID of parameters (not equal to myParams size)
242 std::vector<Slvs_Entity> myEntities; ///< List of entities of the constaints
243 Slvs_hEntity myEntityMaxID; ///< Actual maximal ID of entities (not equal to myEntities size)
244 std::vector<Slvs_Constraint> myConstraints; ///< List of constraints in SolveSpace format
245 Slvs_hConstraint myConstrMaxID; ///< Actual maximal ID of constraints (not equal to myConstraints size)
246 bool myNeedToSolve; ///< Indicator that something changed in the group and constraint system need to be rebuilt
248 SketchSolver_Solver myConstrSolver; ///< Solver for set of equations obtained by constraints
250 // SketchPlugin entities
251 boost::shared_ptr<SketchPlugin_Sketch> mySketch; ///< Equivalent to workplane
252 std::map<boost::shared_ptr<SketchPlugin_Constraint>, Slvs_hConstraint>
253 myConstraintMap; ///< The map between SketchPlugin and SolveSpace constraints
254 std::list<Slvs_hConstraint> myTempConstraints; ///< The list of identifiers of temporary constraints
255 std::map<boost::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity>
256 myEntityMap; ///< The map between parameters of constraints and their equivalent SolveSpace entities