1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Objects.cxx
4 // Created: 15 May 2015
5 // Author: Mikhail PONIKAROV
7 #include <Model_Objects.h>
8 #include <Model_Data.h>
9 #include <Model_Document.h>
10 #include <Model_Events.h>
11 #include <Model_Session.h>
12 #include <Model_ResultPart.h>
13 #include <Model_ResultConstruction.h>
14 #include <Model_ResultBody.h>
15 #include <Model_ResultGroup.h>
16 #include <Model_ResultParameter.h>
17 #include <ModelAPI_Validator.h>
18 #include <ModelAPI_CompositeFeature.h>
20 #include <Events_Loop.h>
21 #include <Events_Error.h>
23 #include <TDataStd_Integer.hxx>
24 #include <TDataStd_Comment.hxx>
25 #include <TDF_ChildIDIterator.hxx>
26 #include <TDataStd_ReferenceArray.hxx>
27 #include <TDataStd_HLabelArray1.hxx>
28 #include <TDataStd_Name.hxx>
29 #include <TDF_Reference.hxx>
30 #include <TDF_ChildIDIterator.hxx>
31 #include <TDF_LabelMapHasher.hxx>
33 static const int TAG_OBJECTS = 2; // tag of the objects sub-tree (features, results)
36 static const int TAG_FEATURE_ARGUMENTS = 1; ///< where the arguments are located
37 static const int TAG_FEATURE_RESULTS = 2; ///< where the results are located
40 /// 0:1:2 - where features are located
41 /// 0:1:2:N:1 - data of the feature N
42 /// 0:1:2:N:2:K:1 - data of the K result of the feature N
44 Model_Objects::Model_Objects(TDF_Label theMainLab) : myMain(theMainLab)
48 void Model_Objects::setOwner(DocumentPtr theDoc)
51 // update all fields and recreate features and result objects if needed
52 synchronizeFeatures(false, true, true);
56 Model_Objects::~Model_Objects()
58 // delete all features of this document
59 Events_Loop* aLoop = Events_Loop::loop();
60 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeaturesIter(myFeatures);
61 for(; aFeaturesIter.More(); aFeaturesIter.Next()) {
62 FeaturePtr aFeature = aFeaturesIter.Value();
63 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
64 ModelAPI_EventCreator::get()->sendDeleted(myDoc, ModelAPI_Feature::group());
65 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
66 aFeature->eraseResults();
70 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
71 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
75 /// Appends to the array of references a new referenced label
76 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced, TDF_Label& thePrevLab)
78 Handle(TDataStd_ReferenceArray) aRefs;
79 if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
80 aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
81 aRefs->SetValue(0, theReferenced);
82 } else { // extend array by one more element
83 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
85 int aPassedPrev = 0; // prev feature is found and passed
86 if (thePrevLab.IsNull()) { // null means that inserted feature must be the first
87 aNewArray->SetValue(aRefs->Lower(), theReferenced);
90 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
91 aNewArray->SetValue(a + aPassedPrev, aRefs->Value(a));
92 if (!aPassedPrev && aRefs->Value(a).IsEqual(thePrevLab)) {
94 aNewArray->SetValue(a + 1, theReferenced);
97 if (!aPassedPrev) // not found: unknown situation
98 aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
99 aRefs->SetInternalArray(aNewArray);
103 void Model_Objects::addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis)
105 if (!theFeature->isAction()) { // do not add action to the data model
106 TDF_Label aFeaturesLab = featuresLabel();
107 TDF_Label aFeatureLab = aFeaturesLab.NewChild();
108 // store feature in the features array: before "initData" because in macro features
109 // in initData it creates new features, appeared later than this
110 TDF_Label aPrevFeateureLab;
111 if (theAfterThis.get()) { // searching for the previous feature label
112 std::shared_ptr<Model_Data> aPrevData =
113 std::dynamic_pointer_cast<Model_Data>(theAfterThis->data());
114 if (aPrevData.get()) {
115 aPrevFeateureLab = aPrevData->label().Father();
118 AddToRefArray(aFeaturesLab, aFeatureLab, aPrevFeateureLab);
120 initData(theFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
121 // keep the feature ID to restore document later correctly
122 TDataStd_Comment::Set(aFeatureLab, theFeature->getKind().c_str());
123 myFeatures.Bind(aFeatureLab, theFeature);
124 // event: feature is added
125 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
126 ModelAPI_EventCreator::get()->sendUpdated(theFeature, anEvent);
127 theFeature->setDisabled(false); // by default created feature is enabled
128 updateHistory(ModelAPI_Feature::group());
129 } else { // make feature has not-null data anyway
130 theFeature->setData(Model_Data::invalidData());
131 theFeature->setDoc(myDoc);
135 /// Appends to the array of references a new referenced label.
136 /// If theIndex is not -1, removes element at this index, not theReferenced.
137 /// \returns the index of removed element
138 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced,
139 const int theIndex = -1)
141 int aResult = -1; // no returned
142 Handle(TDataStd_ReferenceArray) aRefs;
143 if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
144 if (aRefs->Length() == 1) { // just erase an array
145 if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
146 theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
149 } else { // reduce the array
150 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
152 int aCount = aRefs->Lower();
153 for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
154 if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
158 aNewArray->SetValue(aCount, aRefs->Value(a));
161 aRefs->SetInternalArray(aNewArray);
167 void Model_Objects::refsToFeature(FeaturePtr theFeature,
168 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
170 // check the feature: it must have no depended objects on it
171 // the dependencies can be in the feature results
172 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
173 for(; aResIter != theFeature->results().cend(); aResIter++) {
174 ResultPtr aResult = (*aResIter);
175 std::shared_ptr<Model_Data> aData =
176 std::dynamic_pointer_cast<Model_Data>(aResult->data());
177 if (aData.get() != NULL) {
178 const std::set<AttributePtr>& aRefs = aData->refsToMe();
179 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
180 for(; aRefIt != aRefLast; aRefIt++) {
181 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
182 if (aFeature.get() != NULL)
183 theRefs.insert(aFeature);
187 // the dependencies can be in the feature itself
188 std::shared_ptr<Model_Data> aData =
189 std::dynamic_pointer_cast<Model_Data>(theFeature->data());
190 if (aData && !aData->refsToMe().empty()) {
191 const std::set<AttributePtr>& aRefs = aData->refsToMe();
192 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
193 for(; aRefIt != aRefLast; aRefIt++) {
194 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
195 if (aFeature.get() != NULL)
196 theRefs.insert(aFeature);
200 if (!theRefs.empty() && isSendError) {
202 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
206 void Model_Objects::removeFeature(FeaturePtr theFeature)
208 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theFeature->data());
209 if (aData && aData->isValid()) {
210 // checking that the sub-element of composite feature is removed: if yes, inform the owner
211 std::set<std::shared_ptr<ModelAPI_Feature> > aRefs;
212 refsToFeature(theFeature, aRefs, false);
213 std::set<std::shared_ptr<ModelAPI_Feature> >::iterator aRefIter = aRefs.begin();
214 for(; aRefIter != aRefs.end(); aRefIter++) {
215 std::shared_ptr<ModelAPI_CompositeFeature> aComposite =
216 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aRefIter);
217 if (aComposite.get()) {
218 aComposite->removeFeature(theFeature);
221 // this must be before erase since theFeature erasing removes all information about
222 // the feature results and groups of results
223 // To reproduce: create sketch, extrusion, remove sketch => constructions tree is not updated
224 clearHistory(theFeature);
228 TDF_Label aFeatureLabel = aData->label().Father();
229 if (myFeatures.IsBound(aFeatureLabel))
230 myFeatures.UnBind(aFeatureLabel);
232 static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
233 ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
234 // erase all attributes under the label of feature
235 aFeatureLabel.ForgetAllAttributes();
236 // remove it from the references array
237 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
238 // event: feature is deleted
239 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
240 // the redisplay signal should be flushed in order to erase the feature presentation in the viewer
241 Events_Loop::loop()->flush(EVENT_DISP);
242 updateHistory(ModelAPI_Feature::group());
246 void Model_Objects::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
248 TDF_Label aFeaturesLab = featuresLabel();
249 Handle(TDataStd_ReferenceArray) aRefs;
250 if (!aFeaturesLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
252 TDF_Label anAfterLab, aMovedLab =
253 std::dynamic_pointer_cast<Model_Data>(theMoved->data())->label().Father();
254 if (theAfterThis.get())
255 anAfterLab = std::dynamic_pointer_cast<Model_Data>(theAfterThis->data())->label().Father();
257 Handle(TDataStd_HLabelArray1) aNewArray =
258 new TDataStd_HLabelArray1(aRefs->Lower(), aRefs->Upper());
259 int aPassedMovedFrom = 0; // the prev feature location is found and passed
260 int aPassedMovedTo = 0; // the feature is added and this location is passed
261 if (!theAfterThis.get()) { // null means that inserted feature must be the first
262 aNewArray->SetValue(aRefs->Lower(), aMovedLab);
265 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
266 if (aPassedMovedTo == 0 && aRefs->Value(a) == anAfterLab) { // add two
268 aNewArray->SetValue(a - aPassedMovedFrom, anAfterLab);
269 if (a + 1 - aPassedMovedFrom <= aRefs->Upper())
270 aNewArray->SetValue(a + 1 - aPassedMovedFrom, aMovedLab);
271 } else if (aPassedMovedFrom == 0 && aRefs->Value(a) == aMovedLab) { // skip
273 } else { // just copy one
274 if (a - aPassedMovedFrom + aPassedMovedTo <= aRefs->Upper())
275 aNewArray->SetValue(a - aPassedMovedFrom + aPassedMovedTo, aRefs->Value(a));
278 if (!aPassedMovedFrom || !aPassedMovedTo) {// not found: unknown situation
279 if (!aPassedMovedFrom) {
280 static std::string aMovedFromError("The moved feature is not found");
281 Events_Error::send(aMovedFromError);
283 static std::string aMovedToError("The 'after' feature for movement is not found");
284 Events_Error::send(aMovedToError);
288 // store the new array
289 aRefs->SetInternalArray(aNewArray);
290 // update the feature and the history
291 clearHistory(theMoved);
292 static Events_ID EVENT_UPD = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
293 ModelAPI_EventCreator::get()->sendUpdated(theMoved, EVENT_UPD);
296 void Model_Objects::clearHistory(ObjectPtr theObj)
299 const std::string aGroup = theObj->groupName();
300 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(aGroup);
301 if (aHIter != myHistory.end())
302 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
303 if (theObj->groupName() == ModelAPI_Feature::group()) { // clear results group of the feature
304 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
305 std::string aResultGroup = featureResultGroup(aFeature);
306 if (!aResultGroup.empty()) {
307 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter =
308 myHistory.find(aResultGroup);
309 if (aHIter != myHistory.end())
310 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
316 void Model_Objects::createHistory(const std::string& theGroupID)
318 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(theGroupID);
319 if (aHIter == myHistory.end()) {
320 myHistory[theGroupID] = std::vector<ObjectPtr>();
321 std::vector<ObjectPtr>& aResult = myHistory[theGroupID];
322 // iterate the array of references and get feature by feature from the array
323 bool isFeature = theGroupID == ModelAPI_Feature::group();
324 Handle(TDataStd_ReferenceArray) aRefs;
325 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
326 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
327 FeaturePtr aFeature = feature(aRefs->Value(a));
328 if (aFeature.get()) {
329 if (isFeature) { // here may be also disabled features
330 if (aFeature->isInHistory()) {
331 aResult.push_back(aFeature);
333 } else if (!aFeature->isDisabled()) { // iterate all results of not-disabled feature
334 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
335 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
336 for (; aRIter != aResults.cend(); aRIter++) {
337 ResultPtr aRes = *aRIter;
338 if (aRes->groupName() != theGroupID) break; // feature have only same group results
339 if (!aRes->isDisabled() && aRes->isInHistory() && !aRes->isConcealed()) {
340 aResult.push_back(*aRIter);
350 void Model_Objects::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
352 clearHistory(theObject);
355 void Model_Objects::updateHistory(const std::string theGroup)
357 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(theGroup);
358 if (aHIter != myHistory.end())
359 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
362 FeaturePtr Model_Objects::feature(TDF_Label theLabel) const
364 if (myFeatures.IsBound(theLabel))
365 return myFeatures.Find(theLabel);
366 return FeaturePtr(); // not found
369 ObjectPtr Model_Objects::object(TDF_Label theLabel)
371 // try feature by label
372 FeaturePtr aFeature = feature(theLabel);
374 return feature(theLabel);
375 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
376 aFeature = feature(aFeatureLabel);
378 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
379 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
380 for (; aRIter != aResults.cend(); aRIter++) {
381 std::shared_ptr<Model_Data> aResData = std::dynamic_pointer_cast<Model_Data>(
383 if (aResData->label().Father().IsEqual(theLabel))
387 return FeaturePtr(); // not found
390 ObjectPtr Model_Objects::object(const std::string& theGroupID, const int theIndex)
394 createHistory(theGroupID);
395 return myHistory[theGroupID][theIndex];
398 std::shared_ptr<ModelAPI_Object> Model_Objects::objectByName(
399 const std::string& theGroupID, const std::string& theName)
401 createHistory(theGroupID);
402 std::vector<ObjectPtr>& allObjs = myHistory[theGroupID];
403 std::vector<ObjectPtr>::iterator anObjIter = allObjs.begin();
404 for(; anObjIter != allObjs.end(); anObjIter++) {
405 if ((*anObjIter)->data()->name() == theName)
412 const int Model_Objects::index(std::shared_ptr<ModelAPI_Object> theObject)
414 std::string aGroup = theObject->groupName();
415 createHistory(aGroup);
416 std::vector<ObjectPtr>& allObjs = myHistory[aGroup];
417 std::vector<ObjectPtr>::iterator anObjIter = allObjs.begin(); // iterate to search object
418 for(int anIndex = 0; anObjIter != allObjs.end(); anObjIter++, anIndex++) {
419 if ((*anObjIter) == theObject)
426 int Model_Objects::size(const std::string& theGroupID)
428 createHistory(theGroupID);
429 return myHistory[theGroupID].size();
432 void Model_Objects::allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults)
434 // iterate the array of references and get feature by feature from the array
435 Handle(TDataStd_ReferenceArray) aRefs;
436 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
437 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
438 FeaturePtr aFeature = feature(aRefs->Value(a));
439 if (aFeature.get()) {
440 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
441 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
442 for (; aRIter != aResults.cend(); aRIter++) {
443 ResultPtr aRes = *aRIter;
444 if (aRes->groupName() != theGroupID) break; // feature have only same group results
445 if (aRes->isInHistory() && !aRes->isConcealed()) {
446 theResults.push_back(*aRIter);
455 TDF_Label Model_Objects::featuresLabel() const
457 return myMain.FindChild(TAG_OBJECTS);
460 void Model_Objects::setUniqueName(FeaturePtr theFeature)
462 if (!theFeature->data()->name().empty())
463 return; // not needed, name is already defined
464 std::string aName; // result
465 // first count all features of such kind to start with index = count + 1
467 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myFeatures);
468 for (; aFIter.More(); aFIter.Next()) {
469 if (aFIter.Value()->getKind() == theFeature->getKind())
472 // generate candidate name
473 std::stringstream aNameStream;
474 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
475 aName = aNameStream.str();
476 // check this is unique, if not, increase index by 1
477 for (aFIter.Initialize(myFeatures); aFIter.More();) {
478 FeaturePtr aFeature = aFIter.Value();
479 bool isSameName = aFeature->data()->name() == aName;
480 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
481 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
482 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
483 for (; aRIter != aResults.cend(); aRIter++) {
484 isSameName = (*aRIter)->data()->name() == aName;
489 std::stringstream aNameStream;
490 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
491 aName = aNameStream.str();
492 // reinitialize iterator to make sure a new name is unique
493 aFIter.Initialize(myFeatures);
497 theFeature->data()->setName(aName);
500 void Model_Objects::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
502 std::shared_ptr<Model_Data> aData(new Model_Data);
503 aData->setLabel(theLab.FindChild(theTag));
504 aData->setObject(theObj);
505 theObj->setDoc(myDoc);
506 theObj->setData(aData);
507 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
509 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
511 theObj->initAttributes();
514 void Model_Objects::synchronizeFeatures(
515 const bool theMarkUpdated, const bool theUpdateReferences, const bool theFlush)
517 Model_Document* anOwner = std::dynamic_pointer_cast<Model_Document>(myDoc).get();
518 if (!anOwner) // this may happen on creation of document: nothing there, so nothing to synchronize
520 // after all updates, sends a message that groups of features were created or updated
521 Events_Loop* aLoop = Events_Loop::loop();
522 static Events_ID aDispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
523 static Events_ID aCreateEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
524 static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
525 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
526 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
527 static Events_ID aToHideEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
528 bool isActive = aLoop->activateFlushes(false);
530 // update all objects by checking are they on labels or not
531 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
532 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
533 for (; aLabIter.More(); aLabIter.Next()) {
534 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
536 if (!myFeatures.IsBound(aFeatureLabel)) { // a new feature is inserted
538 aFeature = std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get())->createFeature(
539 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
540 .ToCString(), anOwner);
541 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
542 Events_Error::send("Invalid type of object in the document");
543 aLabIter.Value()->Label().ForgetAllAttributes();
546 // this must be before "setData" to redo the sketch line correctly
547 myFeatures.Bind(aFeatureLabel, aFeature);
548 aNewFeatures.insert(aFeature);
549 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
550 updateHistory(aFeature);
551 aFeature->setDisabled(false); // by default created feature is enabled (this allows to recreate the results before "setCurrent" is called)
553 // event: model is updated
554 ModelAPI_EventCreator::get()->sendUpdated(aFeature, aCreateEvent);
555 } else { // nothing is changed, both iterators are incremented
556 aFeature = myFeatures.Find(aFeatureLabel);
557 aKeptFeatures.insert(aFeature);
558 if (theMarkUpdated) {
559 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anUpdateEvent);
563 // update results of the features (after features created because they may be connected, like sketch and sub elements)
564 std::list<FeaturePtr> aComposites; // composites must be updated after their subs (issue 360)
565 TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
566 for (; aLabIter2.More(); aLabIter2.Next()) {
567 TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
568 if (myFeatures.IsBound(aFeatureLabel)) { // a new feature is inserted
569 FeaturePtr aFeature = myFeatures.Find(aFeatureLabel);
570 if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature).get())
571 aComposites.push_back(aFeature);
572 updateResults(aFeature);
575 std::list<FeaturePtr>::iterator aComposite = aComposites.begin();
576 for(; aComposite != aComposites.end(); aComposite++) {
577 updateResults(*aComposite);
580 // check all features are checked: if not => it was removed
581 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myFeatures);
582 while (aFIter.More()) {
583 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
584 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
585 FeaturePtr aFeature = aFIter.Value();
586 // event: model is updated
587 //if (aFeature->isInHistory()) {
588 ModelAPI_EventCreator::get()->sendDeleted(myDoc, ModelAPI_Feature::group());
590 // results of this feature must be redisplayed (hided)
591 // redisplay also removed feature (used for sketch and AISObject)
592 ModelAPI_EventCreator::get()->sendUpdated(aFeature, aRedispEvent);
593 updateHistory(aFeature);
595 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
596 myFeatures.UnBind(aFIter.Key());
597 // reinitialize iterator because unbind may corrupt the previous order in the map
598 aFIter.Initialize(myFeatures);
603 if (theUpdateReferences) {
604 synchronizeBackRefs();
606 if (theMarkUpdated) { // this means there is no control what was modified => remove history cash
610 anOwner->executeFeatures() = false;
611 aLoop->activateFlushes(isActive);
614 aLoop->flush(aCreateEvent);
615 aLoop->flush(aDeleteEvent);
616 aLoop->flush(anUpdateEvent);
617 aLoop->flush(aRedispEvent);
618 aLoop->flush(aToHideEvent);
620 anOwner->executeFeatures() = true;
623 void Model_Objects::synchronizeBackRefs()
625 // keeps the concealed flags of result to catch the change and create created/deleted events
626 std::list<std::pair<ResultPtr, bool> > aConcealed;
627 // first cycle: erase all data about back-references
628 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myFeatures);
629 for(; aFeatures.More(); aFeatures.Next()) {
630 FeaturePtr aFeature = aFeatures.Value();
631 std::shared_ptr<Model_Data> aFData =
632 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
634 aFData->eraseBackReferences();
636 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
637 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
638 for (; aRIter != aResults.cend(); aRIter++) {
639 std::shared_ptr<Model_Data> aResData =
640 std::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
642 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
643 aResData->eraseBackReferences();
648 // second cycle: set new back-references: only features may have reference, iterate only them
649 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
650 for(aFeatures.Initialize(myFeatures); aFeatures.More(); aFeatures.Next()) {
651 FeaturePtr aFeature = aFeatures.Value();
652 std::shared_ptr<Model_Data> aFData =
653 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
655 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
656 aFData->referencesToObjects(aRefs);
657 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator
658 aRefsIter = aRefs.begin();
659 for(; aRefsIter != aRefs.end(); aRefsIter++) {
660 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
661 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
663 std::shared_ptr<Model_Data> aRefData =
664 std::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
665 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
666 // update enable/disable status: the nested status must be equal to the composite
667 CompositeFeaturePtr aComp =
668 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
670 FeaturePtr aReferenced = std::dynamic_pointer_cast<ModelAPI_Feature>(*aRefTo);
671 if (aReferenced.get()) {
672 aReferenced->setDisabled(aComp->isDisabled());
680 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
681 for(; aCIter != aConcealed.end(); aCIter++) {
682 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
683 if (aCIter->second) { // was concealed become not => creation event
684 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
685 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
686 } else { // was not concealed become concealed => delete event
687 ModelAPI_EventCreator::get()->sendDeleted(myDoc, aCIter->first->groupName());
688 // redisplay for the viewer (it must be disappeared also)
689 static Events_ID EVENT_DISP =
690 Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
691 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, EVENT_DISP);
697 TDF_Label Model_Objects::resultLabel(
698 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
700 const std::shared_ptr<Model_Data>& aData =
701 std::dynamic_pointer_cast<Model_Data>(theFeatureData);
702 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
705 void Model_Objects::storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
706 std::shared_ptr<ModelAPI_Result> theResult,
707 const int theResultIndex)
709 theResult->setDoc(myDoc);
710 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
711 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
712 std::stringstream aNewName;
713 aNewName<<theFeatureData->name();
714 if (theResultIndex > 0) // if there are several results, add unique prefix starting from second
715 aNewName<<"_"<<theResultIndex + 1;
716 theResult->data()->setName(aNewName.str());
720 std::shared_ptr<ModelAPI_ResultConstruction> Model_Objects::createConstruction(
721 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
723 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
724 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
725 ObjectPtr anOldObject = object(aLab);
726 std::shared_ptr<ModelAPI_ResultConstruction> aResult;
728 aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
731 aResult = std::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
732 storeResult(theFeatureData, aResult, theIndex);
737 std::shared_ptr<ModelAPI_ResultBody> Model_Objects::createBody(
738 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
740 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
741 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
742 ObjectPtr anOldObject = object(aLab);
743 std::shared_ptr<ModelAPI_ResultBody> aResult;
745 aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
748 aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
749 storeResult(theFeatureData, aResult, theIndex);
754 std::shared_ptr<ModelAPI_ResultPart> Model_Objects::createPart(
755 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
757 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
758 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
759 ObjectPtr anOldObject = object(aLab);
760 std::shared_ptr<ModelAPI_ResultPart> aResult;
762 aResult = std::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
765 aResult = std::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
766 storeResult(theFeatureData, aResult, theIndex);
771 std::shared_ptr<ModelAPI_ResultGroup> Model_Objects::createGroup(
772 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
774 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
775 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
776 ObjectPtr anOldObject = object(aLab);
777 std::shared_ptr<ModelAPI_ResultGroup> aResult;
779 aResult = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
782 aResult = std::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
783 storeResult(theFeatureData, aResult, theIndex);
788 std::shared_ptr<ModelAPI_ResultParameter> Model_Objects::createParameter(
789 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
791 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
792 TDataStd_Comment::Set(aLab, ModelAPI_ResultParameter::group().c_str());
793 ObjectPtr anOldObject = object(aLab);
794 std::shared_ptr<ModelAPI_ResultParameter> aResult;
796 aResult = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(anOldObject);
799 aResult = std::shared_ptr<ModelAPI_ResultParameter>(new Model_ResultParameter);
800 storeResult(theFeatureData, aResult, theIndex);
805 std::shared_ptr<ModelAPI_Feature> Model_Objects::feature(
806 const std::shared_ptr<ModelAPI_Result>& theResult)
808 std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
810 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
811 return feature(aFeatureLab);
816 std::string Model_Objects::featureResultGroup(FeaturePtr theFeature)
818 if (theFeature->data()->isValid()) {
819 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
820 if (aLabIter.More()) {
821 TDF_Label anArgLab = aLabIter.Value();
822 Handle(TDataStd_Comment) aGroup;
823 if (aLabIter.Value().FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
824 return TCollection_AsciiString(aGroup->Get()).ToCString();
828 static std::string anEmpty;
829 return anEmpty; // not found
832 void Model_Objects::updateResults(FeaturePtr theFeature)
834 // for not persistent is will be done by parametric updater automatically
835 //if (!theFeature->isPersistentResult()) return;
836 // check the existing results and remove them if there is nothing on the label
837 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
838 while(aResIter != theFeature->results().cend()) {
839 ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
841 if (!aBody->data()->isValid()) {
842 // found a disappeared result => remove it
843 theFeature->eraseResultFromList(aBody);
844 // start iterate from beginning because iterator is corrupted by removing
845 aResIter = theFeature->results().cbegin();
852 if (!theFeature->data() || !theFeature->data()->isValid() || theFeature->isDisabled())
854 // check that results are presented on all labels
855 int aResSize = theFeature->results().size();
856 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
857 for(; aLabIter.More(); aLabIter.Next()) {
858 // here must be GUID of the feature
859 int aResIndex = aLabIter.Value().Tag() - 1;
861 if (aResSize <= aResIndex) {
862 TDF_Label anArgLab = aLabIter.Value();
863 Handle(TDataStd_Comment) aGroup;
864 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
865 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str()) {
866 aNewBody = createBody(theFeature->data(), aResIndex);
867 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
868 std::shared_ptr<ModelAPI_ResultPart> aNewP = createPart(theFeature->data(), aResIndex);
869 theFeature->setResult(aNewP, aResIndex);
870 if (!aNewP->partDoc().get())
871 theFeature->execute(); // create the part result: it is better to restore the previous result if it is possible
873 } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
874 theFeature->execute(); // construction shapes are needed for sketch solver
876 } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
877 aNewBody = createGroup(theFeature->data(), aResIndex);
878 } else if (aGroup->Get() == ModelAPI_ResultParameter::group().c_str()) {
879 theFeature->attributeChanged("expression"); // just produce a value
882 Events_Error::send(std::string("Unknown type of result is found in the document:") +
883 TCollection_AsciiString(aGroup->Get()).ToCString());
887 theFeature->setResult(aNewBody, aResIndex);
893 ResultPtr Model_Objects::findByName(const std::string theName)
895 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator anObjIter(myFeatures);
896 for(; anObjIter.More(); anObjIter.Next()) {
897 FeaturePtr& aFeature = anObjIter.ChangeValue();
898 if (!aFeature.get() || aFeature->isDisabled()) // may be on close
900 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
901 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
902 for (; aRIter != aResults.cend(); aRIter++) {
903 ResultPtr aRes = *aRIter;
904 if (aRes.get() && aRes->data() && aRes->data()->isValid() && !aRes->isDisabled() &&
905 aRes->data()->name() == theName) {
914 FeaturePtr Model_Objects::nextFeature(FeaturePtr theCurrent, const bool theReverse)
916 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
917 if (aData && aData->isValid()) {
918 TDF_Label aFeatureLabel = aData->label().Father();
919 Handle(TDataStd_ReferenceArray) aRefs;
920 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
921 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) { // iterate all existing features
922 if (aRefs->Value(a).IsEqual(aFeatureLabel)) {
923 a += theReverse ? -1 : 1;
924 if (a >= aRefs->Lower() && a <= aRefs->Upper())
925 return feature(aRefs->Value(a));
926 break; // finish iiteration: it's last feature
931 return FeaturePtr(); // not found, last, or something is wrong
934 FeaturePtr Model_Objects::firstFeature()
936 Handle(TDataStd_ReferenceArray) aRefs;
937 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
938 return feature(aRefs->Value(aRefs->Lower()));
940 return FeaturePtr(); // no features at all
943 FeaturePtr Model_Objects::lastFeature()
945 Handle(TDataStd_ReferenceArray) aRefs;
946 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
947 return feature(aRefs->Value(aRefs->Upper()));
949 return FeaturePtr(); // no features at all
952 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Objects::allFeatures()
954 std::list<std::shared_ptr<ModelAPI_Feature> > aResult;
955 Handle(TDataStd_ReferenceArray) aRefs;
956 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
957 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
958 FeaturePtr aFeature = feature(aRefs->Value(a));
960 aResult.push_back(aFeature);
966 int Model_Objects::numInternalFeatures()
968 Handle(TDataStd_ReferenceArray) aRefs;
969 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
970 return aRefs->Upper() - aRefs->Lower() + 1;
975 std::shared_ptr<ModelAPI_Feature> Model_Objects::internalFeature(const int theIndex)
977 Handle(TDataStd_ReferenceArray) aRefs;
978 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
979 return feature(aRefs->Value(aRefs->Lower() + theIndex));
981 return FeaturePtr(); // invalid
984 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
986 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
989 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
991 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);