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 /** \class SketchSolver_ConstraintGroup
21 * \brief Keeps the group of constraints which based on the same entities
23 class SketchSolver_ConstraintGroup
26 /** \brief New group based on specified workplane.
27 * Throws an exception if theWorkplane is not an object of SketchPlugin_Sketch type
28 * \remark Type of theSketch is not verified inside
30 SketchSolver_ConstraintGroup(boost::shared_ptr<SketchPlugin_Feature> theWorkplane);
32 ~SketchSolver_ConstraintGroup();
34 /// \brief Returns group's unique identifier
35 inline const Slvs_hGroup& getId() const
40 /// \brief Returns true if the group has no constraints yet
41 inline bool isEmpty() const
43 return myConstraints.empty();
46 /// \brief Check for valid sketch data
47 inline bool isWorkplaneValid() const
49 return mySketch->data() && mySketch->data()->isValid();
52 /** \brief Adds or updates a constraint in the group
53 * \param[in] theConstraint constraint to be changed
54 * \return \c true if the constraint added or updated successfully
56 bool changeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
58 /** \brief Verifies the feature attributes are used in this group
59 * \param[in] theFeature constraint or any other object for verification of interaction
60 * \return \c true if some of attributes are used in current group
62 bool isInteract(boost::shared_ptr<SketchPlugin_Feature> theFeature) const;
64 /** \brief Verifies the specified feature is equal to the base workplane for this group
65 * \param[in] theWorkplane the feature to be compared with base workplane
66 * \return \c true if workplanes are the same
68 bool isBaseWorkplane(boost::shared_ptr<SketchPlugin_Feature> theWorkplane) const;
70 boost::shared_ptr<SketchPlugin_Feature> getWorkplane() const
75 /** \brief Update parameters of workplane. Should be called when Update event is coming.
76 * \return \c true if workplane updated successfully, \c false if workplane parameters are not consistent
78 bool updateWorkplane();
80 /** \brief If the entity is in this group it will updated
81 * \param[in] theEntity attribute, which values should update SolveSpace entity
83 void updateEntityIfPossible(boost::shared_ptr<ModelAPI_Attribute> theEntity);
85 /** \brief Searches invalid features and constraints in the group and avoids them
86 * \return \c true if the group several constraints were removed
90 /** \brief Add specified group to this one
91 * \param[in] theGroup group of constraint to be added
93 void mergeGroups(const SketchSolver_ConstraintGroup& theGroup);
95 /** \brief Cut from the group several subgroups, which are not connected to the current one by any constraint
96 * \param[out] theCuts enlarge this list by newly created groups
98 void splitGroup(std::vector<SketchSolver_ConstraintGroup*>& theCuts);
100 /** \brief Start solution procedure if necessary and update attributes of features
101 * \return \c false when no need to solve constraints
103 bool resolveConstraints();
105 /** \brief Searches the constraints built on the entity and emit the signal to update them
106 * \param[in] theEntity attribute of the constraint
108 void updateRelatedConstraints(boost::shared_ptr<ModelAPI_Attribute> theEntity) const;
109 void updateRelatedConstraints(boost::shared_ptr<ModelAPI_Feature> theFeature) const;
111 /** \brief Adds or updates an entity in the group
113 * The parameters of entity will be parsed and added to the list of SolveSpace parameters.
114 * Parameters of certain entity will be placed sequentially in the list.
116 * \param[in] theEntity the object of constraint
117 * \return identifier of changed entity or 0 if entity could not be changed
119 Slvs_hEntity changeEntity(boost::shared_ptr<ModelAPI_Attribute> theEntity);
120 Slvs_hEntity changeEntity(FeaturePtr theEntity);
123 /** \brief Adds or updates a normal in the group
125 * Normal is a special entity in SolveSpace, which defines a direction in 3D and
126 * a rotation about this direction. So, SolveSpace represents normals as unit quaternions.
128 * To define a normal there should be specified two coordinate axis
129 * on the plane transversed to created normal.
131 * \param[in] theDirX first coordinate axis of the plane
132 * \param[in] theDirY second coordinate axis of the plane
133 * \param[in] theNorm attribute for the normal (used to identify newly created entity)
134 * \return identifier of created or updated normal
136 Slvs_hEntity changeNormal(boost::shared_ptr<ModelAPI_Attribute> theDirX,
137 boost::shared_ptr<ModelAPI_Attribute> theDirY,
138 boost::shared_ptr<ModelAPI_Attribute> theNorm);
140 /** \brief Adds or updates a parameter in the group
141 * \param[in] theParam the value of parameter
142 * \param[in] thePrmIter the cell in the list of parameters which should be changed
143 * (the iterator will be increased if it does not reach the end of the list)
144 * \return identifier of changed parameter; when the parameter cannot be created, returned ID is 0
146 Slvs_hParam changeParameter(const double& theParam,
147 std::vector<Slvs_Param>::const_iterator& thePrmIter);
149 /** \brief Removes constraints from the group
150 * \param[in] theConstraint constraint to be removed
152 void removeConstraint(boost::shared_ptr<SketchPlugin_Constraint> theConstraint);
154 /** \brief Change values of attribute by parameters received from SolveSpace solver
155 * \param[in,out] theAttribute pointer to the attribute to be changed
156 * \param[in] theEntityID identifier of SolveSpace entity, which contains updated data
157 * \return \c true if the attribute's value has changed
159 bool updateAttribute(boost::shared_ptr<ModelAPI_Attribute> theAttribute,
160 const Slvs_hEntity& theEntityID);
162 /** \brief Adds a constraint for a point which should not be changed during computations
163 * \param[in] theEntity the base for the constraint
165 void addTemporaryConstraintWhereDragged(boost::shared_ptr<ModelAPI_Attribute> theEntity);
167 /** \brief Remove all temporary constraint after computation finished
169 void removeTemporaryConstraints();
172 /** \brief Creates a workplane from the sketch parameters
173 * \param[in] theSketch parameters of workplane are the attributes of this sketch
174 * \return \c true if success, \c false if workplane parameters are not consistent
176 bool addWorkplane(boost::shared_ptr<SketchPlugin_Feature> theSketch);
178 /** \brief Add the entities of constraint for points coincidence into the appropriate list
179 * \param[in] thePoint1 identifier of the first point
180 * \param[in] thePoint2 identifier of the second point
181 * \return \c true if the points are added successfully, and
182 * \c false if the constraint is the extra one (should not be created in SolveSpace)
184 bool addCoincidentPoints(const Slvs_hEntity& thePoint1, const Slvs_hEntity& thePoint2);
186 /** \brief Verifies and changes parameters of constriant,
187 * e.g. sign of the distance between line and point
188 * \param[in,out] theConstraint SolveSpace constraint to be verified
190 void checkConstraintConsistence(Slvs_Constraint& theConstraint);
193 // SolveSpace entities
194 Slvs_hGroup myID; ///< the index of the group
195 Slvs_Entity myWorkplane; ///< Workplane for the current group
196 std::vector<Slvs_Param> myParams; ///< List of parameters of the constraints
197 Slvs_hParam myParamMaxID; ///< Actual maximal ID of parameters (not equal to myParams size)
198 std::vector<Slvs_Entity> myEntities; ///< List of entities of the constaints
199 Slvs_hEntity myEntityMaxID; ///< Actual maximal ID of entities (not equal to myEntities size)
200 std::vector<Slvs_Constraint> myConstraints; ///< List of constraints in SolveSpace format
201 Slvs_hConstraint myConstrMaxID; ///< Actual maximal ID of constraints (not equal to myConstraints size)
202 bool myNeedToSolve; ///< Indicator that something changed in the group and constraint system need to be rebuilt
204 SketchSolver_Solver myConstrSolver; ///< Solver for set of equations obtained by constraints
206 std::vector<Slvs_hParam> myTempPointWhereDragged; ///< Parameters of one of the points which is moved by user
207 Slvs_hEntity myTempPointWDrgdID; ///< Identifier of such point
208 std::list<Slvs_hConstraint> myTempConstraints; ///< The list of identifiers of temporary constraints (SLVS_C_WHERE_DRAGGED) applied for all other points moved by user
210 // SketchPlugin entities
211 boost::shared_ptr<SketchPlugin_Feature> mySketch; ///< Equivalent to workplane
212 std::map<boost::shared_ptr<SketchPlugin_Constraint>, Slvs_hConstraint> myConstraintMap; ///< The map between SketchPlugin and SolveSpace constraints
213 std::map<boost::shared_ptr<ModelAPI_Attribute>, Slvs_hEntity> myEntityAttrMap; ///< The map between "attribute" parameters of constraints and their equivalent SolveSpace entities
214 std::map<FeaturePtr, Slvs_hEntity> myEntityFeatMap; ///< The map between "feature" parameters of constraints and their equivalent SolveSpace entities
217 std::vector<std::set<Slvs_hEntity> > myCoincidentPoints; ///< Stores the lists of identifiers of coincident points (to avoid unnecessary coincidence constraints)
218 std::set<boost::shared_ptr<SketchPlugin_Constraint> > myExtraCoincidence; ///< Additional coincidence constraints which are not necessary (coincidence between points already done
219 ///< by other constraints) but created by GUI tools. Useful when some coincidence constraints were removed