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_ResultCompSolid.h>
16 #include <Model_ResultGroup.h>
17 #include <Model_ResultParameter.h>
18 #include <ModelAPI_Validator.h>
19 #include <ModelAPI_CompositeFeature.h>
20 #include <ModelAPI_Tools.h>
22 #include <Events_Loop.h>
23 #include <Events_Error.h>
25 #include <TDataStd_Integer.hxx>
26 #include <TDataStd_Comment.hxx>
27 #include <TDF_ChildIDIterator.hxx>
28 #include <TDataStd_ReferenceArray.hxx>
29 #include <TDataStd_HLabelArray1.hxx>
30 #include <TDataStd_Name.hxx>
31 #include <TDF_Reference.hxx>
32 #include <TDF_ChildIDIterator.hxx>
33 #include <TDF_LabelMapHasher.hxx>
34 #include <TDF_LabelMap.hxx>
35 #include <TDF_ListIteratorOfLabelList.hxx>
37 static const int TAG_OBJECTS = 2; // tag of the objects sub-tree (features, results)
40 static const int TAG_FEATURE_ARGUMENTS = 1; ///< where the arguments are located
41 static const int TAG_FEATURE_RESULTS = 2; ///< where the results are located
44 /// 0:1:2 - where features are located
45 /// 0:1:2:N:1 - data of the feature N
46 /// 0:1:2:N:2:K:1 - data of the K result of the feature N
48 Model_Objects::Model_Objects(TDF_Label theMainLab) : myMain(theMainLab)
52 void Model_Objects::setOwner(DocumentPtr theDoc)
55 // update all fields and recreate features and result objects if needed
56 TDF_LabelList aNoUpdated;
57 synchronizeFeatures(aNoUpdated, true, true);
61 Model_Objects::~Model_Objects()
63 // delete all features of this document
64 Events_Loop* aLoop = Events_Loop::loop();
65 // erase one by one to avoid access from the feature destructor itself from he map
66 while(!myFeatures.IsEmpty()) {
67 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeaturesIter(myFeatures);
68 FeaturePtr aFeature = aFeaturesIter.Value();
69 static Events_ID EVENT_DISP = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
70 ModelAPI_EventCreator::get()->sendDeleted(myDoc, ModelAPI_Feature::group());
71 ModelAPI_EventCreator::get()->sendUpdated(aFeature, EVENT_DISP);
72 aFeature->eraseResults();
74 myFeatures.UnBind(aFeaturesIter.Key());
76 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
77 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
81 /// Appends to the array of references a new referenced label
82 static void AddToRefArray(TDF_Label& theArrayLab, TDF_Label& theReferenced, TDF_Label& thePrevLab)
84 Handle(TDataStd_ReferenceArray) aRefs;
85 if (!theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
86 aRefs = TDataStd_ReferenceArray::Set(theArrayLab, 0, 0);
87 aRefs->SetValue(0, theReferenced);
88 } else { // extend array by one more element
89 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
91 int aPassedPrev = 0; // prev feature is found and passed
92 if (thePrevLab.IsNull()) { // null means that inserted feature must be the first
93 aNewArray->SetValue(aRefs->Lower(), theReferenced);
96 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
97 aNewArray->SetValue(a + aPassedPrev, aRefs->Value(a));
98 if (!aPassedPrev && aRefs->Value(a).IsEqual(thePrevLab)) {
100 aNewArray->SetValue(a + 1, theReferenced);
103 if (!aPassedPrev) // not found: unknown situation
104 aNewArray->SetValue(aRefs->Upper() + 1, theReferenced);
105 aRefs->SetInternalArray(aNewArray);
109 void Model_Objects::addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis)
111 if (!theFeature->isAction()) { // do not add action to the data model
112 TDF_Label aFeaturesLab = featuresLabel();
113 TDF_Label aFeatureLab = aFeaturesLab.NewChild();
114 // store feature in the features array: before "initData" because in macro features
115 // in initData it creates new features, appeared later than this
116 TDF_Label aPrevFeateureLab;
117 if (theAfterThis.get()) { // searching for the previous feature label
118 std::shared_ptr<Model_Data> aPrevData =
119 std::dynamic_pointer_cast<Model_Data>(theAfterThis->data());
120 if (aPrevData.get()) {
121 aPrevFeateureLab = aPrevData->label().Father();
124 AddToRefArray(aFeaturesLab, aFeatureLab, aPrevFeateureLab);
126 // keep the feature ID to restore document later correctly
127 TDataStd_Comment::Set(aFeatureLab, theFeature->getKind().c_str());
128 myFeatures.Bind(aFeatureLab, theFeature);
129 // must be after binding to the map because of "Box" macro feature that
130 // creates other features in "initData"
131 initData(theFeature, aFeatureLab, TAG_FEATURE_ARGUMENTS);
132 // event: feature is added
133 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
134 ModelAPI_EventCreator::get()->sendUpdated(theFeature, anEvent);
135 theFeature->setDisabled(false); // by default created feature is enabled
136 updateHistory(ModelAPI_Feature::group());
137 } else { // make feature has not-null data anyway
138 theFeature->setData(Model_Data::invalidData());
139 theFeature->setDoc(myDoc);
143 /// Appends to the array of references a new referenced label.
144 /// If theIndex is not -1, removes element at this index, not theReferenced.
145 /// \returns the index of removed element
146 static int RemoveFromRefArray(TDF_Label theArrayLab, TDF_Label theReferenced,
147 const int theIndex = -1)
149 int aResult = -1; // no returned
150 Handle(TDataStd_ReferenceArray) aRefs;
151 if (theArrayLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
152 if (aRefs->Length() == 1) { // just erase an array
153 if ((theIndex == -1 && aRefs->Value(0) == theReferenced) || theIndex == 0) {
154 theArrayLab.ForgetAttribute(TDataStd_ReferenceArray::GetID());
157 } else { // reduce the array
158 Handle(TDataStd_HLabelArray1) aNewArray = new TDataStd_HLabelArray1(aRefs->Lower(),
160 int aCount = aRefs->Lower();
161 for (int a = aCount; a <= aRefs->Upper(); a++, aCount++) {
162 if ((theIndex == -1 && aRefs->Value(a) == theReferenced) || theIndex == a) {
166 aNewArray->SetValue(aCount, aRefs->Value(a));
169 aRefs->SetInternalArray(aNewArray);
175 void Model_Objects::refsToFeature(FeaturePtr theFeature,
176 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
178 // check the feature: it must have no depended objects on it
179 // the dependencies can be in the feature results
180 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
181 for(; aResIter != theFeature->results().cend(); aResIter++) {
182 ResultPtr aResult = (*aResIter);
183 std::shared_ptr<Model_Data> aData =
184 std::dynamic_pointer_cast<Model_Data>(aResult->data());
185 if (aData.get() != NULL) {
186 const std::set<AttributePtr>& aRefs = aData->refsToMe();
187 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
188 for(; aRefIt != aRefLast; aRefIt++) {
189 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
190 if (aFeature.get() != NULL)
191 theRefs.insert(aFeature);
195 // the dependencies can be in the feature itself
196 std::shared_ptr<Model_Data> aData =
197 std::dynamic_pointer_cast<Model_Data>(theFeature->data());
198 if (aData && !aData->refsToMe().empty()) {
199 const std::set<AttributePtr>& aRefs = aData->refsToMe();
200 std::set<AttributePtr>::const_iterator aRefIt = aRefs.begin(), aRefLast = aRefs.end();
201 for(; aRefIt != aRefLast; aRefIt++) {
202 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>((*aRefIt)->owner());
203 if (aFeature.get() != NULL)
204 theRefs.insert(aFeature);
208 if (!theRefs.empty() && isSendError) {
210 "Feature '" + theFeature->data()->name() + "' is used and can not be deleted");
214 void Model_Objects::removeFeature(FeaturePtr theFeature)
216 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theFeature->data());
217 if (aData && aData->isValid()) {
218 // checking that the sub-element of composite feature is removed: if yes, inform the owner
219 std::set<std::shared_ptr<ModelAPI_Feature> > aRefs;
220 refsToFeature(theFeature, aRefs, false);
221 std::set<std::shared_ptr<ModelAPI_Feature> >::iterator aRefIter = aRefs.begin();
222 for(; aRefIter != aRefs.end(); aRefIter++) {
223 std::shared_ptr<ModelAPI_CompositeFeature> aComposite =
224 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(*aRefIter);
225 if (aComposite.get()) {
226 aComposite->removeFeature(theFeature);
229 // this must be before erase since theFeature erasing removes all information about
230 // the feature results and groups of results
231 // To reproduce: create sketch, extrusion, remove sketch => constructions tree is not updated
232 clearHistory(theFeature);
236 TDF_Label aFeatureLabel = aData->label().Father();
237 if (myFeatures.IsBound(aFeatureLabel))
238 myFeatures.UnBind(aFeatureLabel);
240 static Events_ID EVENT_DISP = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
241 ModelAPI_EventCreator::get()->sendUpdated(theFeature, EVENT_DISP);
242 // erase all attributes under the label of feature
243 aFeatureLabel.ForgetAllAttributes();
244 // remove it from the references array
245 RemoveFromRefArray(featuresLabel(), aFeatureLabel);
246 // event: feature is deleted
247 ModelAPI_EventCreator::get()->sendDeleted(theFeature->document(), ModelAPI_Feature::group());
248 // the redisplay signal should be flushed in order to erase the feature presentation in the viewer
249 Events_Loop::loop()->flush(EVENT_DISP);
250 updateHistory(ModelAPI_Feature::group());
254 void Model_Objects::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
256 TDF_Label aFeaturesLab = featuresLabel();
257 Handle(TDataStd_ReferenceArray) aRefs;
258 if (!aFeaturesLab.FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs))
260 TDF_Label anAfterLab, aMovedLab =
261 std::dynamic_pointer_cast<Model_Data>(theMoved->data())->label().Father();
262 if (theAfterThis.get())
263 anAfterLab = std::dynamic_pointer_cast<Model_Data>(theAfterThis->data())->label().Father();
265 Handle(TDataStd_HLabelArray1) aNewArray =
266 new TDataStd_HLabelArray1(aRefs->Lower(), aRefs->Upper());
267 int aPassedMovedFrom = 0; // the prev feature location is found and passed
268 int aPassedMovedTo = 0; // the feature is added and this location is passed
269 if (!theAfterThis.get()) { // null means that inserted feature must be the first
270 aNewArray->SetValue(aRefs->Lower(), aMovedLab);
273 for (int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
274 if (aPassedMovedTo == 0 && aRefs->Value(a) == anAfterLab) { // add two
276 aNewArray->SetValue(a - aPassedMovedFrom, anAfterLab);
277 if (a + 1 - aPassedMovedFrom <= aRefs->Upper())
278 aNewArray->SetValue(a + 1 - aPassedMovedFrom, aMovedLab);
279 } else if (aPassedMovedFrom == 0 && aRefs->Value(a) == aMovedLab) { // skip
281 } else { // just copy one
282 if (a - aPassedMovedFrom + aPassedMovedTo <= aRefs->Upper())
283 aNewArray->SetValue(a - aPassedMovedFrom + aPassedMovedTo, aRefs->Value(a));
286 if (!aPassedMovedFrom || !aPassedMovedTo) {// not found: unknown situation
287 if (!aPassedMovedFrom) {
288 static std::string aMovedFromError("The moved feature is not found");
289 Events_Error::send(aMovedFromError);
291 static std::string aMovedToError("The 'after' feature for movement is not found");
292 Events_Error::send(aMovedToError);
296 // store the new array
297 aRefs->SetInternalArray(aNewArray);
298 // update the feature and the history
299 clearHistory(theMoved);
300 static Events_ID EVENT_UPD = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
301 ModelAPI_EventCreator::get()->sendUpdated(theMoved, EVENT_UPD);
304 void Model_Objects::clearHistory(ObjectPtr theObj)
307 const std::string aGroup = theObj->groupName();
308 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(aGroup);
309 if (aHIter != myHistory.end())
310 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
311 if (theObj->groupName() == ModelAPI_Feature::group()) { // clear results group of the feature
312 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
313 std::string aResultGroup = featureResultGroup(aFeature);
314 if (!aResultGroup.empty()) {
315 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter =
316 myHistory.find(aResultGroup);
317 if (aHIter != myHistory.end())
318 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
324 void Model_Objects::createHistory(const std::string& theGroupID)
326 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(theGroupID);
327 if (aHIter == myHistory.end()) {
328 myHistory[theGroupID] = std::vector<ObjectPtr>();
329 std::vector<ObjectPtr>& aResult = myHistory[theGroupID];
330 // iterate the array of references and get feature by feature from the array
331 bool isFeature = theGroupID == ModelAPI_Feature::group();
332 Handle(TDataStd_ReferenceArray) aRefs;
333 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
334 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
335 FeaturePtr aFeature = feature(aRefs->Value(a));
336 if (aFeature.get()) {
337 // if feature is in sub-component, remove it from history: it is in sub-tree of sub-component
338 if (!ModelAPI_Tools::compositeOwner(aFeature).get()) {
339 if (isFeature) { // here may be also disabled features
340 if (aFeature->isInHistory()) {
341 aResult.push_back(aFeature);
343 } else if (!aFeature->isDisabled()) { // iterate all results of not-disabled feature
344 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
345 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
346 for (; aRIter != aResults.cend(); aRIter++) {
347 ResultPtr aRes = *aRIter;
348 if (aRes->groupName() != theGroupID) break; // feature have only same group results
349 if (!aRes->isDisabled() && aRes->isInHistory() && !aRes->isConcealed()) {
350 aResult.push_back(*aRIter);
361 void Model_Objects::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
363 clearHistory(theObject);
366 void Model_Objects::updateHistory(const std::string theGroup)
368 std::map<std::string, std::vector<ObjectPtr> >::iterator aHIter = myHistory.find(theGroup);
369 if (aHIter != myHistory.end())
370 myHistory.erase(aHIter); // erase from map => this means that it is not synchronized
373 FeaturePtr Model_Objects::feature(TDF_Label theLabel) const
375 if (myFeatures.IsBound(theLabel))
376 return myFeatures.Find(theLabel);
377 return FeaturePtr(); // not found
380 ObjectPtr Model_Objects::object(TDF_Label theLabel)
382 // try feature by label
383 FeaturePtr aFeature = feature(theLabel);
385 return feature(theLabel);
386 TDF_Label aFeatureLabel = theLabel.Father().Father(); // let's suppose it is result
387 aFeature = feature(aFeatureLabel);
388 bool isSubResult = false;
389 if (!aFeature.get() && aFeatureLabel.Depth() > 1) { // let's suppose this is sub-result of result
390 aFeatureLabel = aFeatureLabel.Father().Father();
391 aFeature = feature(aFeatureLabel);
395 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
396 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.cbegin();
397 for (; aRIter != aResults.cend(); aRIter++) {
399 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRIter);
401 int aNumSubs = aCompRes->numberOfSubs();
402 for(int a = 0; a < aNumSubs; a++) {
403 ResultPtr aSub = aCompRes->subResult(a);
405 std::shared_ptr<Model_Data> aSubData = std::dynamic_pointer_cast<Model_Data>(
407 if (aSubData->label().Father().IsEqual(theLabel))
413 std::shared_ptr<Model_Data> aResData = std::dynamic_pointer_cast<Model_Data>(
415 if (aResData->label().Father().IsEqual(theLabel))
420 return FeaturePtr(); // not found
423 ObjectPtr Model_Objects::object(const std::string& theGroupID, const int theIndex)
427 createHistory(theGroupID);
428 return myHistory[theGroupID][theIndex];
431 std::shared_ptr<ModelAPI_Object> Model_Objects::objectByName(
432 const std::string& theGroupID, const std::string& theName)
434 createHistory(theGroupID);
435 std::vector<ObjectPtr>& allObjs = myHistory[theGroupID];
436 std::vector<ObjectPtr>::iterator anObjIter = allObjs.begin();
437 for(; anObjIter != allObjs.end(); anObjIter++) {
438 if ((*anObjIter)->data()->name() == theName)
445 const int Model_Objects::index(std::shared_ptr<ModelAPI_Object> theObject)
447 std::string aGroup = theObject->groupName();
448 createHistory(aGroup);
449 std::vector<ObjectPtr>& allObjs = myHistory[aGroup];
450 std::vector<ObjectPtr>::iterator anObjIter = allObjs.begin(); // iterate to search object
451 for(int anIndex = 0; anObjIter != allObjs.end(); anObjIter++, anIndex++) {
452 if ((*anObjIter) == theObject)
459 int Model_Objects::size(const std::string& theGroupID)
461 createHistory(theGroupID);
462 return myHistory[theGroupID].size();
465 void Model_Objects::allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults)
467 // iterate the array of references and get feature by feature from the array
468 Handle(TDataStd_ReferenceArray) aRefs;
469 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
470 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
471 FeaturePtr aFeature = feature(aRefs->Value(a));
472 if (aFeature.get()) {
473 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
474 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
475 for (; aRIter != aResults.cend(); aRIter++) {
476 ResultPtr aRes = *aRIter;
477 if (aRes->groupName() != theGroupID) break; // feature have only same group results
478 if (aRes->isInHistory() && !aRes->isConcealed()) {
479 theResults.push_back(*aRIter);
488 TDF_Label Model_Objects::featuresLabel() const
490 return myMain.FindChild(TAG_OBJECTS);
493 void Model_Objects::setUniqueName(FeaturePtr theFeature)
495 if (!theFeature->data()->name().empty())
496 return; // not needed, name is already defined
497 std::string aName; // result
498 // first count all features of such kind to start with index = count + 1
499 int aNumObjects = -1; // this feature is already in this map
500 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myFeatures);
501 for (; aFIter.More(); aFIter.Next()) {
502 if (aFIter.Value()->getKind() == theFeature->getKind())
505 // generate candidate name
506 std::stringstream aNameStream;
507 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
508 aName = aNameStream.str();
509 // check this is unique, if not, increase index by 1
510 for (aFIter.Initialize(myFeatures); aFIter.More();) {
511 FeaturePtr aFeature = aFIter.Value();
512 bool isSameName = aFeature->data()->name() == aName;
513 if (!isSameName) { // check also results to avoid same results names (actual for Parts)
514 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
515 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
516 for (; aRIter != aResults.cend(); aRIter++) {
517 isSameName = (*aRIter)->data()->name() == aName;
522 std::stringstream aNameStream;
523 aNameStream << theFeature->getKind() << "_" << aNumObjects + 1;
524 aName = aNameStream.str();
525 // reinitialize iterator to make sure a new name is unique
526 aFIter.Initialize(myFeatures);
530 theFeature->data()->setName(aName);
533 void Model_Objects::initData(ObjectPtr theObj, TDF_Label theLab, const int theTag)
535 std::shared_ptr<Model_Data> aData(new Model_Data);
536 aData->setLabel(theLab.FindChild(theTag));
537 aData->setObject(theObj);
538 theObj->setDoc(myDoc);
539 theObj->setData(aData);
540 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theObj);
542 setUniqueName(aFeature); // must be before "initAttributes" because duplicate part uses name
544 theObj->initAttributes();
547 void Model_Objects::synchronizeFeatures(
548 const TDF_LabelList& theUpdated, const bool theUpdateReferences, const bool theFlush)
550 Model_Document* anOwner = std::dynamic_pointer_cast<Model_Document>(myDoc).get();
551 if (!anOwner) // this may happen on creation of document: nothing there, so nothing to synchronize
553 // after all updates, sends a message that groups of features were created or updated
554 Events_Loop* aLoop = Events_Loop::loop();
555 static Events_ID aDispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
556 static Events_ID aCreateEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
557 static Events_ID anUpdateEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
558 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
559 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
560 static Events_ID aToHideEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
561 bool isActive = aLoop->activateFlushes(false);
563 // collect all updated labels map
564 TDF_LabelMap anUpdatedMap;
565 TDF_ListIteratorOfLabelList anUpdatedIter(theUpdated);
566 for(; anUpdatedIter.More(); anUpdatedIter.Next()) {
567 TDF_Label& aFeatureLab = anUpdatedIter.Value();
568 while(aFeatureLab.Depth() > 3)
569 aFeatureLab = aFeatureLab.Father();
570 if (myFeatures.IsBound(aFeatureLab))
571 anUpdatedMap.Add(aFeatureLab);
574 // update all objects by checking are they on labels or not
575 std::set<FeaturePtr> aNewFeatures, aKeptFeatures;
576 TDF_ChildIDIterator aLabIter(featuresLabel(), TDataStd_Comment::GetID());
577 for (; aLabIter.More(); aLabIter.Next()) {
578 TDF_Label aFeatureLabel = aLabIter.Value()->Label();
580 if (!myFeatures.IsBound(aFeatureLabel)) { // a new feature is inserted
582 aFeature = std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get())->createFeature(
583 TCollection_AsciiString(Handle(TDataStd_Comment)::DownCast(aLabIter.Value())->Get())
584 .ToCString(), anOwner);
585 if (!aFeature) { // somethig is wrong, most probably, the opened document has invalid structure
586 Events_Error::send("Invalid type of object in the document");
587 aLabIter.Value()->Label().ForgetAllAttributes();
590 // this must be before "setData" to redo the sketch line correctly
591 myFeatures.Bind(aFeatureLabel, aFeature);
592 aNewFeatures.insert(aFeature);
593 initData(aFeature, aFeatureLabel, TAG_FEATURE_ARGUMENTS);
594 updateHistory(aFeature);
595 aFeature->setDisabled(false); // by default created feature is enabled (this allows to recreate the results before "setCurrent" is called)
597 // event: model is updated
598 ModelAPI_EventCreator::get()->sendUpdated(aFeature, aCreateEvent);
599 } else { // nothing is changed, both iterators are incremented
600 aFeature = myFeatures.Find(aFeatureLabel);
601 aKeptFeatures.insert(aFeature);
602 if (anUpdatedMap.Contains(aFeatureLabel)) {
603 ModelAPI_EventCreator::get()->sendUpdated(aFeature, anUpdateEvent);
608 // check all features are checked: if not => it was removed
609 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFIter(myFeatures);
610 while (aFIter.More()) {
611 if (aKeptFeatures.find(aFIter.Value()) == aKeptFeatures.end()
612 && aNewFeatures.find(aFIter.Value()) == aNewFeatures.end()) {
613 FeaturePtr aFeature = aFIter.Value();
614 // event: model is updated
615 //if (aFeature->isInHistory()) {
616 ModelAPI_EventCreator::get()->sendDeleted(myDoc, ModelAPI_Feature::group());
618 // results of this feature must be redisplayed (hided)
619 // redisplay also removed feature (used for sketch and AISObject)
620 ModelAPI_EventCreator::get()->sendUpdated(aFeature, aRedispEvent);
621 updateHistory(aFeature);
623 // unbind after the "erase" call: on abort sketch is removes sub-objects that corrupts aFIter
624 myFeatures.UnBind(aFIter.Key());
625 // reinitialize iterator because unbind may corrupt the previous order in the map
626 aFIter.Initialize(myFeatures);
631 if (theUpdateReferences) {
632 synchronizeBackRefs();
634 // update results of the features (after features created because they may be connected, like sketch and sub elements)
635 // After synchronisation of back references because sketch must be set in sub-elements before "execute" by updateResults
636 std::list<FeaturePtr> aComposites; // composites must be updated after their subs (issue 360)
637 TDF_ChildIDIterator aLabIter2(featuresLabel(), TDataStd_Comment::GetID());
638 for (; aLabIter2.More(); aLabIter2.Next()) {
639 TDF_Label aFeatureLabel = aLabIter2.Value()->Label();
640 if (myFeatures.IsBound(aFeatureLabel)) { // a new feature is inserted
641 FeaturePtr aFeature = myFeatures.Find(aFeatureLabel);
642 if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature).get())
643 aComposites.push_back(aFeature);
644 updateResults(aFeature);
647 std::list<FeaturePtr>::iterator aComposite = aComposites.begin();
648 for(; aComposite != aComposites.end(); aComposite++) {
649 updateResults(*aComposite);
652 // the synchronize should be done after updateResults in order to correct back references of updated results
653 if (theUpdateReferences) {
654 synchronizeBackRefs();
656 if (!theUpdated.IsEmpty()) { // this means there is no control what was modified => remove history cash
660 anOwner->executeFeatures() = false;
661 aLoop->activateFlushes(isActive);
664 aLoop->flush(aCreateEvent);
665 aLoop->flush(aDeleteEvent);
666 aLoop->flush(anUpdateEvent);
667 aLoop->flush(aRedispEvent);
668 aLoop->flush(aToHideEvent);
670 anOwner->executeFeatures() = true;
673 void Model_Objects::synchronizeBackRefs()
675 // keeps the concealed flags of result to catch the change and create created/deleted events
676 std::list<std::pair<ResultPtr, bool> > aConcealed;
677 // first cycle: erase all data about back-references
678 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator aFeatures(myFeatures);
679 for(; aFeatures.More(); aFeatures.Next()) {
680 FeaturePtr aFeature = aFeatures.Value();
681 std::shared_ptr<Model_Data> aFData =
682 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
684 aFData->eraseBackReferences();
686 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
687 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
688 for (; aRIter != aResults.cend(); aRIter++) {
689 std::shared_ptr<Model_Data> aResData =
690 std::dynamic_pointer_cast<Model_Data>((*aRIter)->data());
691 if (aResData.get()) {
692 aConcealed.push_back(std::pair<ResultPtr, bool>(*aRIter, (*aRIter)->isConcealed()));
693 aResData->eraseBackReferences();
695 // iterate sub-bodies of compsolid
696 ResultCompSolidPtr aComp = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRIter);
698 int aNumSub = aComp->numberOfSubs();
699 for(int a = 0; a < aNumSub; a++) {
700 ResultPtr aSub = aComp->subResult(a);
701 std::shared_ptr<Model_Data> aResData =
702 std::dynamic_pointer_cast<Model_Data>(aSub->data());
703 if (aResData.get()) {
704 aConcealed.push_back(std::pair<ResultPtr, bool>(aSub, aSub->isConcealed()));
705 aResData->eraseBackReferences();
712 // second cycle: set new back-references: only features may have reference, iterate only them
713 ModelAPI_ValidatorsFactory* aValidators = ModelAPI_Session::get()->validators();
714 for(aFeatures.Initialize(myFeatures); aFeatures.More(); aFeatures.Next()) {
715 FeaturePtr aFeature = aFeatures.Value();
716 std::shared_ptr<Model_Data> aFData =
717 std::dynamic_pointer_cast<Model_Data>(aFeature->data());
719 std::list<std::pair<std::string, std::list<ObjectPtr> > > aRefs;
720 aFData->referencesToObjects(aRefs);
721 std::list<std::pair<std::string, std::list<ObjectPtr> > >::iterator
722 aRefsIter = aRefs.begin();
723 for(; aRefsIter != aRefs.end(); aRefsIter++) {
724 std::list<ObjectPtr>::iterator aRefTo = aRefsIter->second.begin();
725 for(; aRefTo != aRefsIter->second.end(); aRefTo++) {
727 std::shared_ptr<Model_Data> aRefData =
728 std::dynamic_pointer_cast<Model_Data>((*aRefTo)->data());
729 aRefData->addBackReference(aFeature, aRefsIter->first); // here the Concealed flag is updated
730 // update enable/disable status: the nested status must be equal to the composite
731 CompositeFeaturePtr aComp =
732 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aFeature);
734 FeaturePtr aReferenced = std::dynamic_pointer_cast<ModelAPI_Feature>(*aRefTo);
735 if (aReferenced.get()) {
736 aReferenced->setDisabled(aComp->isDisabled());
744 std::list<std::pair<ResultPtr, bool> >::iterator aCIter = aConcealed.begin();
745 for(; aCIter != aConcealed.end(); aCIter++) {
746 if (aCIter->first->isConcealed() != aCIter->second) { // somethign is changed => produce event
747 if (aCIter->second) { // was concealed become not => creation event
748 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_CREATED);
749 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, anEvent);
750 } else { // was not concealed become concealed => delete event
751 ModelAPI_EventCreator::get()->sendDeleted(myDoc, aCIter->first->groupName());
752 // redisplay for the viewer (it must be disappeared also)
753 static Events_ID EVENT_DISP =
754 Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
755 ModelAPI_EventCreator::get()->sendUpdated(aCIter->first, EVENT_DISP);
761 TDF_Label Model_Objects::resultLabel(
762 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex)
764 const std::shared_ptr<Model_Data>& aData =
765 std::dynamic_pointer_cast<Model_Data>(theFeatureData);
766 return aData->label().Father().FindChild(TAG_FEATURE_RESULTS).FindChild(theResultIndex + 1);
769 void Model_Objects::storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
770 std::shared_ptr<ModelAPI_Result> theResult,
771 const int theResultIndex)
773 theResult->setDoc(myDoc);
774 initData(theResult, resultLabel(theFeatureData, theResultIndex), TAG_FEATURE_ARGUMENTS);
775 if (theResult->data()->name().empty()) { // if was not initialized, generate event and set a name
776 std::stringstream aNewName;
777 aNewName<<theFeatureData->name();
778 if (theResultIndex > 0) // if there are several results, add unique prefix starting from second
779 aNewName<<"_"<<theResultIndex + 1;
780 theResult->data()->setName(aNewName.str());
784 std::shared_ptr<ModelAPI_ResultConstruction> Model_Objects::createConstruction(
785 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
787 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
788 TDataStd_Comment::Set(aLab, ModelAPI_ResultConstruction::group().c_str());
789 ObjectPtr anOldObject = object(aLab);
790 std::shared_ptr<ModelAPI_ResultConstruction> aResult;
792 aResult = std::dynamic_pointer_cast<ModelAPI_ResultConstruction>(anOldObject);
795 aResult = std::shared_ptr<ModelAPI_ResultConstruction>(new Model_ResultConstruction);
796 storeResult(theFeatureData, aResult, theIndex);
801 std::shared_ptr<ModelAPI_ResultBody> Model_Objects::createBody(
802 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
804 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
805 // for feature create compsolid, but for result sub create body:
806 // only one level of recursion is supported now
807 ResultPtr aResultOwner = std::dynamic_pointer_cast<ModelAPI_Result>(theFeatureData->owner());
808 ObjectPtr anOldObject;
809 if (aResultOwner.get()) {
810 TDataStd_Comment::Set(aLab, ModelAPI_ResultBody::group().c_str());
811 } else { // in compsolid (higher level result) old object probably may be found
812 TDataStd_Comment::Set(aLab, ModelAPI_ResultCompSolid::group().c_str());
813 anOldObject = object(aLab);
815 std::shared_ptr<ModelAPI_ResultBody> aResult;
817 aResult = std::dynamic_pointer_cast<ModelAPI_ResultBody>(anOldObject);
820 // create compsolid anyway; if it is compsolid, it will create sub-bodies internally
821 if (aResultOwner.get()) {
822 aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultBody);
824 aResult = std::shared_ptr<ModelAPI_ResultBody>(new Model_ResultCompSolid);
826 storeResult(theFeatureData, aResult, theIndex);
831 std::shared_ptr<ModelAPI_ResultPart> Model_Objects::createPart(
832 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
834 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
835 TDataStd_Comment::Set(aLab, ModelAPI_ResultPart::group().c_str());
836 ObjectPtr anOldObject = object(aLab);
837 std::shared_ptr<ModelAPI_ResultPart> aResult;
839 aResult = std::dynamic_pointer_cast<ModelAPI_ResultPart>(anOldObject);
842 aResult = std::shared_ptr<ModelAPI_ResultPart>(new Model_ResultPart);
843 storeResult(theFeatureData, aResult, theIndex);
848 std::shared_ptr<ModelAPI_ResultPart> Model_Objects::copyPart(
849 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
850 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
852 std::shared_ptr<ModelAPI_ResultPart> aResult = createPart(theFeatureData, theIndex);
853 aResult->data()->reference(Model_ResultPart::BASE_REF_ID())->setValue(theOrigin);
857 std::shared_ptr<ModelAPI_ResultGroup> Model_Objects::createGroup(
858 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
860 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
861 TDataStd_Comment::Set(aLab, ModelAPI_ResultGroup::group().c_str());
862 ObjectPtr anOldObject = object(aLab);
863 std::shared_ptr<ModelAPI_ResultGroup> aResult;
865 aResult = std::dynamic_pointer_cast<ModelAPI_ResultGroup>(anOldObject);
868 aResult = std::shared_ptr<ModelAPI_ResultGroup>(new Model_ResultGroup(theFeatureData));
869 storeResult(theFeatureData, aResult, theIndex);
874 std::shared_ptr<ModelAPI_ResultParameter> Model_Objects::createParameter(
875 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
877 TDF_Label aLab = resultLabel(theFeatureData, theIndex);
878 TDataStd_Comment::Set(aLab, ModelAPI_ResultParameter::group().c_str());
879 ObjectPtr anOldObject = object(aLab);
880 std::shared_ptr<ModelAPI_ResultParameter> aResult;
882 aResult = std::dynamic_pointer_cast<ModelAPI_ResultParameter>(anOldObject);
885 aResult = std::shared_ptr<ModelAPI_ResultParameter>(new Model_ResultParameter);
886 storeResult(theFeatureData, aResult, theIndex);
891 std::shared_ptr<ModelAPI_Feature> Model_Objects::feature(
892 const std::shared_ptr<ModelAPI_Result>& theResult)
894 std::shared_ptr<Model_Data> aData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
896 TDF_Label aFeatureLab = aData->label().Father().Father().Father();
897 FeaturePtr aFeature = feature(aFeatureLab);
898 if (!aFeature.get() && aFeatureLab.Depth() > 1) { // this may be sub-result of result
899 aFeatureLab = aFeatureLab.Father().Father();
900 aFeature = feature(aFeatureLab);
907 std::string Model_Objects::featureResultGroup(FeaturePtr theFeature)
909 if (theFeature->data()->isValid()) {
910 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
911 if (aLabIter.More()) {
912 TDF_Label anArgLab = aLabIter.Value();
913 Handle(TDataStd_Comment) aGroup;
914 if (aLabIter.Value().FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
915 return TCollection_AsciiString(aGroup->Get()).ToCString();
919 static std::string anEmpty;
920 return anEmpty; // not found
923 void Model_Objects::updateResults(FeaturePtr theFeature)
925 // for not persistent is will be done by parametric updater automatically
926 //if (!theFeature->isPersistentResult()) return;
927 // check the existing results and remove them if there is nothing on the label
928 std::list<ResultPtr>::const_iterator aResIter = theFeature->results().cbegin();
929 while(aResIter != theFeature->results().cend()) {
930 ResultPtr aBody = std::dynamic_pointer_cast<ModelAPI_Result>(*aResIter);
932 if (!aBody->data()->isValid()) {
933 // found a disappeared result => remove it
934 theFeature->eraseResultFromList(aBody);
935 // start iterate from beginning because iterator is corrupted by removing
936 aResIter = theFeature->results().cbegin();
943 if (!theFeature->data() || !theFeature->data()->isValid() || theFeature->isDisabled())
945 // check that results are presented on all labels
946 int aResSize = theFeature->results().size();
947 TDF_ChildIterator aLabIter(resultLabel(theFeature->data(), 0).Father());
948 for(; aLabIter.More(); aLabIter.Next()) {
949 // here must be GUID of the feature
950 int aResIndex = aLabIter.Value().Tag() - 1;
952 if (aResSize <= aResIndex) {
953 TDF_Label anArgLab = aLabIter.Value();
954 Handle(TDataStd_Comment) aGroup;
955 if (anArgLab.FindAttribute(TDataStd_Comment::GetID(), aGroup)) {
956 if (aGroup->Get() == ModelAPI_ResultBody::group().c_str() ||
957 aGroup->Get() == ModelAPI_ResultCompSolid::group().c_str()) {
958 aNewBody = createBody(theFeature->data(), aResIndex);
959 } else if (aGroup->Get() == ModelAPI_ResultPart::group().c_str()) {
960 std::shared_ptr<ModelAPI_ResultPart> aNewP = createPart(theFeature->data(), aResIndex);
961 theFeature->setResult(aNewP, aResIndex);
962 if (!aNewP->partDoc().get())
963 theFeature->execute(); // create the part result: it is better to restore the previous result if it is possible
965 } else if (aGroup->Get() == ModelAPI_ResultConstruction::group().c_str()) {
966 theFeature->execute(); // construction shapes are needed for sketch solver
968 } else if (aGroup->Get() == ModelAPI_ResultGroup::group().c_str()) {
969 aNewBody = createGroup(theFeature->data(), aResIndex);
970 } else if (aGroup->Get() == ModelAPI_ResultParameter::group().c_str()) {
971 theFeature->attributeChanged("expression"); // just produce a value
974 Events_Error::send(std::string("Unknown type of result is found in the document:") +
975 TCollection_AsciiString(aGroup->Get()).ToCString());
979 theFeature->setResult(aNewBody, aResIndex);
985 ResultPtr Model_Objects::findByName(const std::string theName)
987 NCollection_DataMap<TDF_Label, FeaturePtr>::Iterator anObjIter(myFeatures);
988 for(; anObjIter.More(); anObjIter.Next()) {
989 FeaturePtr& aFeature = anObjIter.ChangeValue();
990 if (!aFeature.get() || aFeature->isDisabled()) // may be on close
992 const std::list<std::shared_ptr<ModelAPI_Result> >& aResults = aFeature->results();
993 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRIter = aResults.begin();
994 for (; aRIter != aResults.cend(); aRIter++) {
995 ResultPtr aRes = *aRIter;
996 if (aRes.get() && aRes->data() && aRes->data()->isValid() && !aRes->isDisabled() &&
997 aRes->data()->name() == theName) {
1006 FeaturePtr Model_Objects::nextFeature(FeaturePtr theCurrent, const bool theReverse)
1008 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1009 if (aData && aData->isValid()) {
1010 TDF_Label aFeatureLabel = aData->label().Father();
1011 Handle(TDataStd_ReferenceArray) aRefs;
1012 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
1013 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) { // iterate all existing features
1014 if (aRefs->Value(a).IsEqual(aFeatureLabel)) {
1015 a += theReverse ? -1 : 1;
1016 if (a >= aRefs->Lower() && a <= aRefs->Upper())
1017 return feature(aRefs->Value(a));
1018 break; // finish iiteration: it's last feature
1023 return FeaturePtr(); // not found, last, or something is wrong
1026 FeaturePtr Model_Objects::firstFeature()
1028 Handle(TDataStd_ReferenceArray) aRefs;
1029 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
1030 return feature(aRefs->Value(aRefs->Lower()));
1032 return FeaturePtr(); // no features at all
1035 FeaturePtr Model_Objects::lastFeature()
1037 Handle(TDataStd_ReferenceArray) aRefs;
1038 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
1039 return feature(aRefs->Value(aRefs->Upper()));
1041 return FeaturePtr(); // no features at all
1044 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Objects::allFeatures()
1046 std::list<std::shared_ptr<ModelAPI_Feature> > aResult;
1047 Handle(TDataStd_ReferenceArray) aRefs;
1048 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
1049 for(int a = aRefs->Lower(); a <= aRefs->Upper(); a++) {
1050 FeaturePtr aFeature = feature(aRefs->Value(a));
1052 aResult.push_back(aFeature);
1058 int Model_Objects::numInternalFeatures()
1060 Handle(TDataStd_ReferenceArray) aRefs;
1061 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
1062 return aRefs->Upper() - aRefs->Lower() + 1;
1064 return 0; // invalid
1067 std::shared_ptr<ModelAPI_Feature> Model_Objects::internalFeature(const int theIndex)
1069 Handle(TDataStd_ReferenceArray) aRefs;
1070 if (featuresLabel().FindAttribute(TDataStd_ReferenceArray::GetID(), aRefs)) {
1071 return feature(aRefs->Value(aRefs->Lower() + theIndex));
1073 return FeaturePtr(); // invalid
1076 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1078 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1081 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1083 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);