1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_Document.cxx
4 // Created: 28 Feb 2014
5 // Author: Mikhail PONIKAROV
7 #include <Model_Document.h>
8 #include <Model_Data.h>
9 #include <Model_Objects.h>
10 #include <Model_Application.h>
11 #include <Model_Session.h>
12 #include <Model_Events.h>
13 #include <ModelAPI_ResultPart.h>
14 #include <ModelAPI_Validator.h>
15 #include <ModelAPI_CompositeFeature.h>
16 #include <ModelAPI_AttributeSelectionList.h>
17 #include <ModelAPI_Tools.h>
18 #include <ModelAPI_ResultBody.h>
19 #include <Events_Loop.h>
20 #include <Events_InfoMessage.h>
22 #include <TDataStd_Integer.hxx>
23 #include <TDataStd_Comment.hxx>
24 #include <TDF_ChildIDIterator.hxx>
25 #include <TDataStd_ReferenceArray.hxx>
26 #include <TDataStd_ReferenceList.hxx>
27 #include <TDataStd_IntegerArray.hxx>
28 #include <TDataStd_HLabelArray1.hxx>
29 #include <TDataStd_Name.hxx>
30 #include <TDataStd_AsciiString.hxx>
31 #include <TDF_Reference.hxx>
32 #include <TDF_ChildIDIterator.hxx>
33 #include <TDF_LabelMapHasher.hxx>
34 #include <TDF_Delta.hxx>
35 #include <TDF_AttributeDelta.hxx>
36 #include <TDF_AttributeDeltaList.hxx>
37 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
38 #include <TDF_ListIteratorOfLabelList.hxx>
39 #include <TDF_LabelMap.hxx>
40 #include <TNaming_SameShapeIterator.hxx>
41 #include <TNaming_Iterator.hxx>
42 #include <TNaming_NamedShape.hxx>
43 #include <TNaming_Tool.hxx>
45 #include <TopExp_Explorer.hxx>
46 #include <TopoDS_Shape.hxx>
48 #include <OSD_File.hxx>
49 #include <OSD_Path.hxx>
50 #include <CDF_Session.hxx>
51 #include <CDF_Directory.hxx>
59 # define _separator_ '\\'
61 # define _separator_ '/'
64 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
66 static const int TAG_GENERAL = 1; // general properties tag
69 /// where the reference to the current feature label is located (or no attribute if null feature)
70 static const int TAG_CURRENT_FEATURE = 1;
71 static const int TAG_CURRENT_TRANSACTION = 2; ///< integer, index of the transaction
72 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
74 Model_Document::Model_Document(const int theID, const std::string theKind)
75 : myID(theID), myKind(theKind), myIsActive(false),
76 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
79 CDF_Session::CurrentSession()->Directory()->Add(myDoc);
81 myObjs = new Model_Objects(myDoc->Main());
82 myDoc->SetUndoLimit(UNDO_LIMIT);
83 myTransactionSave = 0;
84 myExecuteFeatures = true;
85 // to have something in the document and avoid empty doc open/save problem
86 // in transaction for nesting correct working
88 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
89 // this to avoid creation of integer attribute outside the transaction after undo
91 myDoc->CommitCommand();
94 void Model_Document::setThis(DocumentPtr theDoc)
96 myObjs->setOwner(theDoc);
99 /// Returns the file name of this document by the name of directory and identifier of a document
100 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
102 TCollection_ExtendedString aPath((const Standard_CString) theDirName);
103 // remove end-separators
104 while(aPath.Length() &&
105 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
106 aPath.Remove(aPath.Length());
107 aPath += _separator_;
108 aPath += theID.c_str();
109 aPath += ".cbf"; // standard binary file extension
113 bool Model_Document::isRoot() const
115 return this == Model_Session::get()->moduleDocument().get();
118 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
120 Handle(Model_Application) anApp = Model_Application::getApplication();
122 anApp->setLoadPath(theDirName);
124 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
125 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
126 Handle(TDocStd_Document) aLoaded;
128 aStatus = anApp->Open(aPath, aLoaded);
129 } catch (Standard_Failure) {
130 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
131 Events_InfoMessage("Model_Document",
132 "Exception in opening of document: %1").arg(aFail->GetMessageString()).send();
135 bool isError = aStatus != PCDM_RS_OK;
138 case PCDM_RS_UnknownDocument:
139 Events_InfoMessage("Model_Document", "Can not open document").send();
141 case PCDM_RS_AlreadyRetrieved:
142 Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
144 case PCDM_RS_AlreadyRetrievedAndModified:
145 Events_InfoMessage("Model_Document",
146 "Can not open document: already opened and modified").send();
148 case PCDM_RS_NoDriver:
149 Events_InfoMessage("Model_Document",
150 "Can not open document: driver library is not found").send();
152 case PCDM_RS_UnknownFileDriver:
153 Events_InfoMessage("Model_Document",
154 "Can not open document: unknown driver for opening").send();
156 case PCDM_RS_OpenError:
157 Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
159 case PCDM_RS_NoVersion:
160 Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
162 case PCDM_RS_NoModel:
163 Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
165 case PCDM_RS_NoDocument:
166 Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
168 case PCDM_RS_FormatFailure:
169 Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
171 case PCDM_RS_TypeNotFoundInSchema:
172 Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
174 case PCDM_RS_UnrecognizedFileFormat:
175 Events_InfoMessage("Model_Document",
176 "Can not open document: unrecognized file format").send();
178 case PCDM_RS_MakeFailure:
179 Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
181 case PCDM_RS_PermissionDenied:
182 Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
184 case PCDM_RS_DriverFailure:
185 Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
188 Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
192 std::shared_ptr<Model_Session> aSession =
193 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
196 myDoc->SetUndoLimit(UNDO_LIMIT);
197 // to avoid the problem that feature is created in the current, not this, document
198 aSession->setActiveDocument(anApp->document(myID), false);
199 aSession->setCheckTransactions(false);
202 myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
203 myObjs->setOwner(theThis);
204 // update the current features status
205 setCurrentFeature(currentFeature(false), false);
206 aSession->setCheckTransactions(true);
207 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
208 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
209 // aSession->setActiveDocument(anApp->getDocument(myID), true);
211 // make sub-parts as loaded by demand
212 std::list<ResultPtr> aPartResults;
213 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
214 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
215 for(; aPartRes != aPartResults.end(); aPartRes++) {
216 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
218 anApp->setLoadByDemand(aPart->data()->name());
221 } else { // open failed, but new documnet was created to work with it: inform the model
222 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
227 bool Model_Document::save(
228 const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
230 // create a directory in the root document if it is not yet exist
231 Handle(Model_Application) anApp = Model_Application::getApplication();
234 CreateDirectory(theDirName, NULL);
236 mkdir(theDirName, 0x1ff);
239 // filename in the dir is id of document inside of the given directory
240 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
241 PCDM_StoreStatus aStatus;
243 aStatus = anApp->SaveAs(myDoc, aPath);
244 } catch (Standard_Failure) {
245 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
246 Events_InfoMessage("Model_Document",
247 "Exception in saving of document: %1").arg(aFail->GetMessageString()).send();
250 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
253 case PCDM_SS_DriverFailure:
254 Events_InfoMessage("Model_Document",
255 "Can not save document: save driver-library failure").send();
257 case PCDM_SS_WriteFailure:
258 Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
260 case PCDM_SS_Failure:
262 Events_InfoMessage("Model_Document", "Can not save document").send();
266 myTransactionSave = int(myTransactions.size());
267 if (isDone) { // save also sub-documents if any
268 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
269 // iterate all result parts to find all loaded or not yet loaded documents
270 std::list<ResultPtr> aPartResults;
271 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
272 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
273 for(; aPartRes != aPartResults.end(); aPartRes++) {
274 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
275 if (!aPart->isActivated()) {
276 // copy not-activated document that is not in the memory
277 std::string aDocName = aPart->data()->name();
278 if (!aDocName.empty()) {
280 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
281 OSD_Path aPath(aSubPath);
282 OSD_File aFile(aPath);
283 if (aFile.Exists()) {
284 TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
285 OSD_Path aDestination(aDestinationDir);
286 aFile.Copy(aDestination);
287 theResults.push_back(aDestinationDir.ToCString());
289 Events_InfoMessage("Model_Document",
290 "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
293 } else { // simply save opened document
294 isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
295 save(theDirName, aPart->data()->name().c_str(), theResults);
302 void Model_Document::close(const bool theForever)
304 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
305 if (!isRoot() && this == aPM->activeDocument().get()) {
306 aPM->setActiveDocument(aPM->moduleDocument());
307 } else if (isRoot()) {
308 // erase the active document if root is closed
309 aPM->setActiveDocument(DocumentPtr());
312 const std::set<int> aSubs = subDocuments();
313 std::set<int>::iterator aSubIter = aSubs.begin();
314 for (; aSubIter != aSubs.end(); aSubIter++) {
315 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
316 if (aSub->myObjs) // if it was not closed before
317 aSub->close(theForever);
320 // close for thid document needs no transaction in this document
321 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
323 // close all only if it is really asked, otherwise it can be undoed/redoed
325 // flush everything to avoid messages with bad objects
328 if (myDoc->CanClose() == CDM_CCS_OK)
330 mySelectionFeature.reset();
332 setCurrentFeature(FeaturePtr(), false); // disables all features
333 // update the OB: features are disabled (on remove of Part)
334 Events_Loop* aLoop = Events_Loop::loop();
335 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
336 aLoop->flush(aDeleteEvent);
339 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
342 void Model_Document::startOperation()
344 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
345 if (myDoc->HasOpenCommand()) { // start of nested command
346 if (myDoc->CommitCommand()) {
347 // commit the current: it will contain all nested after compactification
348 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
350 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
351 myDoc->OpenCommand();
352 } else { // start the simple command
355 // starts a new operation
356 myTransactions.push_back(Transaction());
357 if (!myNestedNum.empty())
358 (*myNestedNum.rbegin())++;
360 // new command for all subs
361 const std::set<int> aSubs = subDocuments();
362 std::set<int>::iterator aSubIter = aSubs.begin();
363 for (; aSubIter != aSubs.end(); aSubIter++)
364 subDoc(*aSubIter)->startOperation();
367 void Model_Document::compactNested()
369 if (!myNestedNum.empty()) {
370 int aNumToCompact = *(myNestedNum.rbegin());
371 int aSumOfTransaction = 0;
372 for(int a = 0; a < aNumToCompact; a++) {
373 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
374 myTransactions.pop_back();
376 // the latest transaction is the start of lower-level operation which startes the nested
377 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
378 myNestedNum.pop_back();
382 /// Compares the content of the given attributes, returns true if equal.
383 /// This method is used to avoid empty transactions when only "current" is changed
384 /// to some value and then comes back in this transaction, so, it compares only
385 /// references and Boolean and Integer Arrays for the current moment.
386 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
388 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
389 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
390 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
391 if (aRef1.IsNull() && aRef2.IsNull())
393 if (aRef1.IsNull() || aRef2.IsNull())
395 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
396 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
397 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
398 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
399 if (anArr1.IsNull() && anArr2.IsNull())
401 if (anArr1.IsNull() || anArr2.IsNull())
403 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
404 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
405 if (a != 1 && anArr1->Value(a) != anArr2->Value(a)) // second is for display
409 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
410 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
411 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
412 if (anArr1.IsNull() && anArr2.IsNull())
414 if (anArr1.IsNull() || anArr2.IsNull())
416 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
417 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
418 if (anArr1->Value(a) != anArr2->Value(a)) {
419 // avoid the transaction ID checking
420 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
421 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
427 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
428 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
429 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
430 if (anArr1.IsNull() && anArr2.IsNull())
432 if (anArr1.IsNull() || anArr2.IsNull())
434 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
435 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
436 if (anArr1->Value(a) != anArr2->Value(a)) {
437 // avoid the transaction ID checking
438 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
439 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
445 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
446 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
447 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
448 if (aList1.IsNull() && aList2.IsNull())
450 if (aList1.IsNull() || aList2.IsNull())
452 const TDF_LabelList& aLList1 = aList1->List();
453 const TDF_LabelList& aLList2 = aList2->List();
454 TDF_ListIteratorOfLabelList aLIter1(aLList1);
455 TDF_ListIteratorOfLabelList aLIter2(aLList2);
456 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
457 if (aLIter1.Value() != aLIter2.Value())
460 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
461 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
462 return true; // it just for created and removed feature: nothing is changed
467 /// Returns true if the last transaction is actually empty: modification to te same values
468 /// were performed only
469 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
470 Handle(TDF_Delta) aDelta;
471 aDelta = theDoc->GetUndos().Last();
472 TDF_LabelList aDeltaList;
473 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
474 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
477 // add also label of the modified attributes
478 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
479 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
480 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
481 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
482 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
483 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
484 Handle(TDF_Attribute) aCurrentAttr;
485 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
486 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
487 continue; // attribute is not changed actually
490 if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
491 continue; // error message is disappeared
500 bool Model_Document::finishOperation()
502 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
503 static std::shared_ptr<Model_Session> aSession =
504 std::static_pointer_cast<Model_Session>(Model_Session::get());
506 // open transaction if nested is closed to fit inside
507 // all synchronizeBackRefs and flushed consequences
508 if (isNestedClosed) {
509 myDoc->OpenCommand();
511 // do it before flashes to enable and recompute nesting features correctly
512 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
513 // if all nested operations are closed, make current the higher level objects (to perform
514 // it in the python scripts correctly): sketch become current after creation ofsub-elements
515 FeaturePtr aCurrent = currentFeature(false);
516 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
519 aNext = ModelAPI_Tools::compositeOwner(aMain);
521 if (aMain.get() && aMain != aCurrent)
522 setCurrentFeature(aMain, false);
524 myObjs->synchronizeBackRefs();
525 Events_Loop* aLoop = Events_Loop::loop();
526 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
527 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
528 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
529 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
531 if (isNestedClosed) {
532 if (myDoc->CommitCommand())
533 myTransactions.rbegin()->myOCAFNum++;
536 // this must be here just after everything is finished but before real transaction stop
537 // to avoid messages about modifications outside of the transaction
538 // and to rebuild everything after all updates and creates
539 if (isRoot()) { // once for root document
540 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
541 static std::shared_ptr<Events_Message> aFinishMsg
542 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
543 Events_Loop::loop()->send(aFinishMsg);
544 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
546 // to avoid "updated" message appearance by updater
547 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
549 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
550 bool aResult = false;
551 const std::set<int> aSubs = subDocuments();
552 std::set<int>::iterator aSubIter = aSubs.begin();
553 for (; aSubIter != aSubs.end(); aSubIter++)
554 if (subDoc(*aSubIter)->finishOperation())
557 // transaction may be empty if this document was created during this transaction (create part)
558 if (!myTransactions.empty() && myDoc->CommitCommand()) {
559 // if commit is successfull, just increment counters
560 if (isEmptyTransaction(myDoc)) { // erase this transaction
564 myTransactions.rbegin()->myOCAFNum++;
569 if (isNestedClosed) {
572 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
573 aResult = myTransactions.rbegin()->myOCAFNum != 0;
575 if (!aResult && isRoot()) {
576 // nothing inside in all documents, so remove this transaction from the transactions list
577 undoInternal(true, false);
579 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
582 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
583 subDoc(*aSubIter)->myDoc->ClearRedos();
584 subDoc(*aSubIter)->myRedos.clear();
590 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
591 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
592 const bool isRedo = false) {
593 Handle(TDF_Delta) aDelta;
595 aDelta = theDoc->GetRedos().First();
597 aDelta = theDoc->GetUndos().Last();
598 TDF_LabelList aDeltaList;
599 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
600 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
601 theDelta.Append(aListIter.Value());
603 // add also label of the modified attributes
604 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
605 /// named shape evolution also modifies integer on this label: exclude it
606 TDF_LabelMap anExcludedInt;
607 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
608 if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
609 // Boolean array is used for feature auxiliary attributes only, feature args are not modified
612 if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
613 anExcludedInt.Add(anAttr.Value()->Label());
614 // named shape evolution is changed in history update => skip them,
615 // they are not the features arguents
618 if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
619 if (anExcludedInt.Contains(anAttr.Value()->Label()))
622 theDelta.Append(anAttr.Value()->Label());
624 TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
625 for(; aDeltaIter.More(); aDeltaIter.Next()) {
626 if (anExcludedInt.Contains(aDeltaIter.Value())) {
627 theDelta.Remove(aDeltaIter);
628 if (!aDeltaIter.More())
634 void Model_Document::abortOperation()
636 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
637 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
639 // store undo-delta here as undo actually does in the method later
640 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
641 for(a = 0; a < aNumTransactions; a++) {
642 modifiedLabels(myDoc, aDeltaLabels);
645 for(a = 0; a < aNumTransactions; a++) {
649 undoInternal(false, false);
652 } else { // abort the current
653 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
654 myTransactions.pop_back();
655 if (!myNestedNum.empty())
656 (*myNestedNum.rbegin())--;
657 // roll back the needed number of transactions
658 //myDoc->AbortCommand();
659 // instead of abort, do commit and undo: to get the delta of modifications
660 if (myDoc->CommitCommand()) {
661 modifiedLabels(myDoc, aDeltaLabels);
664 for(int a = 0; a < aNumTransactions; a++) {
665 modifiedLabels(myDoc, aDeltaLabels);
670 // abort for all subs, flushes will be later, in the end of root abort
671 const std::set<int> aSubs = subDocuments();
672 std::set<int>::iterator aSubIter = aSubs.begin();
673 for (; aSubIter != aSubs.end(); aSubIter++)
674 subDoc(*aSubIter)->abortOperation();
675 // references may be changed because they are set in attributes on the fly
676 myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
679 bool Model_Document::isOperation() const
681 // operation is opened for all documents: no need to check subs
682 return myDoc->HasOpenCommand() == Standard_True ;
685 bool Model_Document::isModified()
687 // is modified if at least one operation was commited and not undoed
688 return myTransactions.size() != myTransactionSave || isOperation();
691 bool Model_Document::canUndo()
693 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
694 int aCurrentNum = isOperation() ? 1 : 0;
695 if (myDoc->GetAvailableUndos() > 0 &&
696 // there is something to undo in nested
697 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
698 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
700 // check other subs contains operation that can be undoed
701 const std::set<int> aSubs = subDocuments();
702 std::set<int>::iterator aSubIter = aSubs.begin();
703 for (; aSubIter != aSubs.end(); aSubIter++) {
704 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
705 if (aSub->myObjs) {// if it was not closed before
714 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
716 if (myTransactions.empty())
718 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
719 myRedos.push_back(*myTransactions.rbegin());
720 myTransactions.pop_back();
721 if (!myNestedNum.empty())
722 (*myNestedNum.rbegin())--;
723 // roll back the needed number of transactions
724 TDF_LabelList aDeltaLabels;
725 for(int a = 0; a < aNumTransactions; a++) {
727 modifiedLabels(myDoc, aDeltaLabels);
733 const std::set<int> aSubs = subDocuments();
734 std::set<int>::iterator aSubIter = aSubs.begin();
735 for (; aSubIter != aSubs.end(); aSubIter++) {
736 if (!subDoc(*aSubIter)->myObjs)
738 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
741 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
742 if (theSynchronize) {
743 myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
744 // update the current features status
745 setCurrentFeature(currentFeature(false), false);
749 void Model_Document::undo()
751 undoInternal(true, true);
754 bool Model_Document::canRedo()
756 if (!myRedos.empty())
758 // check other subs contains operation that can be redoed
759 const std::set<int> aSubs = subDocuments();
760 std::set<int>::iterator aSubIter = aSubs.begin();
761 for (; aSubIter != aSubs.end(); aSubIter++) {
762 if (!subDoc(*aSubIter)->myObjs)
764 if (subDoc(*aSubIter)->canRedo())
770 void Model_Document::redo()
772 if (!myNestedNum.empty())
773 (*myNestedNum.rbegin())++;
774 int aNumRedos = myRedos.rbegin()->myOCAFNum;
775 myTransactions.push_back(*myRedos.rbegin());
777 TDF_LabelList aDeltaLabels;
778 for(int a = 0; a < aNumRedos; a++) {
779 modifiedLabels(myDoc, aDeltaLabels, true);
784 const std::set<int> aSubs = subDocuments();
785 std::set<int>::iterator aSubIter = aSubs.begin();
786 for (; aSubIter != aSubs.end(); aSubIter++)
787 subDoc(*aSubIter)->redo();
789 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
790 myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
791 // update the current features status
792 setCurrentFeature(currentFeature(false), false);
795 std::list<std::string> Model_Document::undoList() const
797 std::list<std::string> aResult;
798 // the number of skipped current operations (on undo they will be aborted)
799 int aSkipCurrent = isOperation() ? 1 : 0;
800 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
801 int aNumUndo = int(myTransactions.size());
802 if (!myNestedNum.empty())
803 aNumUndo = *myNestedNum.rbegin();
804 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
805 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
811 std::list<std::string> Model_Document::redoList() const
813 std::list<std::string> aResult;
814 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
815 for( ; aTrIter != myRedos.crend(); aTrIter++) {
816 aResult.push_back(aTrIter->myId);
821 void Model_Document::operationId(const std::string& theId)
823 myTransactions.rbegin()->myId = theId;
826 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
828 std::shared_ptr<Model_Session> aSession =
829 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
830 FeaturePtr aFeature = aSession->createFeature(theID, this);
834 Model_Document* aDocToAdd;
835 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
836 if (aFeature->documentToAdd() != kind()) { // the root document by default
837 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
841 } else { // if customized is not presented, add to "this" document
845 // searching for feature after which must be added the next feature: this is the current feature
846 // but also all sub-features of this feature
847 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
848 bool isModified = true;
849 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
850 aComp.get() && isModified;
851 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
853 int aSubs = aComp->numberOfSubs(false);
854 for(int a = 0; a < aSubs; a++) {
855 FeaturePtr aSub = aComp->subFeature(a, false);
856 if (myObjs->isLater(aSub, aCurrent)) {
862 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
863 if (!aFeature->isAction()) { // do not add action to the data model
864 if (theMakeCurrent) // after all this feature stays in the document, so make it current
865 aDocToAdd->setCurrentFeature(aFeature, false);
866 } else { // feature must be executed
867 // no creation event => updater not working, problem with remove part
875 void Model_Document::refsToFeature(FeaturePtr theFeature,
876 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
878 myObjs->refsToFeature(theFeature, theRefs, isSendError);
881 void Model_Document::removeFeature(FeaturePtr theFeature)
883 myObjs->removeFeature(theFeature);
886 // recursive function to check if theSub is a child of theMain composite feature
887 // through all the hierarchy of parents
888 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
889 CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
892 if (aParent == theMain)
894 return isSub(theMain, aParent);
898 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
900 bool aCurrentUp = theMoved == currentFeature(false);
902 setCurrentFeatureUp();
904 // if user adds after high-level feature with nested,
905 // add it after all nested (otherwise the nested will be disabled)
906 CompositeFeaturePtr aCompositeAfter =
907 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
908 if (aCompositeAfter.get()) {
909 FeaturePtr aSub = aCompositeAfter;
911 FeaturePtr aNext = myObjs->nextFeature(aSub);
912 if (!isSub(aCompositeAfter, aNext)) {
917 } while (aSub.get());
920 myObjs->moveFeature(theMoved, theAfterThis);
921 if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
922 setCurrentFeature(currentFeature(false), false);
923 } else if (theAfterThis == currentFeature(false)) {
924 // must be after move to make enabled all features which are before theMoved
925 setCurrentFeature(theMoved, true);
929 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
931 myObjs->updateHistory(theObject);
934 void Model_Document::updateHistory(const std::string theGroup)
936 myObjs->updateHistory(theGroup);
939 const std::set<int> Model_Document::subDocuments() const
941 std::set<int> aResult;
942 std::list<ResultPtr> aPartResults;
943 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
944 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
945 for(; aPartRes != aPartResults.end(); aPartRes++) {
946 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
947 if (aPart && aPart->isActivated()) {
948 aResult.insert(aPart->original()->partDoc()->id());
954 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
956 // just store sub-document identifier here to manage it later
957 return std::dynamic_pointer_cast<Model_Document>(
958 Model_Application::getApplication()->document(theDocID));
961 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
963 return myObjs->object(theGroupID, theIndex);
966 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
967 const std::string& theGroupID, const std::string& theName)
969 return myObjs->objectByName(theGroupID, theName);
972 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
974 return myObjs->index(theObject);
977 int Model_Document::size(const std::string& theGroupID)
979 if (myObjs == 0) // may be on close
981 return myObjs->size(theGroupID);
984 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
986 if (!myObjs) // on close document feature destruction it may call this method
987 return std::shared_ptr<ModelAPI_Feature>();
988 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
989 Handle(TDF_Reference) aRef;
990 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
991 TDF_Label aLab = aRef->Get();
992 FeaturePtr aResult = myObjs->feature(aLab);
993 if (theVisible) { // get nearest visible (in history) going up
994 while(aResult.get() && !aResult->isInHistory()) {
995 aResult = myObjs->nextFeature(aResult, true);
1000 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1003 void Model_Document::setCurrentFeature(
1004 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1006 // blocks the flush signals to avoid each objects visualization in the viewer
1007 // they should not be shown once after all modifications are performed
1008 Events_Loop* aLoop = Events_Loop::loop();
1009 bool isActive = aLoop->activateFlushes(false);
1011 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1012 CompositeFeaturePtr aMain; // main feature that may nest the new current
1013 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1014 if (theCurrent.get()) {
1015 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1016 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1017 while(anOwner.get()) {
1021 anOwners.insert(anOwner);
1022 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1026 if (theVisible && !theCurrent.get()) {
1027 // needed to avoid disabling of PartSet initial constructions
1029 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1030 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1031 if (aNext->isInHistory()) {
1032 break; // next in history is not needed
1033 } else { // next not in history is good for making current
1038 if (theCurrent.get()) {
1039 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1040 if (!aData.get() || !aData->isValid()) {
1041 aLoop->activateFlushes(isActive);
1044 TDF_Label aFeatureLabel = aData->label().Father();
1046 Handle(TDF_Reference) aRef;
1047 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1048 aRef->Set(aFeatureLabel);
1050 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1052 } else { // remove reference for the null feature
1053 aRefLab.ForgetAttribute(TDF_Reference::GetID());
1055 // make all features after this feature disabled in reversed order
1056 // (to remove results without deps)
1057 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1059 bool aPassed = false; // flag that the current object is already passed in cycle
1060 FeaturePtr anIter = myObjs->lastFeature();
1061 bool aWasChanged = false;
1062 bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1063 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1064 // check this before passed become enabled: the current feature is enabled!
1065 if (anIter == theCurrent) aPassed = true;
1067 bool aDisabledFlag = !aPassed;
1069 if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1070 aDisabledFlag = false;
1071 else if (anOwners.find(anIter) != anOwners.end())
1072 // disable the higher-level feature is the nested is the current
1073 aDisabledFlag = true;
1076 if (anIter->getKind() == "Parameter") {
1077 // parameters are always out of the history of features, but not parameters
1078 // due to the issue 1491 all parameters are kept enabled any time
1079 //if (!isCurrentParameter)
1080 aDisabledFlag = false;
1081 } else if (isCurrentParameter) {
1082 // if paramater is active, all other features become enabled (issue 1307)
1083 aDisabledFlag = false;
1086 if (anIter->setDisabled(aDisabledFlag)) {
1087 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1088 // state of feature is changed => so inform that it must be updated if it has such state
1089 if (!aDisabledFlag &&
1090 (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1091 anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1092 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1093 // flush is in the end of this method
1094 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1097 // update for everyone the concealment flag immideately: on edit feature in the midle of history
1099 std::list<ResultPtr> aResults;
1100 ModelAPI_Tools::allResults(anIter, aResults);
1101 std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1102 for(; aRes != aResults.end(); aRes++) {
1103 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1104 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1106 // update the concealment status for disply in isConcealed of ResultBody
1107 for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1108 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1109 (*aRes)->isConcealed();
1113 // unblock the flush signals and up them after this
1114 aLoop->activateFlushes(isActive);
1117 void Model_Document::setCurrentFeatureUp()
1119 // on remove just go up for minimum step: highlight external objects in sketch causes
1120 // problems if it is true: here and in "setCurrentFeature"
1121 FeaturePtr aCurrent = currentFeature(false);
1122 if (aCurrent.get()) { // if not, do nothing because null is the upper
1123 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1124 // make the higher level composite as current (sketch becomes disabled if line is enabled)
1126 FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1127 // without cycle (issue 1555): otherwise extrusion fuse
1128 // will be enabled and displayed whaen inside sketch
1132 // do not flush: it is called only on remove, it will be flushed in the end of transaction
1133 setCurrentFeature(aPrev, false);
1137 TDF_Label Model_Document::generalLabel() const
1139 return myDoc->Main().FindChild(TAG_GENERAL);
1142 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1143 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1145 return myObjs->createConstruction(theFeatureData, theIndex);
1148 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1149 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1151 return myObjs->createBody(theFeatureData, theIndex);
1154 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1155 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1157 return myObjs->createPart(theFeatureData, theIndex);
1160 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1161 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1162 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1164 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1167 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1168 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1170 return myObjs->createGroup(theFeatureData, theIndex);
1173 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1174 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1176 return myObjs->createField(theFeatureData, theIndex);
1179 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1180 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1182 return myObjs->createParameter(theFeatureData, theIndex);
1185 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1186 const std::shared_ptr<ModelAPI_Result>& theResult)
1188 return myObjs->feature(theResult);
1191 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1193 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1196 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1198 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1201 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1203 myNamingNames[theName] = theLabel;
1206 void Model_Document::changeNamingName(const std::string theOldName, const std::string theNewName)
1208 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theOldName);
1209 if (aFind != myNamingNames.end()) {
1210 myNamingNames[theNewName] = aFind->second;
1211 myNamingNames.erase(theOldName);
1215 TDF_Label Model_Document::findNamingName(std::string theName)
1217 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1218 if (aFind != myNamingNames.end()) {
1219 return aFind->second;
1221 // not found exact name, try to find by sub-components
1222 std::string::size_type aSlash = theName.rfind('/');
1223 if (aSlash != std::string::npos) {
1224 std::string anObjName = theName.substr(0, aSlash);
1225 aFind = myNamingNames.find(anObjName);
1226 if (aFind != myNamingNames.end()) {
1227 TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1228 // searching sub-labels with this name
1229 TDF_ChildIDIterator aNamesIter(aFind->second, TDataStd_Name::GetID(), Standard_True);
1230 for(; aNamesIter.More(); aNamesIter.Next()) {
1231 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1232 if (aName->Get() == aSubName)
1233 return aName->Label();
1237 return TDF_Label(); // not found
1240 ResultPtr Model_Document::findByName(const std::string theName)
1242 return myObjs->findByName(theName);
1245 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1247 return myObjs->allFeatures();
1250 void Model_Document::setActive(const bool theFlag)
1252 if (theFlag != myIsActive) {
1253 myIsActive = theFlag;
1254 // redisplay all the objects of this part
1255 static Events_Loop* aLoop = Events_Loop::loop();
1256 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1258 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1259 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1260 object(ModelAPI_Feature::group(), a));
1261 if (aFeature.get() && aFeature->data()->isValid()) {
1262 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1263 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1264 for(; aRes != aResList.end(); aRes++) {
1265 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1266 // #issue 1048: sub-compsolids also
1267 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1268 if (aCompRes.get()) {
1269 int aNumSubs = aCompRes->numberOfSubs();
1270 for(int a = 0; a < aNumSubs; a++) {
1271 ResultPtr aSub = aCompRes->subResult(a);
1273 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1283 bool Model_Document::isActive() const
1288 int Model_Document::transactionID()
1290 Handle(TDataStd_Integer) anIndex;
1291 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1292 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1293 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1295 return anIndex->Get();
1298 void Model_Document::incrementTransactionID()
1300 int aNewVal = transactionID() + 1;
1301 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1303 void Model_Document::decrementTransactionID()
1305 int aNewVal = transactionID() - 1;
1306 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1309 bool Model_Document::isOpened()
1311 return myObjs && !myDoc.IsNull();
1314 int Model_Document::numInternalFeatures()
1316 return myObjs->numInternalFeatures();
1319 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1321 return myObjs->internalFeature(theIndex);
1324 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1326 return myObjs->featureById(theId);
1329 void Model_Document::synchronizeTransactions()
1331 Model_Document* aRoot =
1332 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1334 return; // don't need to synchronise root with root
1336 std::shared_ptr<Model_Session> aSession =
1337 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1338 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1339 aSession->setCheckTransactions(false);
1341 aSession->setCheckTransactions(true);
1343 /* this case can not be reproduced in any known case for the current moment, so, just comment
1344 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1345 undoInternal(false, true);
1349 /// Feature that is used for selection in the Part document by the external request
1350 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1352 /// Nothing to do in constructor
1353 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1355 /// Returns the unique kind of a feature
1356 virtual const std::string& getKind() {
1357 static std::string MY_KIND("InternalSelectionInPartFeature");
1360 /// Request for initialization of data model of the object: adding all attributes
1361 virtual void initAttributes() {
1362 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1364 /// Nothing to do in the execution function
1365 virtual void execute() {}
1369 //! Returns the feature that is used for calculation of selection externally from the document
1370 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1372 // return already created, otherwise create
1373 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1375 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1377 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1378 std::shared_ptr<Model_Data> aData(new Model_Data);
1379 aData->setLabel(aFeatureLab.FindChild(1));
1380 aData->setObject(mySelectionFeature);
1381 mySelectionFeature->setDoc(myObjs->owner());
1382 mySelectionFeature->setData(aData);
1383 std::string aName = id() + "_Part";
1384 mySelectionFeature->data()->setName(aName);
1385 mySelectionFeature->setDoc(myObjs->owner());
1386 mySelectionFeature->initAttributes();
1387 mySelectionFeature->init(); // to make it enabled and Update correctly
1388 // this update may cause recomputation of the part after selection on it, that is not needed
1389 mySelectionFeature->data()->blockSendAttributeUpdated(true);
1391 return mySelectionFeature->selectionList("selection");
1394 FeaturePtr Model_Document::lastFeature()
1397 return myObjs->lastFeature();
1398 return FeaturePtr();
1401 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1402 Handle(TNaming_NamedShape) aResult;
1403 while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1404 TopoDS_Shape aShape = theShape;
1406 // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1407 if (!TNaming_Tool::HasLabel(aMain, aShape))
1409 for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1410 TDF_Label aNSLab = anIter.Label();
1411 Handle(TNaming_NamedShape) aNS;
1412 if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1413 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1414 if (aShapesIter.Evolution() == TNaming_SELECTED ||
1415 aShapesIter.Evolution() == TNaming_DELETE)
1416 continue; // don't use the selection evolution
1417 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1419 if (aResult->Evolution() == TNaming_MODIFY)
1420 theShape = aShapesIter.OldShape();
1421 // otherwise may me searching for another item of this shape with longer history
1422 if (!theShape.IsNull())
1432 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1433 std::shared_ptr<ModelAPI_Result> theResult,
1434 const std::shared_ptr<GeomAPI_Shape>& theShape)
1436 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1438 return feature(theResult); // for not-body just returns the feature that produced this result
1440 // otherwise get the shape and search the very initial label for it
1441 TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1442 if (aShape.IsNull())
1443 return FeaturePtr();
1445 // for comsolids and compounds all the naming is located in the main object, so, try to use
1447 ResultCompSolidPtr aMain = ModelAPI_Tools::compSolidOwner(theResult);
1449 FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1454 std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1455 if (!aBodyData.get() || !aBodyData->isValid())
1456 return FeaturePtr();
1458 TopoDS_Shape anOldShape; // old shape in the pair oldshape->theShape in the named shape
1459 TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1460 Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1461 TDF_Label aBodyLab = aBodyData->label();
1462 // use childs and this label (the lowest priority)
1463 TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1464 bool aUseThis = !aNSIter.More();
1465 while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1466 Handle(TNaming_NamedShape) aNS;
1468 if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1471 aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1473 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1474 if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1475 continue; // don't use the selection evolution
1476 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1477 aCandidatInThis = aNS;
1478 if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1479 anOldShape = aShapesIter.OldShape();
1480 // otherwise may me searching for another item of this shape with longer history
1481 if (!anOldShape.IsNull())
1484 // check that the shape contains aShape as sub-shape to fill container
1485 if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1486 TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1487 for(; anExp.More(); anExp.Next()) {
1488 if (aShape.IsSame(anExp.Current())) {
1489 aCandidatContainer = aNS;
1490 aShapeContainer = aShapesIter.NewShape();
1495 // iterate to the next label or to the body label in the end
1498 if (!aNSIter.More()) {
1504 if (aCandidatInThis.IsNull()) {
1505 // to fix 1512: searching for original shape of this shape
1506 // if modification of it is not in this result
1507 aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1508 if (aCandidatInThis.IsNull()) {
1509 if (aCandidatContainer.IsNull())
1510 return FeaturePtr();
1511 // with the lower priority use the higher level shape that contains aShape
1512 aCandidatInThis = aCandidatContainer;
1513 anOldShape = aShapeContainer;
1515 // to stop the searching by the following searchForOriginalShape
1516 anOldShape.Nullify();
1520 Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1522 aCandidatInThis = aNS;
1525 TDF_Label aResultLab = aCandidatInThis->Label();
1526 while(aResultLab.Depth() > 3)
1527 aResultLab = aResultLab.Father();
1528 FeaturePtr aFeature = myObjs->feature(aResultLab);
1529 if (aFeature.get()) {
1530 if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1537 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1539 return myObjs->isLater(theLater, theCurrent);