1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketchSolver_ConstraintGroup.h
4 // Created: 27 May 2014
5 // Author: Artem ZHIDKOV
7 #ifndef SketchSolver_ConstraintGroup_H_
8 #define SketchSolver_ConstraintGroup_H_
10 #include "SketchSolver.h"
11 #include <SketchSolver_Solver.h>
13 #include <SketchPlugin_Constraint.h>
14 #include <ModelAPI_Data.h>
15 #include <ModelAPI_Feature.h>
24 typedef std::map< std::shared_ptr<SketchPlugin_Constraint>, std::vector<Slvs_hConstraint> >
27 /** \class SketchSolver_ConstraintGroup
29 * \brief Keeps the group of constraints which based on the same entities
31 class SketchSolver_ConstraintGroup
34 /** \brief New group based on specified workplane.
35 * Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
36 * \remark Type of theSketch is not verified inside
38 SketchSolver_ConstraintGroup(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane);
40 ~SketchSolver_ConstraintGroup();
42 /// \brief Returns group's unique identifier
43 inline const Slvs_hGroup& getId() const
48 /// \brief Returns true if the group has no constraints yet
49 inline bool isEmpty() const
51 return myConstraints.empty();
54 /// \brief Check for valid sketch data
55 inline bool isWorkplaneValid() const
57 return mySketch->data() && mySketch->data()->isValid();
60 /** \brief Adds or updates a constraint in the group
61 * \param[in] theConstraint constraint to be changed
62 * \return \c true if the constraint added or updated successfully
64 bool changeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
65 /** \brief Adds or updates a rigid constraint in the group
66 * \param[in] theConstraint constraint to be changed
67 * \return \c true if the constraint added or updated successfully
69 bool changeRigidConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
70 /** \brief Adds or updates a mirror constraint in the group
71 * \param[in] theConstraint constraint to be changed
72 * \return \c true if the constraint added or updated successfully
74 bool changeMirrorConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
76 /** \brief Verifies the feature attributes are used in this group
77 * \param[in] theFeature constraint or any other object for verification of interaction
78 * \return \c true if some of attributes are used in current group
80 bool isInteract(std::shared_ptr<SketchPlugin_Feature> theFeature) const;
82 /** \brief Verifies the specified feature is equal to the base workplane for this group
83 * \param[in] theWorkplane the feature to be compared with base workplane
84 * \return \c true if workplanes are the same
86 bool isBaseWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
88 /// Returns the current workplane
89 std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
94 /** \brief Update parameters of workplane. Should be called when Update event is coming.
95 * \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
97 bool updateWorkplane();
99 /** \brief If the entity is in this group it will updated
100 * \param[in] theEntity attribute, which values should update SolveSpace entity
102 void updateEntityIfPossible(std::shared_ptr<ModelAPI_Attribute> theEntity);
104 /** \brief Searches invalid features and constraints in the group and avoids them
105 * \return \c true if the group several constraints were removed
109 /** \brief Add specified group to this one
110 * \param[in] theGroup group of constraint to be added
112 void mergeGroups(const SketchSolver_ConstraintGroup& theGroup);
114 /** \brief Cut from the group several subgroups, which are not connected to the current one by any constraint
115 * \param[out] theCuts enlarge this list by newly created groups
117 void splitGroup(std::vector<SketchSolver_ConstraintGroup*>& theCuts);
119 /** \brief Start solution procedure if necessary and update attributes of features
120 * \return \c false when no need to solve constraints
122 bool resolveConstraints();
124 /** \brief Searches the constraints built on the entity and emit the signal to update them
125 * \param[in] theEntity attribute of the constraint
127 void updateRelatedConstraints(std::shared_ptr<ModelAPI_Attribute> theEntity) const;
128 /** \brief Searches the constraints built on the entity and emit the signal to update them
129 * \param[in] theFeature feature of the constraint
131 void updateRelatedConstraintsFeature(std::shared_ptr<ModelAPI_Feature> theFeature) const;
133 /** \brief Adds or updates an entity in the group
135 * The parameters of entity will be parsed and added to the list of SolveSpace parameters.
136 * Parameters of certain entity will be placed sequentially in the list.
138 * \param[in] theEntity the object of constraint
139 * \return identifier of changed entity or 0 if entity could not be changed
141 Slvs_hEntity changeEntity(std::shared_ptr<ModelAPI_Attribute> theEntity);
142 Slvs_hEntity changeEntityFeature(std::shared_ptr<ModelAPI_Feature> theEntity);
145 /** \brief Adds or updates a normal in the group
147 * Normal is a special entity in SolveSpace, which defines a direction in 3D and
148 * a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
150 * To define a normal there should be specified two coordinate axis
151 * on the plane transversed to created normal.
153 * \param[in] theDirX first coordinate axis of the plane
154 * \param[in] theDirY second coordinate axis of the plane
155 * \param[in] theNorm attribute for the normal (used to identify newly created entity)
156 * \return identifier of created or updated normal
158 Slvs_hEntity changeNormal(std::shared_ptr<ModelAPI_Attribute> theDirX,
159 std::shared_ptr<ModelAPI_Attribute> theDirY,
160 std::shared_ptr<ModelAPI_Attribute> theNorm);
162 /** \brief Adds or updates a parameter in the group
163 * \param[in] theParam the value of parameter
164 * \param[in] thePrmIter the cell in the list of parameters which should be changed
165 * (the iterator will be increased if it does not reach the end of the list)
166 * \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
168 Slvs_hParam changeParameter(const double& theParam,
169 std::vector<Slvs_Param>::const_iterator& thePrmIter);
171 /** \brief Removes specified entities and their parameters
172 * \param[in] theEntities list of IDs of the entities to be removed
174 void removeEntitiesById(const std::set<Slvs_hEntity>& theEntities);
176 /** \brief Removes constraints from the group
177 * \param[in] theConstraint constraint to be removed
179 void removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
181 /** \brief Change values of attribute by parameters received from SolveSpace solver
182 * \param[in,out] theAttribute pointer to the attribute to be changed
183 * \param[in] theEntityID identifier of SolveSpace entity, which contains updated data
184 * \return \c true if the attribute's value has changed
186 bool updateAttribute(std::shared_ptr<ModelAPI_Attribute> theAttribute,
187 const Slvs_hEntity& theEntityID);
189 /** \brief Adds a constraint for a point which should not be changed during computations
190 * \param[in] theEntity the base for the constraint
191 * \param[in] theAllowToFit this flag shows that the entity may be placed into
192 * the 'dragged' field of SolveSpace solver, so this entity
193 * may be changed a little during solution
195 void addTemporaryConstraintWhereDragged(std::shared_ptr<ModelAPI_Attribute> theEntity,
196 bool theAllowToFit = true);
198 /** \brief Remove all temporary constraint after computation finished
199 * \param[in] theRemoved indexes of constraints to be removed. If empty, all temporary constraints should be deleted
201 void removeTemporaryConstraints(const std::set<Slvs_hConstraint>& theRemoved =
202 std::set<Slvs_hConstraint>());
205 /** \brief Creates a workplane from the sketch parameters
206 * \param[in] theSketch parameters of workplane are the attributes of this sketch
207 * \return \c true if success, \c false if workplane parameters are not consistent
209 bool addWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
211 /** \brief Add the entities of constraint for points coincidence into the appropriate list
212 * \param[in] thePoint1 identifier of the first point
213 * \param[in] thePoint2 identifier of the second point
214 * \return \c true if the points are added successfully, and
215 * \c false if the constraint is the extra one (should not be created in SolveSpace)
217 bool addCoincidentPoints(const Slvs_hEntity& thePoint1, const Slvs_hEntity& thePoint2);
219 /** \brief Verifies and changes parameters of constriant,
220 * e.g. sign of the distance between line and point
221 * \param[in,out] theConstraint SolveSpace constraint to be verified
223 void checkConstraintConsistence(Slvs_Constraint& theConstraint);
226 // SolveSpace entities
227 Slvs_hGroup myID; ///< the index of the group
228 Slvs_Entity myWorkplane; ///< Workplane for the current group
229 std::vector<Slvs_Param> myParams; ///< List of parameters of the constraints
230 Slvs_hParam myParamMaxID; ///< Actual maximal ID of parameters (not equal to myParams size)
231 std::vector<Slvs_Entity> myEntities; ///< List of entities of the constaints
232 std::vector<bool> myEntOfConstr; ///< Flags show that certain entity used in constraints
233 Slvs_hEntity myEntityMaxID; ///< Actual maximal ID of entities (not equal to myEntities size)
234 std::vector<Slvs_Constraint> myConstraints; ///< List of constraints in SolveSpace format
235 Slvs_hConstraint myConstrMaxID; ///< Actual maximal ID of constraints (not equal to myConstraints size)
236 bool myNeedToSolve; ///< Indicator that something changed in the group and constraint system need to be rebuilt
238 SketchSolver_Solver myConstrSolver; ///< Solver for set of equations obtained by constraints
240 std::vector<Slvs_hParam> myTempPointWhereDragged; ///< Parameters of one of the points which is moved by user
241 Slvs_hEntity myTempPointWDrgdID; ///< Identifier of such point
242 std::list<Slvs_hConstraint> myTempConstraints; ///< The list of identifiers of temporary constraints (SLVS_C_WHERE_DRAGGED) applied for all other points moved by user
244 // SketchPlugin entities
245 std::shared_ptr<ModelAPI_CompositeFeature> mySketch; ///< Equivalent to workplane
246 ConstraintMap myConstraintMap; ///< The map between SketchPlugin and SolveSpace constraints
247 std::map<std::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap; ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
248 std::map<FeaturePtr, Slvs_hEntity> myEntityFeatMap; ///< The map between "feature" parameters of constraints and their equivalent SolveSpace entities
251 std::vector<std::set<Slvs_hEntity> > myCoincidentPoints; ///< Stores the lists of identifiers of coincident points (to avoid unnecessary coincidence constraints)
252 std::set<std::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence; ///< Additional coincidence constraints which are not necessary (coincidence between points already done
253 ///< by other constraints) but created by GUI tools. Useful when some coincidence constraints were removed