1 // File: Model_Update.cxx
2 // Created: 25 Jun 2014
3 // Author: Mikhail PONIKAROV
5 #include <Model_Update.h>
6 #include <Model_Document.h>
7 #include <Model_Data.h>
8 #include <ModelAPI_Feature.h>
9 #include <ModelAPI_Data.h>
10 #include <ModelAPI_Document.h>
11 #include <ModelAPI_Events.h>
12 #include <ModelAPI_AttributeReference.h>
13 #include <ModelAPI_AttributeRefList.h>
14 #include <ModelAPI_AttributeRefAttr.h>
15 #include <ModelAPI_AttributeSelection.h>
16 #include <ModelAPI_AttributeSelectionList.h>
17 #include <ModelAPI_Result.h>
18 #include <ModelAPI_Validator.h>
19 #include <ModelAPI_CompositeFeature.h>
20 #include <ModelAPI_Session.h>
21 #include <Events_Loop.h>
22 #include <Events_LongOp.h>
23 #include <Events_Error.h>
24 #include <Config_PropManager.h>
28 Model_Update MY_UPDATER_INSTANCE; /// the only one instance initialized on load of the library
30 Model_Update::Model_Update()
32 Events_Loop* aLoop = Events_Loop::loop();
33 static const Events_ID kChangedEvent = aLoop->eventByName("PreferenceChanged");
34 aLoop->registerListener(this, kChangedEvent);
35 static const Events_ID kRebuildEvent = aLoop->eventByName("Rebuild");
36 aLoop->registerListener(this, kRebuildEvent);
37 static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
38 aLoop->registerListener(this, kCreatedEvent);
39 static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
40 aLoop->registerListener(this, kUpdatedEvent);
41 static const Events_ID kMovedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_MOVED);
42 aLoop->registerListener(this, kMovedEvent);
43 static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
44 aLoop->registerListener(this, kOpFinishEvent);
45 static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
46 aLoop->registerListener(this, kOpAbortEvent);
47 static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
48 aLoop->registerListener(this, kOpStartEvent);
50 Config_PropManager::registerProp("Model update", "automatic_rebuild", "Rebuild immediately",
51 Config_Prop::Bool, "false");
52 isAutomatic = Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
55 void Model_Update::processEvent(const std::shared_ptr<Events_Message>& theMessage)
57 static Events_Loop* aLoop = Events_Loop::loop();
58 static const Events_ID kChangedEvent = aLoop->eventByName("PreferenceChanged");
59 static const Events_ID kRebuildEvent = aLoop->eventByName("Rebuild");
60 static const Events_ID kCreatedEvent = aLoop->eventByName(EVENT_OBJECT_CREATED);
61 static const Events_ID kUpdatedEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
62 static const Events_ID kMovedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_MOVED);
63 static const Events_ID kOpFinishEvent = aLoop->eventByName("FinishOperation");
64 static const Events_ID kOpAbortEvent = aLoop->eventByName("AbortOperation");
65 static const Events_ID kOpStartEvent = aLoop->eventByName("StartOperation");
66 bool isAutomaticChanged = false;
67 if (theMessage->eventID() == kChangedEvent) { // automatic and manual rebuild flag is changed
69 Config_PropManager::findProp("Model update", "automatic_rebuild")->value() == "true";
70 } else if (theMessage->eventID() == kRebuildEvent) { // the rebuild command
71 if (isAutomatic == false) {
72 isAutomaticChanged = true;
75 } else if (theMessage->eventID() == kCreatedEvent || theMessage->eventID() == kUpdatedEvent ||
76 theMessage->eventID() == kMovedEvent) {
77 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aMsg =
78 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
79 const std::set<ObjectPtr>& anObjs = aMsg->objects();
80 std::set<ObjectPtr>::const_iterator anObjIter = anObjs.cbegin();
81 for(; anObjIter != anObjs.cend(); anObjIter++) {
82 myJustCreatedOrUpdated.insert(*anObjIter);
84 if (theMessage->eventID() == kMovedEvent)
85 return; // this event is for solver update, not here
86 } else if (theMessage->eventID() == kOpStartEvent) {
87 myJustCreatedOrUpdated.clear();
88 return; // we don't need the update only on operation start (caused problems in PartSet_Listener::processEvent)
89 } else if (theMessage->eventID() == kOpFinishEvent || theMessage->eventID() == kOpAbortEvent) {
90 if (isAutomatic == false) { // Apply button now works as "Rebuild"
91 isAutomaticChanged = true;
94 // the hardcode (DBC asked): hide the sketch referenced by extrusion on apply
95 if (theMessage->eventID() == kOpFinishEvent) {
96 std::set<std::shared_ptr<ModelAPI_Object> >::iterator aFIter;
97 for(aFIter = myJustCreatedOrUpdated.begin(); aFIter != myJustCreatedOrUpdated.end(); aFIter++)
99 FeaturePtr aF = std::dynamic_pointer_cast<ModelAPI_Feature>(*aFIter);
100 if (aF && aF->getKind() == "Extrusion") {
101 if (aF->selection("extrusion_face")) {
102 ResultPtr aSketchRes = aF->selection("extrusion_face")->context();
104 static Events_ID HIDE_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TOHIDE);
105 ModelAPI_EventCreator::get()->sendUpdated(aSketchRes, HIDE_DISP);
114 return; // nothing to do: it is executed now
116 //Events_LongOp::start(this);
118 std::shared_ptr<ModelAPI_ObjectUpdatedMessage> aMsg =
119 std::dynamic_pointer_cast<ModelAPI_ObjectUpdatedMessage>(theMessage);
120 if (aMsg) myInitial = aMsg->objects();
124 // iterate all documents: features in Root first, then - subs
125 updateInDoc(ModelAPI_Session::get()->moduleDocument());
128 // flush to update display
129 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
130 aLoop->flush(EVENT_DISP);
131 //Events_LongOp::end(this);
132 if (isAutomaticChanged) isAutomatic = false;
134 if (theMessage->eventID() == kOpFinishEvent || theMessage->eventID() == kOpAbortEvent) {
135 myJustCreatedOrUpdated.clear();
141 void Model_Update::updateInDoc(std::shared_ptr<ModelAPI_Document> theDoc)
143 // all features one by one
144 int aNbFeatures = theDoc->size(ModelAPI_Feature::group(), true);
145 for (int aFIndex = 0; aFIndex < aNbFeatures; aFIndex++) {
146 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
147 theDoc->object(ModelAPI_Feature::group(), aFIndex, true));
149 updateFeature(aFeature);
151 // all sub-documents one by one
152 std::shared_ptr<Model_Document> aDoc = std::dynamic_pointer_cast<Model_Document>(theDoc);
154 const std::set<std::string>& aSubs = aDoc->subDocuments();
155 for(std::set<std::string>::iterator aSub = aSubs.begin(); aSub != aSubs.end(); aSub++) {
156 DocumentPtr aSubDoc = theDoc->subDocument(*aSub);
158 updateInDoc(aSubDoc);
164 void Model_Update::redisplayWithResults(FeaturePtr theFeature, const ModelAPI_ExecState theState)
166 // make updated and redisplay all results
167 static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
168 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
169 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
170 for (; aRIter != aResults.cend(); aRIter++) {
171 std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
172 aRes->data()->execState(theState);
173 myUpdated[aRes] = true;
174 ModelAPI_EventCreator::get()->sendUpdated(aRes, EVENT_DISP);
176 // to redisplay "presentable" feature (for ex. distance constraint)
177 ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
178 theFeature->data()->execState(theState);
181 /// Updates the state by the referenced object: if something bad with it, set state for this one
182 ModelAPI_ExecState stateByReference(ObjectPtr theTarget, const ModelAPI_ExecState theCurrent)
185 ModelAPI_ExecState aRefState = theTarget->data()->execState();
186 if (aRefState == ModelAPI_StateMustBeUpdated) {
187 return ModelAPI_StateMustBeUpdated;
188 } else if (aRefState != ModelAPI_StateDone) {
189 return ModelAPI_StateInvalidArgument;
195 bool Model_Update::updateFeature(FeaturePtr theFeature)
197 // check it is already processed
198 if (myUpdated.find(theFeature) != myUpdated.end())
199 return myUpdated[theFeature];
200 // check all features this feature depended on (recursive call of updateFeature)
201 ModelAPI_ValidatorsFactory* aFactory = ModelAPI_Session::get()->validators();
202 bool aMustbeUpdated = myInitial.find(theFeature) != myInitial.end();
203 if (theFeature) { // only real feature contains references to other objects
204 if (theFeature->data()->execState() != ModelAPI_StateDone)
205 aMustbeUpdated = true;
207 // composite feature must be executed after sub-features execution
208 CompositeFeaturePtr aComposite =
209 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theFeature);
211 int aSubsNum = aComposite->numberOfSubs();
212 for(int a = 0; a < aSubsNum; a++) {
213 if (updateFeature(aComposite->subFeature(a)))
214 aMustbeUpdated = true;
217 ModelAPI_ExecState aState = ModelAPI_StateDone;
218 // check all references: if referenced objects are updated, this object also must be updated
219 // also check state of referenced objects: if they are not ready, inherit corresponding state
220 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
221 std::shared_ptr<Model_Data> aData =
222 std::dynamic_pointer_cast<Model_Data>(theFeature->data());
223 aData->referencesToObjects(aRefs);
224 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator aRef = aRefs.begin();
225 for(; aRef != aRefs.end(); aRef++) {
226 std::list<ObjectPtr>::iterator aRefObj = aRef->second.begin();
227 for(; aRefObj != aRef->second.end(); aRefObj++) {
228 if (updateObject(*aRefObj)) {
229 aMustbeUpdated = true;
231 aState = stateByReference(*aRefObj, aState);
235 //std::cout<<"Update feature "<<theFeature->getKind()<<" must be updated = "<<aMustbeUpdated<<std::endl;
236 // execute feature if it must be updated
237 if (aMustbeUpdated) {
238 if (std::dynamic_pointer_cast<Model_Document>(theFeature->document())->executeFeatures() ||
239 !theFeature->isPersistentResult()) {
240 if (aFactory->validate(theFeature)) {
242 (myJustCreatedOrUpdated.find(theFeature) != myJustCreatedOrUpdated.end()) ||
243 !theFeature->isPersistentResult() /* execute quick, not persistent results */)
245 if (aState == ModelAPI_StateDone) {// all referenced objects are ready to be used
246 //std::cout<<"Execute feature "<<theFeature->getKind()<<std::endl;
247 // before execution update the selection attributes if any
248 list<AttributePtr> aRefs =
249 theFeature->data()->attributes(ModelAPI_AttributeSelection::type());
250 list<AttributePtr>::iterator aRefsIter = aRefs.begin();
251 for (; aRefsIter != aRefs.end(); aRefsIter++) {
252 std::shared_ptr<ModelAPI_AttributeSelection> aSel =
253 std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(*aRefsIter);
254 if (!aSel->update()) { // this must be done on execution since it may be long operation
255 if (!aFactory->isNotObligatory(theFeature->getKind(), theFeature->data()->id(aSel)))
256 aState = ModelAPI_StateInvalidArgument;
259 aRefs = theFeature->data()->attributes(ModelAPI_AttributeSelectionList::type());
260 for (aRefsIter = aRefs.begin(); aRefsIter != aRefs.end(); aRefsIter++) {
261 std::shared_ptr<ModelAPI_AttributeSelectionList> aSel =
262 std::dynamic_pointer_cast<ModelAPI_AttributeSelectionList>(*aRefsIter);
263 for(int a = aSel->size() - 1; a >= 0; a--) {
264 std::shared_ptr<ModelAPI_AttributeSelection> aSelAttr =
265 std::dynamic_pointer_cast<ModelAPI_AttributeSelection>(aSel->value(a));
267 if (!aSelAttr->update()) {
268 if (!aFactory->isNotObligatory(
269 theFeature->getKind(), theFeature->data()->id(aSel)))
270 aState = ModelAPI_StateInvalidArgument;
275 // for sketch after update of plane (by update of selection attribute)
276 // but before execute, all sub-elements also must be updated (due to the plane changes)
278 int aSubsNum = aComposite->numberOfSubs();
279 for(int a = 0; a < aSubsNum; a++) {
280 FeaturePtr aSub = aComposite->subFeature(a);
281 bool aWasModified = myUpdated[aSub];
282 myUpdated.erase(myUpdated.find(aSub)); // erase to update for sure (plane may be changed)
283 myInitial.insert(aSub);
285 myUpdated[aSub] = aWasModified; // restore value
287 // re-execute after update: solver may update the previous values, so, shapes must be
289 for(int a = 0; a < aSubsNum; a++) {
290 if (aComposite->subFeature(a) && aFactory->validate(aComposite->subFeature(a)))
291 aComposite->subFeature(a)->execute();
296 // execute in try-catch to avoid internal problems of the feature
297 if (aState == ModelAPI_StateDone) {
298 theFeature->data()->execState(ModelAPI_StateDone);
300 theFeature->execute();
301 if (theFeature->data()->execState() != ModelAPI_StateDone) {
302 aState = ModelAPI_StateExecFailed;
305 aState = ModelAPI_StateExecFailed;
307 "Feature " + theFeature->getKind() + " has failed during the execution");
310 if (aState != ModelAPI_StateDone) {
311 theFeature->eraseResults();
313 redisplayWithResults(theFeature, aState);
314 } else { // must be updatet, but not updated yet
315 theFeature->data()->execState(ModelAPI_StateMustBeUpdated);
316 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
317 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
318 for (; aRIter != aResults.cend(); aRIter++) {
319 std::shared_ptr<ModelAPI_Result> aRes = *aRIter;
320 aRes->data()->execState(ModelAPI_StateMustBeUpdated);
324 theFeature->eraseResults();
325 redisplayWithResults(theFeature, ModelAPI_StateInvalidArgument); // result also must be updated
327 } else { // for automatically updated features (on abort, etc) it is necessary to redisplay anyway
328 redisplayWithResults(theFeature, ModelAPI_StateNothing);
330 } else { // returns also true is results were updated: for sketch that refers to sub-features but results of sub-features were changed
331 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = theFeature->results();
332 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
333 for (; aRIter != aResults.cend(); aRIter++) {
334 if (myInitial.find(*aRIter) != myInitial.end()) {
335 aMustbeUpdated = true;
341 myUpdated[theFeature] = aMustbeUpdated;
342 return aMustbeUpdated;
345 bool Model_Update::updateObject(std::shared_ptr<ModelAPI_Object> theObject, const bool theCyclic)
347 if (myUpdated.find(theObject) != myUpdated.end())
348 return myUpdated[theObject]; // already processed
351 if (theCyclic) { // algorithm for update of all features by dependencies tree
354 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObject);
355 if (aFeature) { // for feature just call update Feature
356 return updateFeature(aFeature);
358 // check general object, possible just a result
359 if (myUpdated.find(theObject) != myUpdated.end())
360 return myUpdated[theObject]; // already processed
361 // check the feature of this object must be executed
362 ResultPtr aResult = std::dynamic_pointer_cast<ModelAPI_Result>(theObject);
364 FeaturePtr aResFeature = aResult->document()->feature(aResult);
366 return updateFeature(aResFeature);
371 return myInitial.find(theObject) != myInitial.end();