1 // File: SketchSolver_ConstraintGroup.h
2 // Created: 27 May 2014
3 // Author: Artem ZHIDKOV
5 #ifndef SketchSolver_ConstraintGroup_H_
6 #define SketchSolver_ConstraintGroup_H_
8 #include "SketchSolver.h"
9 #include <SketchSolver_Solver.h>
11 #include <SketchPlugin_Constraint.h>
12 #include <ModelAPI_Data.h>
19 typedef std::map< boost::shared_ptr<SketchPlugin_Constraint>, std::vector<Slvs_hConstraint> >
22 /** \class SketchSolver_ConstraintGroup
24 * \brief Keeps the group of constraints which based on the same entities
26 class SketchSolver_ConstraintGroup
29 /** \brief New group based on specified workplane.
30 * Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
31 * \remark Type of theSketch is not verified inside
33 SketchSolver_ConstraintGroup(boost::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
35 ~SketchSolver_ConstraintGroup();
37 /// \brief Returns group's unique identifier
38 inline const Slvs_hGroup& getId() const
43 /// \brief Returns true if the group has no constraints yet
44 inline bool isEmpty() const
46 return myConstraints.empty();
49 /// \brief Check for valid sketch data
50 inline bool isWorkplaneValid() const
52 return mySketch->data() && mySketch->data()->isValid();
55 /** \brief Adds or updates a constraint in the group
56 * \param[in] theConstraint constraint to be changed
57 * \return \c true if the constraint added or updated successfully
59 bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
60 bool changeRigidConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
62 /** \brief Verifies the feature attributes are used in this group
63 * \param[in] theFeature constraint or any other object for verification of interaction
64 * \return \c true if some of attributes are used in current group
66 bool isInteract(boost::shared_ptr<SketchPlugin_Feature> theFeature) const;
68 /** \brief Verifies the specified feature is equal to the base workplane for this group
69 * \param[in] theWorkplane the feature to be compared with base workplane
70 * \return \c true if workplanes are the same
72 bool isBaseWorkplane(boost::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
74 boost::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
79 /** \brief Update parameters of workplane. Should be called when Update event is coming.
80 * \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
82 bool updateWorkplane();
84 /** \brief If the entity is in this group it will updated
85 * \param[in] theEntity attribute, which values should update SolveSpace entity
87 void updateEntityIfPossible(boost::shared_ptr<ModelAPI_Attribute> theEntity);
89 /** \brief Searches invalid features and constraints in the group and avoids them
90 * \return \c true if the group several constraints were removed
94 /** \brief Add specified group to this one
95 * \param[in] theGroup group of constraint to be added
97 void mergeGroups(const SketchSolver_ConstraintGroup& theGroup);
99 /** \brief Cut from the group several subgroups, which are not connected to the current one by any constraint
100 * \param[out] theCuts enlarge this list by newly created groups
102 void splitGroup(std::vector<SketchSolver_ConstraintGroup*>& theCuts);
104 /** \brief Start solution procedure if necessary and update attributes of features
105 * \return \c false when no need to solve constraints
107 bool resolveConstraints();
109 /** \brief Searches the constraints built on the entity and emit the signal to update them
110 * \param[in] theEntity attribute of the constraint
112 void updateRelatedConstraints(boost::shared_ptr<ModelAPI_Attribute> theEntity) const;
113 void updateRelatedConstraints(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
115 /** \brief Adds or updates an entity in the group
117 * The parameters of entity will be parsed and added to the list of SolveSpace parameters.
118 * Parameters of certain entity will be placed sequentially in the list.
120 * \param[in] theEntity the object of constraint
121 * \return identifier of changed entity or 0 if entity could not be changed
123 Slvs_hEntity changeEntity(boost::shared_ptr<ModelAPI_Attribute> theEntity);
124 Slvs_hEntity changeEntity(FeaturePtr theEntity);
127 /** \brief Adds or updates a normal in the group
129 * Normal is a special entity in SolveSpace, which defines a direction in 3D and
130 * a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
132 * To define a normal there should be specified two coordinate axis
133 * on the plane transversed to created normal.
135 * \param[in] theDirX first coordinate axis of the plane
136 * \param[in] theDirY second coordinate axis of the plane
137 * \param[in] theNorm attribute for the normal (used to identify newly created entity)
138 * \return identifier of created or updated normal
140 Slvs_hEntity changeNormal(boost::shared_ptr<ModelAPI_Attribute> theDirX,
141 boost::shared_ptr<ModelAPI_Attribute> theDirY,
142 boost::shared_ptr<ModelAPI_Attribute> theNorm);
144 /** \brief Adds or updates a parameter in the group
145 * \param[in] theParam the value of parameter
146 * \param[in] thePrmIter the cell in the list of parameters which should be changed
147 * (the iterator will be increased if it does not reach the end of the list)
148 * \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
150 Slvs_hParam changeParameter(const double& theParam,
151 std::vector<Slvs_Param>::const_iterator& thePrmIter);
153 /** \brief Removes specified entities and their parameters
154 * \param[in] theEntities list of IDs of the entities to be removed
156 void removeEntitiesById(const std::set<Slvs_hEntity>& theEntities);
158 /** \brief Removes constraints from the group
159 * \param[in] theConstraint constraint to be removed
161 void removeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
163 /** \brief Change values of attribute by parameters received from SolveSpace solver
164 * \param[in,out] theAttribute pointer to the attribute to be changed
165 * \param[in] theEntityID identifier of SolveSpace entity, which contains updated data
166 * \return \c true if the attribute's value has changed
168 bool updateAttribute(boost::shared_ptr<ModelAPI_Attribute> theAttribute,
169 const Slvs_hEntity& theEntityID);
171 /** \brief Adds a constraint for a point which should not be changed during computations
172 * \param[in] theEntity the base for the constraint
173 * \param[in] theAllowToFit this flag shows that the entity may be placed into
174 * the 'dragged' field of SolveSpace solver, so this entity
175 * may be changed a little during solution
177 void addTemporaryConstraintWhereDragged(boost::shared_ptr<ModelAPI_Attribute> theEntity,
178 bool theAllowToFit = true);
180 /** \brief Remove all temporary constraint after computation finished
181 * \param[in] theRemoved indexes of constraints to be removed. If empty, all temporary constraints should be deleted
183 void removeTemporaryConstraints(const std::set<Slvs_hConstraint>& theRemoved =
184 std::set<Slvs_hConstraint>());
187 /** \brief Creates a workplane from the sketch parameters
188 * \param[in] theSketch parameters of workplane are the attributes of this sketch
189 * \return \c true if success, \c false if workplane parameters are not consistent
191 bool addWorkplane(boost::shared_ptr<ModelAPI_CompositeFeature> theSketch);
193 /** \brief Add the entities of constraint for points coincidence into the appropriate list
194 * \param[in] thePoint1 identifier of the first point
195 * \param[in] thePoint2 identifier of the second point
196 * \return \c true if the points are added successfully, and
197 * \c false if the constraint is the extra one (should not be created in SolveSpace)
199 bool addCoincidentPoints(const Slvs_hEntity& thePoint1, const Slvs_hEntity& thePoint2);
201 /** \brief Verifies and changes parameters of constriant,
202 * e.g. sign of the distance between line and point
203 * \param[in,out] theConstraint SolveSpace constraint to be verified
205 void checkConstraintConsistence(Slvs_Constraint& theConstraint);
208 // SolveSpace entities
209 Slvs_hGroup myID; ///< the index of the group
210 Slvs_Entity myWorkplane; ///< Workplane for the current group
211 std::vector<Slvs_Param> myParams; ///< List of parameters of the constraints
212 Slvs_hParam myParamMaxID; ///< Actual maximal ID of parameters (not equal to myParams size)
213 std::vector<Slvs_Entity> myEntities; ///< List of entities of the constaints
214 std::vector<bool> myEntOfConstr; ///< Flags show that certain entity used in constraints
215 Slvs_hEntity myEntityMaxID; ///< Actual maximal ID of entities (not equal to myEntities size)
216 std::vector<Slvs_Constraint> myConstraints; ///< List of constraints in SolveSpace format
217 Slvs_hConstraint myConstrMaxID; ///< Actual maximal ID of constraints (not equal to myConstraints size)
218 bool myNeedToSolve; ///< Indicator that something changed in the group and constraint system need to be rebuilt
220 SketchSolver_Solver myConstrSolver; ///< Solver for set of equations obtained by constraints
222 std::vector<Slvs_hParam> myTempPointWhereDragged; ///< Parameters of one of the points which is moved by user
223 Slvs_hEntity myTempPointWDrgdID; ///< Identifier of such point
224 std::list<Slvs_hConstraint> myTempConstraints; ///< The list of identifiers of temporary constraints (SLVS_C_WHERE_DRAGGED) applied for all other points moved by user
226 // SketchPlugin entities
227 boost::shared_ptr<ModelAPI_CompositeFeature> mySketch; ///< Equivalent to workplane
228 ConstraintMap myConstraintMap; ///< The map between SketchPlugin and SolveSpace constraints
229 std::map<boost::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap; ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
230 std::map<FeaturePtr, Slvs_hEntity> myEntityFeatMap; ///< The map between "feature" parameters of constraints and their equivalent SolveSpace entities
233 std::vector<std::set<Slvs_hEntity> > myCoincidentPoints; ///< Stores the lists of identifiers of coincident points (to avoid unnecessary coincidence constraints)
234 std::set<boost::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence; ///< Additional coincidence constraints which are not necessary (coincidence between points already done
235 ///< by other constraints) but created by GUI tools. Useful when some coincidence constraints were removed