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 bool changeRigidConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
67 /** \brief Verifies the feature attributes are used in this group
68 * \param[in] theFeature constraint or any other object for verification of interaction
69 * \return \c true if some of attributes are used in current group
71 bool isInteract(std::shared_ptr<SketchPlugin_Feature> theFeature) const;
73 /** \brief Verifies the specified feature is equal to the base workplane for this group
74 * \param[in] theWorkplane the feature to be compared with base workplane
75 * \return \c true if workplanes are the same
77 bool isBaseWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theWorkplane) const;
79 std::shared_ptr<ModelAPI_CompositeFeature> getWorkplane() const
84 /** \brief Update parameters of workplane. Should be called when Update event is coming.
85 * \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
87 bool updateWorkplane();
89 /** \brief If the entity is in this group it will updated
90 * \param[in] theEntity attribute, which values should update SolveSpace entity
92 void updateEntityIfPossible(std::shared_ptr<ModelAPI_Attribute> theEntity);
94 /** \brief Searches invalid features and constraints in the group and avoids them
95 * \return \c true if the group several constraints were removed
99 /** \brief Add specified group to this one
100 * \param[in] theGroup group of constraint to be added
102 void mergeGroups(const SketchSolver_ConstraintGroup& theGroup);
104 /** \brief Cut from the group several subgroups, which are not connected to the current one by any constraint
105 * \param[out] theCuts enlarge this list by newly created groups
107 void splitGroup(std::vector<SketchSolver_ConstraintGroup*>& theCuts);
109 /** \brief Start solution procedure if necessary and update attributes of features
110 * \return \c false when no need to solve constraints
112 bool resolveConstraints();
114 /** \brief Searches the constraints built on the entity and emit the signal to update them
115 * \param[in] theEntity attribute of the constraint
117 void updateRelatedConstraints(std::shared_ptr<ModelAPI_Attribute> theEntity) const;
118 void updateRelatedConstraintsFeature(std::shared_ptr<ModelAPI_Feature> theFeature) const;
120 /** \brief Adds or updates an entity in the group
122 * The parameters of entity will be parsed and added to the list of SolveSpace parameters.
123 * Parameters of certain entity will be placed sequentially in the list.
125 * \param[in] theEntity the object of constraint
126 * \return identifier of changed entity or 0 if entity could not be changed
128 Slvs_hEntity changeEntity(std::shared_ptr<ModelAPI_Attribute> theEntity);
129 Slvs_hEntity changeEntityFeature(std::shared_ptr<ModelAPI_Feature> theEntity);
132 /** \brief Adds or updates a normal in the group
134 * Normal is a special entity in SolveSpace, which defines a direction in 3D and
135 * a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
137 * To define a normal there should be specified two coordinate axis
138 * on the plane transversed to created normal.
140 * \param[in] theDirX first coordinate axis of the plane
141 * \param[in] theDirY second coordinate axis of the plane
142 * \param[in] theNorm attribute for the normal (used to identify newly created entity)
143 * \return identifier of created or updated normal
145 Slvs_hEntity changeNormal(std::shared_ptr<ModelAPI_Attribute> theDirX,
146 std::shared_ptr<ModelAPI_Attribute> theDirY,
147 std::shared_ptr<ModelAPI_Attribute> theNorm);
149 /** \brief Adds or updates a parameter in the group
150 * \param[in] theParam the value of parameter
151 * \param[in] thePrmIter the cell in the list of parameters which should be changed
152 * (the iterator will be increased if it does not reach the end of the list)
153 * \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
155 Slvs_hParam changeParameter(const double& theParam,
156 std::vector<Slvs_Param>::const_iterator& thePrmIter);
158 /** \brief Removes specified entities and their parameters
159 * \param[in] theEntities list of IDs of the entities to be removed
161 void removeEntitiesById(const std::set<Slvs_hEntity>& theEntities);
163 /** \brief Removes constraints from the group
164 * \param[in] theConstraint constraint to be removed
166 void removeConstraint(std::shared_ptr<SketchPlugin_Constraint> theConstraint);
168 /** \brief Change values of attribute by parameters received from SolveSpace solver
169 * \param[in,out] theAttribute pointer to the attribute to be changed
170 * \param[in] theEntityID identifier of SolveSpace entity, which contains updated data
171 * \return \c true if the attribute's value has changed
173 bool updateAttribute(std::shared_ptr<ModelAPI_Attribute> theAttribute,
174 const Slvs_hEntity& theEntityID);
176 /** \brief Adds a constraint for a point which should not be changed during computations
177 * \param[in] theEntity the base for the constraint
178 * \param[in] theAllowToFit this flag shows that the entity may be placed into
179 * the 'dragged' field of SolveSpace solver, so this entity
180 * may be changed a little during solution
182 void addTemporaryConstraintWhereDragged(std::shared_ptr<ModelAPI_Attribute> theEntity,
183 bool theAllowToFit = true);
185 /** \brief Remove all temporary constraint after computation finished
186 * \param[in] theRemoved indexes of constraints to be removed. If empty, all temporary constraints should be deleted
188 void removeTemporaryConstraints(const std::set<Slvs_hConstraint>& theRemoved =
189 std::set<Slvs_hConstraint>());
192 /** \brief Creates a workplane from the sketch parameters
193 * \param[in] theSketch parameters of workplane are the attributes of this sketch
194 * \return \c true if success, \c false if workplane parameters are not consistent
196 bool addWorkplane(std::shared_ptr<ModelAPI_CompositeFeature> theSketch);
198 /** \brief Add the entities of constraint for points coincidence into the appropriate list
199 * \param[in] thePoint1 identifier of the first point
200 * \param[in] thePoint2 identifier of the second point
201 * \return \c true if the points are added successfully, and
202 * \c false if the constraint is the extra one (should not be created in SolveSpace)
204 bool addCoincidentPoints(const Slvs_hEntity& thePoint1, const Slvs_hEntity& thePoint2);
206 /** \brief Verifies and changes parameters of constriant,
207 * e.g. sign of the distance between line and point
208 * \param[in,out] theConstraint SolveSpace constraint to be verified
210 void checkConstraintConsistence(Slvs_Constraint& theConstraint);
213 // SolveSpace entities
214 Slvs_hGroup myID; ///< the index of the group
215 Slvs_Entity myWorkplane; ///< Workplane for the current group
216 std::vector<Slvs_Param> myParams; ///< List of parameters of the constraints
217 Slvs_hParam myParamMaxID; ///< Actual maximal ID of parameters (not equal to myParams size)
218 std::vector<Slvs_Entity> myEntities; ///< List of entities of the constaints
219 std::vector<bool> myEntOfConstr; ///< Flags show that certain entity used in constraints
220 Slvs_hEntity myEntityMaxID; ///< Actual maximal ID of entities (not equal to myEntities size)
221 std::vector<Slvs_Constraint> myConstraints; ///< List of constraints in SolveSpace format
222 Slvs_hConstraint myConstrMaxID; ///< Actual maximal ID of constraints (not equal to myConstraints size)
223 bool myNeedToSolve; ///< Indicator that something changed in the group and constraint system need to be rebuilt
225 SketchSolver_Solver myConstrSolver; ///< Solver for set of equations obtained by constraints
227 std::vector<Slvs_hParam> myTempPointWhereDragged; ///< Parameters of one of the points which is moved by user
228 Slvs_hEntity myTempPointWDrgdID; ///< Identifier of such point
229 std::list<Slvs_hConstraint> myTempConstraints; ///< The list of identifiers of temporary constraints (SLVS_C_WHERE_DRAGGED) applied for all other points moved by user
231 // SketchPlugin entities
232 std::shared_ptr<ModelAPI_CompositeFeature> mySketch; ///< Equivalent to workplane
233 ConstraintMap myConstraintMap; ///< The map between SketchPlugin and SolveSpace constraints
234 std::map<std::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap; ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
235 std::map<FeaturePtr, Slvs_hEntity> myEntityFeatMap; ///< The map between "feature" parameters of constraints and their equivalent SolveSpace entities
238 std::vector<std::set<Slvs_hEntity> > myCoincidentPoints; ///< Stores the lists of identifiers of coincident points (to avoid unnecessary coincidence constraints)
239 std::set<std::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence; ///< Additional coincidence constraints which are not necessary (coincidence between points already done
240 ///< by other constraints) but created by GUI tools. Useful when some coincidence constraints were removed