1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: SketchSolver_Group.cpp
4 // Created: 27 May 2014
5 // Author: Artem ZHIDKOV
7 #include "SketchSolver_Group.h"
8 #include <SketchSolver_Error.h>
9 #include <SketchSolver_Manager.h>
11 #include <PlaneGCSSolver_Solver.h>
12 #include <PlaneGCSSolver_Storage.h>
13 #include <PlaneGCSSolver_Tools.h>
15 #include <Events_InfoMessage.h>
16 #include <ModelAPI_AttributeString.h>
17 #include <ModelAPI_Events.h>
18 #include <SketchPlugin_ConstraintMirror.h>
19 #include <SketchPlugin_ConstraintRigid.h>
20 #include <SketchPlugin_MultiRotation.h>
21 #include <SketchPlugin_MultiTranslation.h>
24 static void sendMessage(const char* theMessageName)
26 std::shared_ptr<Events_Message> aMessage = std::shared_ptr<Events_Message>(
27 new Events_Message(Events_Loop::eventByName(theMessageName)));
28 Events_Loop::loop()->send(aMessage);
31 static void sendMessage(const char* theMessageName, const std::set<ObjectPtr>& theConflicting)
33 std::shared_ptr<ModelAPI_SolverFailedMessage> aMessage =
34 std::shared_ptr<ModelAPI_SolverFailedMessage>(
35 new ModelAPI_SolverFailedMessage(Events_Loop::eventByName(theMessageName)));
36 aMessage->setObjects(theConflicting);
37 Events_Loop::loop()->send(aMessage);
40 static void sendMessage(const char* theMessageName,
41 const CompositeFeaturePtr& theSketch,
44 std::shared_ptr<ModelAPI_SolverFailedMessage> aMessage =
45 std::shared_ptr<ModelAPI_SolverFailedMessage>(
46 new ModelAPI_SolverFailedMessage(Events_Loop::eventByName(theMessageName)));
48 std::set<ObjectPtr> anObjects;
49 anObjects.insert(theSketch);
50 aMessage->setObjects(anObjects);
51 aMessage->dof(theDOF);
53 Events_Loop::loop()->send(aMessage);
58 // ========================================================
59 // ========= SketchSolver_Group ===============
60 // ========================================================
62 SketchSolver_Group::SketchSolver_Group(const CompositeFeaturePtr& theWorkplane)
63 : mySketch(theWorkplane),
64 myPrevResult(PlaneGCSSolver_Solver::STATUS_UNKNOWN),
66 myIsEventsBlocked(false),
67 myMultiConstraintUpdateStack(0)
69 mySketchSolver = SolverPtr(new PlaneGCSSolver_Solver);
70 myStorage = StoragePtr(new PlaneGCSSolver_Storage(mySketchSolver));
73 SketchSolver_Group::~SketchSolver_Group()
75 myConstraints.clear();
76 // send the message that there is no more conflicting constraints
77 if (!myConflictingConstraints.empty()) {
78 sendMessage(EVENT_SOLVER_REPAIRED, myConflictingConstraints);
79 myConflictingConstraints.clear();
83 // ============================================================================
84 // Function: changeConstraint
85 // Class: SketchSolver_Group
86 // Purpose: create/update the constraint in the group
87 // ============================================================================
88 bool SketchSolver_Group::changeConstraint(
89 std::shared_ptr<SketchPlugin_Constraint> theConstraint)
91 bool isNewConstraint = myConstraints.find(theConstraint) == myConstraints.end();
92 if (isNewConstraint) {
93 // Add constraint to the current group
94 SolverConstraintPtr aConstraint = PlaneGCSSolver_Tools::createConstraint(theConstraint);
97 aConstraint->process(myStorage, myIsEventsBlocked);
98 if (!aConstraint->error().empty()) {
99 if (aConstraint->error() == SketchSolver_Error::NOT_INITIALIZED())
100 return false; // some attribute are not initialized yet, don't show message
101 Events_InfoMessage("SketchSolver_Group", aConstraint->error(), this).send();
103 myConstraints[theConstraint] = aConstraint;
106 myConstraints[theConstraint]->update();
108 // constraint is created/updated => reset stack of "multi" constraints updates
109 myMultiConstraintUpdateStack = 0;
113 bool SketchSolver_Group::updateFeature(FeaturePtr theFeature)
115 return myStorage->update(theFeature);
118 bool SketchSolver_Group::moveFeature(FeaturePtr theFeature)
120 bool isFeatureExists = (myStorage->entity(theFeature).get() != 0);
121 if (myDOF == 0 && isFeatureExists) {
122 // avoid moving elements of fully constrained sketch
123 myStorage->refresh();
127 // Create temporary Fixed constraint
128 std::shared_ptr<SketchSolver_ConstraintFixed> aConstraint =
129 PlaneGCSSolver_Tools::createMovementConstraint(theFeature);
132 SolverConstraintPtr(aConstraint)->process(myStorage, myIsEventsBlocked);
133 if (aConstraint->error().empty()) {
134 setTemporary(aConstraint);
135 if (!myStorage->isEmpty())
136 myStorage->setNeedToResolve(true);
138 mySketchSolver->initialize();
139 aConstraint->moveFeature();
142 // notify all observers that theFeature has been changed
143 myStorage->notify(theFeature);
147 // ============================================================================
148 // Function: resolveConstraints
149 // Class: SketchSolver_Group
150 // Purpose: solve the set of constraints for the current group
151 // ============================================================================
152 bool SketchSolver_Group::resolveConstraints()
154 static const int MAX_STACK_SIZE = 5;
155 // check the "Multi" constraints do not drop sketch into infinite loop
156 if (myMultiConstraintUpdateStack > MAX_STACK_SIZE) {
157 myMultiConstraintUpdateStack = 0;
158 myPrevResult = PlaneGCSSolver_Solver::STATUS_FAILED;
159 // generate error message due to loop update of the sketch
160 getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
161 ->setValue(SketchSolver_Error::INFINITE_LOOP());
162 sendMessage(EVENT_SOLVER_FAILED, myConflictingConstraints);
166 bool aResolved = false;
167 bool isGroupEmpty = isEmpty() && myStorage->isEmpty();
168 if (myStorage->isNeedToResolve() &&
169 (!isGroupEmpty || !myConflictingConstraints.empty() ||
170 myPrevResult == PlaneGCSSolver_Solver::STATUS_FAILED)) {
172 PlaneGCSSolver_Solver::SolveStatus aResult = PlaneGCSSolver_Solver::STATUS_OK;
175 aResult = mySketchSolver->solve();
176 if (aResult == PlaneGCSSolver_Solver::STATUS_FAILED &&
177 !myTempConstraints.empty()) {
178 mySketchSolver->undo();
179 removeTemporaryConstraints();
180 aResult = mySketchSolver->solve();
183 getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
184 ->setValue(SketchSolver_Error::SOLVESPACE_CRASH());
185 if (myPrevResult == PlaneGCSSolver_Solver::STATUS_OK ||
186 myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN) {
187 // the error message should be changed before sending the message
188 sendMessage(EVENT_SOLVER_FAILED);
189 myPrevResult = PlaneGCSSolver_Solver::STATUS_FAILED;
191 mySketchSolver->undo();
194 // solution succeeded, store results into correspondent attributes
195 if (aResult == PlaneGCSSolver_Solver::STATUS_OK ||
196 aResult == PlaneGCSSolver_Solver::STATUS_EMPTYSET) {
197 myStorage->setNeedToResolve(false);
198 myStorage->refresh();
200 // additional check that copied entities used in Mirror and other "Multi" constraints
201 // is not connected with their originals by constraints.
202 myMultiConstraintUpdateStack += 1;
204 if (myStorage->isNeedToResolve())
205 aResolved = resolveConstraints();
208 myMultiConstraintUpdateStack -= 1;
210 if (myPrevResult != PlaneGCSSolver_Solver::STATUS_OK ||
211 myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN) {
212 getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())->setValue("");
213 std::set<ObjectPtr> aConflicting = myConflictingConstraints;
214 myConflictingConstraints.clear();
215 myPrevResult = PlaneGCSSolver_Solver::STATUS_OK;
216 // the error message should be changed before sending the message
217 sendMessage(EVENT_SOLVER_REPAIRED, aConflicting);
221 // show degrees of freedom
224 mySketchSolver->undo();
225 if (!myConstraints.empty()) {
226 // the error message should be changed before sending the message
227 getWorkplane()->string(SketchPlugin_Sketch::SOLVER_ERROR())
228 ->setValue(SketchSolver_Error::CONSTRAINTS());
229 if (myPrevResult != aResult ||
230 myPrevResult == PlaneGCSSolver_Solver::STATUS_UNKNOWN ||
231 myPrevResult == PlaneGCSSolver_Solver::STATUS_FAILED) {
232 // Obtain list of conflicting constraints
233 std::set<ObjectPtr> aConflicting = myStorage->getConflictingConstraints(mySketchSolver);
235 if (!myConflictingConstraints.empty()) {
236 std::set<ObjectPtr>::iterator anIt = aConflicting.begin();
237 for (; anIt != aConflicting.end(); ++anIt)
238 myConflictingConstraints.erase(*anIt);
239 if (!myConflictingConstraints.empty()) {
240 // some constraints does not conflict, send corresponding message
241 sendMessage(EVENT_SOLVER_REPAIRED, myConflictingConstraints);
244 myConflictingConstraints = aConflicting;
245 if (!myConflictingConstraints.empty())
246 sendMessage(EVENT_SOLVER_FAILED, myConflictingConstraints);
247 myPrevResult = aResult;
252 } else if (isGroupEmpty && isWorkplaneValid())
254 removeTemporaryConstraints();
255 myStorage->setNeedToResolve(false);
259 // ============================================================================
260 // Function: computeDoF
261 // Class: SketchSolver_Group
262 // Purpose: compute DoF of the sketch and set corresponding field
263 // ============================================================================
264 void SketchSolver_Group::computeDoF()
266 std::ostringstream aDoFMsg;
267 int aDoF = mySketchSolver->dof();
268 /// "DoF = 0" content of string value is used in PartSet by Sketch edit
269 /// If it is changed, it should be corrected also there
271 aDoFMsg << "Sketch is fully fixed (DoF = 0)";
273 aDoFMsg << "DoF (degrees of freedom) = " << aDoF;
274 mySketch->string(SketchPlugin_Sketch::SOLVER_DOF())->setValue(aDoFMsg.str());
276 if (aDoF > 0 && myDOF == 0)
277 sendMessage(EVENT_SKETCH_UNDER_CONSTRAINED, mySketch, aDoF);
278 else if (aDoF == 0 && myDOF > 0)
279 sendMessage(EVENT_SKETCH_FULLY_CONSTRAINED, mySketch, aDoF);
281 sendMessage(EVENT_SKETCH_OVER_CONSTRAINED, mySketch, aDoF);
286 // ============================================================================
287 // Function: repairConsistency
288 // Class: SketchSolver_Group
289 // Purpose: search removed entities and constraints
290 // ============================================================================
291 void SketchSolver_Group::repairConsistency()
293 if (!areConstraintsValid() || !myStorage->areFeaturesValid()) {
294 // remove invalid constraints
295 std::set<ConstraintPtr> anInvalidConstraints;
296 ConstraintConstraintMap::iterator aCIter = myConstraints.begin();
297 for (; aCIter != myConstraints.end(); ++aCIter) {
298 if (!aCIter->first->data() || !aCIter->first->data()->isValid())
299 anInvalidConstraints.insert(aCIter->first);
301 std::set<ConstraintPtr>::const_iterator aRemoveIt = anInvalidConstraints.begin();
302 for (; aRemoveIt != anInvalidConstraints.end(); ++aRemoveIt)
303 removeConstraint(*aRemoveIt);
305 // remove invalid features
306 myStorage->removeInvalidEntities();
313 // ============================================================================
314 // Function: removeTemporaryConstraints
315 // Class: SketchSolver_Group
316 // Purpose: remove all transient SLVS_C_WHERE_DRAGGED constraints after
317 // resolving the set of constraints
318 // ============================================================================
319 void SketchSolver_Group::removeTemporaryConstraints()
321 if (!myTempConstraints.empty()) {
322 mySketchSolver->removeConstraint(CID_MOVEMENT);
324 std::set<SolverConstraintPtr>::iterator aTmpIt = myTempConstraints.begin();
325 for (; aTmpIt != myTempConstraints.end(); ++aTmpIt)
328 myTempConstraints.clear();
331 myStorage->setNeedToResolve(false);
334 // ============================================================================
335 // Function: removeConstraint
336 // Class: SketchSolver_Group
337 // Purpose: remove constraint and all unused entities
338 // ============================================================================
339 void SketchSolver_Group::removeConstraint(ConstraintPtr theConstraint)
341 ConstraintConstraintMap::iterator aCIter = myConstraints.begin();
342 for (; aCIter != myConstraints.end(); aCIter++)
343 if (aCIter->first == theConstraint) {
344 aCIter->second->remove(); // the constraint is not fully removed
346 // constraint is removed => reset stack of "multi" constraints updates
347 myMultiConstraintUpdateStack = 0;
350 if (aCIter != myConstraints.end())
351 myConstraints.erase(aCIter);
354 // ============================================================================
355 // Function: setTemporary
356 // Class: SketchSolver_Group
357 // Purpose: append given constraint to the group of temporary constraints
358 // ============================================================================
359 void SketchSolver_Group::setTemporary(SolverConstraintPtr theConstraint)
361 myTempConstraints.insert(theConstraint);
364 // ============================================================================
365 // Function: blockEvents
366 // Class: SketchSolver_Group
367 // Purpose: block or unblock events from features in this group
368 // ============================================================================
369 void SketchSolver_Group::blockEvents(bool isBlocked)
371 if (myIsEventsBlocked == isBlocked)
374 // block/unblock events from the features in the storage
375 myStorage->blockEvents(isBlocked);
377 // block/unblock events from constraints
378 ConstraintConstraintMap::iterator aCIt = myConstraints.begin();
379 for (; aCIt != myConstraints.end(); ++aCIt)
380 aCIt->second->blockEvents(isBlocked);
382 myIsEventsBlocked = isBlocked;
385 bool SketchSolver_Group::areConstraintsValid() const
387 // Check the constraints are valid
388 ConstraintConstraintMap::const_iterator aCIter = myConstraints.begin();
389 for (; aCIter != myConstraints.end(); ++aCIter)
390 if (!aCIter->first->data() || !aCIter->first->data()->isValid())