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; ///< reference to the current feature
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
73 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
75 Model_Document::Model_Document(const int theID, const std::string theKind)
76 : myID(theID), myKind(theKind), myIsActive(false),
77 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
80 CDF_Session::CurrentSession()->Directory()->Add(myDoc);
82 myObjs = new Model_Objects(myDoc->Main());
83 myDoc->SetUndoLimit(UNDO_LIMIT);
84 myTransactionSave = 0;
85 myExecuteFeatures = true;
86 // to have something in the document and avoid empty doc open/save problem
87 // in transaction for nesting correct working
89 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
90 // this to avoid creation of integer attribute outside the transaction after undo
92 myDoc->CommitCommand();
95 void Model_Document::setThis(DocumentPtr theDoc)
97 myObjs->setOwner(theDoc);
100 /// Returns the file name of this document by the name of directory and identifier of a document
101 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
103 TCollection_ExtendedString aPath((const Standard_CString) theDirName);
104 // remove end-separators
105 while(aPath.Length() &&
106 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
107 aPath.Remove(aPath.Length());
108 aPath += _separator_;
109 aPath += theID.c_str();
110 aPath += ".cbf"; // standard binary file extension
114 bool Model_Document::isRoot() const
116 return this == Model_Session::get()->moduleDocument().get();
119 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
121 Handle(Model_Application) anApp = Model_Application::getApplication();
123 anApp->setLoadPath(theDirName);
125 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
126 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
127 Handle(TDocStd_Document) aLoaded;
129 aStatus = anApp->Open(aPath, aLoaded);
130 } catch (Standard_Failure) {
131 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
132 Events_InfoMessage("Model_Document",
133 "Exception in opening of document: %1").arg(aFail->GetMessageString()).send();
136 bool isError = aStatus != PCDM_RS_OK;
139 case PCDM_RS_UnknownDocument:
140 Events_InfoMessage("Model_Document", "Can not open document").send();
142 case PCDM_RS_AlreadyRetrieved:
143 Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
145 case PCDM_RS_AlreadyRetrievedAndModified:
146 Events_InfoMessage("Model_Document",
147 "Can not open document: already opened and modified").send();
149 case PCDM_RS_NoDriver:
150 Events_InfoMessage("Model_Document",
151 "Can not open document: driver library is not found").send();
153 case PCDM_RS_UnknownFileDriver:
154 Events_InfoMessage("Model_Document",
155 "Can not open document: unknown driver for opening").send();
157 case PCDM_RS_OpenError:
158 Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
160 case PCDM_RS_NoVersion:
161 Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
163 case PCDM_RS_NoModel:
164 Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
166 case PCDM_RS_NoDocument:
167 Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
169 case PCDM_RS_FormatFailure:
170 Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
172 case PCDM_RS_TypeNotFoundInSchema:
173 Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
175 case PCDM_RS_UnrecognizedFileFormat:
176 Events_InfoMessage("Model_Document",
177 "Can not open document: unrecognized file format").send();
179 case PCDM_RS_MakeFailure:
180 Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
182 case PCDM_RS_PermissionDenied:
183 Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
185 case PCDM_RS_DriverFailure:
186 Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
189 Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
193 std::shared_ptr<Model_Session> aSession =
194 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
197 myDoc->SetUndoLimit(UNDO_LIMIT);
198 // to avoid the problem that feature is created in the current, not this, document
199 aSession->setActiveDocument(anApp->document(myID), false);
200 aSession->setCheckTransactions(false);
203 myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
204 myObjs->setOwner(theThis);
205 // update the current features status
206 setCurrentFeature(currentFeature(false), false);
207 aSession->setCheckTransactions(true);
208 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
209 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
210 // aSession->setActiveDocument(anApp->getDocument(myID), true);
212 // make sub-parts as loaded by demand
213 std::list<ResultPtr> aPartResults;
214 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
215 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
216 for(; aPartRes != aPartResults.end(); aPartRes++) {
217 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
219 anApp->setLoadByDemand(aPart->data()->name());
222 } else { // open failed, but new documnet was created to work with it: inform the model
223 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
228 bool Model_Document::save(
229 const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
231 // create a directory in the root document if it is not yet exist
232 Handle(Model_Application) anApp = Model_Application::getApplication();
235 CreateDirectory(theDirName, NULL);
237 mkdir(theDirName, 0x1ff);
240 // filename in the dir is id of document inside of the given directory
241 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
242 PCDM_StoreStatus aStatus;
244 aStatus = anApp->SaveAs(myDoc, aPath);
245 } catch (Standard_Failure) {
246 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
247 Events_InfoMessage("Model_Document",
248 "Exception in saving of document: %1").arg(aFail->GetMessageString()).send();
251 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
254 case PCDM_SS_DriverFailure:
255 Events_InfoMessage("Model_Document",
256 "Can not save document: save driver-library failure").send();
258 case PCDM_SS_WriteFailure:
259 Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
261 case PCDM_SS_Failure:
263 Events_InfoMessage("Model_Document", "Can not save document").send();
267 myTransactionSave = int(myTransactions.size());
268 if (isDone) { // save also sub-documents if any
269 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
270 // iterate all result parts to find all loaded or not yet loaded documents
271 std::list<ResultPtr> aPartResults;
272 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
273 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
274 for(; aPartRes != aPartResults.end(); aPartRes++) {
275 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
276 if (!aPart->isActivated()) {
277 // copy not-activated document that is not in the memory
278 std::string aDocName = aPart->data()->name();
279 if (!aDocName.empty()) {
281 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
282 OSD_Path aPath(aSubPath);
283 OSD_File aFile(aPath);
284 if (aFile.Exists()) {
285 TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
286 OSD_Path aDestination(aDestinationDir);
287 aFile.Copy(aDestination);
288 theResults.push_back(aDestinationDir.ToCString());
290 Events_InfoMessage("Model_Document",
291 "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
294 } else { // simply save opened document
295 isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
296 save(theDirName, aPart->data()->name().c_str(), theResults);
303 void Model_Document::close(const bool theForever)
305 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
306 if (!isRoot() && this == aPM->activeDocument().get()) {
307 aPM->setActiveDocument(aPM->moduleDocument());
308 } else if (isRoot()) {
309 // erase the active document if root is closed
310 aPM->setActiveDocument(DocumentPtr());
313 const std::set<int> aSubs = subDocuments();
314 std::set<int>::iterator aSubIter = aSubs.begin();
315 for (; aSubIter != aSubs.end(); aSubIter++) {
316 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
317 if (aSub->myObjs) // if it was not closed before
318 aSub->close(theForever);
321 // close for thid document needs no transaction in this document
322 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
324 // close all only if it is really asked, otherwise it can be undoed/redoed
326 // flush everything to avoid messages with bad objects
329 if (myDoc->CanClose() == CDM_CCS_OK)
331 mySelectionFeature.reset();
333 setCurrentFeature(FeaturePtr(), false); // disables all features
334 // update the OB: features are disabled (on remove of Part)
335 Events_Loop* aLoop = Events_Loop::loop();
336 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
337 aLoop->flush(aDeleteEvent);
340 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
343 void Model_Document::startOperation()
345 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
346 if (myDoc->HasOpenCommand()) { // start of nested command
347 if (myDoc->CommitCommand()) {
348 // commit the current: it will contain all nested after compactification
349 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
351 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
352 myDoc->OpenCommand();
353 } else { // start the simple command
356 // starts a new operation
357 myTransactions.push_back(Transaction());
358 if (!myNestedNum.empty())
359 (*myNestedNum.rbegin())++;
361 // new command for all subs
362 const std::set<int> aSubs = subDocuments();
363 std::set<int>::iterator aSubIter = aSubs.begin();
364 for (; aSubIter != aSubs.end(); aSubIter++)
365 subDoc(*aSubIter)->startOperation();
368 void Model_Document::compactNested()
370 if (!myNestedNum.empty()) {
371 int aNumToCompact = *(myNestedNum.rbegin());
372 int aSumOfTransaction = 0;
373 for(int a = 0; a < aNumToCompact; a++) {
374 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
375 myTransactions.pop_back();
377 // the latest transaction is the start of lower-level operation which startes the nested
378 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
379 myNestedNum.pop_back();
383 /// Compares the content of the given attributes, returns true if equal.
384 /// This method is used to avoid empty transactions when only "current" is changed
385 /// to some value and then comes back in this transaction, so, it compares only
386 /// references and Boolean and Integer Arrays for the current moment.
387 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
389 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
390 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
391 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
392 if (aRef1.IsNull() && aRef2.IsNull())
394 if (aRef1.IsNull() || aRef2.IsNull())
396 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
397 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
398 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
399 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
400 if (anArr1.IsNull() && anArr2.IsNull())
402 if (anArr1.IsNull() || anArr2.IsNull())
404 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
405 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
406 if (a != 1 && anArr1->Value(a) != anArr2->Value(a)) // second is for display
410 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
411 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
412 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
413 if (anArr1.IsNull() && anArr2.IsNull())
415 if (anArr1.IsNull() || anArr2.IsNull())
417 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
418 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
419 if (anArr1->Value(a) != anArr2->Value(a)) {
420 // avoid the transaction ID checking
421 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
422 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
428 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
429 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
430 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
431 if (anArr1.IsNull() && anArr2.IsNull())
433 if (anArr1.IsNull() || anArr2.IsNull())
435 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
436 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
437 if (anArr1->Value(a) != anArr2->Value(a)) {
438 // avoid the transaction ID checking
439 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
440 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
446 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
447 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
448 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
449 if (aList1.IsNull() && aList2.IsNull())
451 if (aList1.IsNull() || aList2.IsNull())
453 const TDF_LabelList& aLList1 = aList1->List();
454 const TDF_LabelList& aLList2 = aList2->List();
455 TDF_ListIteratorOfLabelList aLIter1(aLList1);
456 TDF_ListIteratorOfLabelList aLIter2(aLList2);
457 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
458 if (aLIter1.Value() != aLIter2.Value())
461 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
462 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
463 return true; // it just for created and removed feature: nothing is changed
468 /// Returns true if the last transaction is actually empty: modification to te same values
469 /// were performed only
470 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
471 Handle(TDF_Delta) aDelta;
472 aDelta = theDoc->GetUndos().Last();
473 TDF_LabelList aDeltaList;
474 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
475 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
478 // add also label of the modified attributes
479 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
480 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
481 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
482 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
483 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
484 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
485 Handle(TDF_Attribute) aCurrentAttr;
486 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
487 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
488 continue; // attribute is not changed actually
491 if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
492 continue; // error message is disappeared
501 bool Model_Document::finishOperation()
503 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
504 static std::shared_ptr<Model_Session> aSession =
505 std::static_pointer_cast<Model_Session>(Model_Session::get());
507 // open transaction if nested is closed to fit inside
508 // all synchronizeBackRefs and flushed consequences
509 if (isNestedClosed) {
510 myDoc->OpenCommand();
512 // do it before flashes to enable and recompute nesting features correctly
513 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
514 // if all nested operations are closed, make current the higher level objects (to perform
515 // it in the python scripts correctly): sketch become current after creation ofsub-elements
516 FeaturePtr aCurrent = currentFeature(false);
517 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
520 aNext = ModelAPI_Tools::compositeOwner(aMain);
522 if (aMain.get() && aMain != aCurrent)
523 setCurrentFeature(aMain, false);
525 myObjs->synchronizeBackRefs();
526 Events_Loop* aLoop = Events_Loop::loop();
527 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
528 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
529 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_TO_REDISPLAY));
530 aLoop->flush(Events_Loop::eventByName(EVENT_OBJECT_DELETED));
532 if (isNestedClosed) {
533 if (myDoc->CommitCommand())
534 myTransactions.rbegin()->myOCAFNum++;
537 // this must be here just after everything is finished but before real transaction stop
538 // to avoid messages about modifications outside of the transaction
539 // and to rebuild everything after all updates and creates
540 if (isRoot()) { // once for root document
541 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
542 static std::shared_ptr<Events_Message> aFinishMsg
543 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
544 Events_Loop::loop()->send(aFinishMsg);
545 Events_Loop::loop()->autoFlush(Events_Loop::eventByName(EVENT_OBJECT_UPDATED), false);
547 // to avoid "updated" message appearance by updater
548 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
550 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
551 bool aResult = false;
552 const std::set<int> aSubs = subDocuments();
553 std::set<int>::iterator aSubIter = aSubs.begin();
554 for (; aSubIter != aSubs.end(); aSubIter++)
555 if (subDoc(*aSubIter)->finishOperation())
558 // transaction may be empty if this document was created during this transaction (create part)
559 if (!myTransactions.empty() && myDoc->CommitCommand()) {
560 // if commit is successfull, just increment counters
561 if (isEmptyTransaction(myDoc)) { // erase this transaction
565 myTransactions.rbegin()->myOCAFNum++;
570 if (isNestedClosed) {
573 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
574 aResult = myTransactions.rbegin()->myOCAFNum != 0;
576 if (!aResult && isRoot()) {
577 // nothing inside in all documents, so remove this transaction from the transactions list
578 undoInternal(true, false);
580 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
583 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
584 subDoc(*aSubIter)->myDoc->ClearRedos();
585 subDoc(*aSubIter)->myRedos.clear();
591 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
592 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
593 const bool isRedo = false) {
594 Handle(TDF_Delta) aDelta;
596 aDelta = theDoc->GetRedos().First();
598 aDelta = theDoc->GetUndos().Last();
599 TDF_LabelList aDeltaList;
600 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
601 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
602 theDelta.Append(aListIter.Value());
604 // add also label of the modified attributes
605 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
606 /// named shape evolution also modifies integer on this label: exclude it
607 TDF_LabelMap anExcludedInt;
608 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
609 if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
610 // Boolean array is used for feature auxiliary attributes only, feature args are not modified
613 if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
614 anExcludedInt.Add(anAttr.Value()->Label());
615 // named shape evolution is changed in history update => skip them,
616 // they are not the features arguents
619 if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
620 if (anExcludedInt.Contains(anAttr.Value()->Label()))
623 theDelta.Append(anAttr.Value()->Label());
625 TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
626 for(; aDeltaIter.More(); aDeltaIter.Next()) {
627 if (anExcludedInt.Contains(aDeltaIter.Value())) {
628 theDelta.Remove(aDeltaIter);
629 if (!aDeltaIter.More())
635 void Model_Document::abortOperation()
637 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
638 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
640 // store undo-delta here as undo actually does in the method later
641 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
642 for(a = 0; a < aNumTransactions; a++) {
643 modifiedLabels(myDoc, aDeltaLabels);
646 for(a = 0; a < aNumTransactions; a++) {
650 undoInternal(false, false);
653 } else { // abort the current
654 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
655 myTransactions.pop_back();
656 if (!myNestedNum.empty())
657 (*myNestedNum.rbegin())--;
658 // roll back the needed number of transactions
659 //myDoc->AbortCommand();
660 // instead of abort, do commit and undo: to get the delta of modifications
661 if (myDoc->CommitCommand()) {
662 modifiedLabels(myDoc, aDeltaLabels);
665 for(int a = 0; a < aNumTransactions; a++) {
666 modifiedLabels(myDoc, aDeltaLabels);
671 // abort for all subs, flushes will be later, in the end of root abort
672 const std::set<int> aSubs = subDocuments();
673 std::set<int>::iterator aSubIter = aSubs.begin();
674 for (; aSubIter != aSubs.end(); aSubIter++)
675 subDoc(*aSubIter)->abortOperation();
676 // references may be changed because they are set in attributes on the fly
677 myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
680 bool Model_Document::isOperation() const
682 // operation is opened for all documents: no need to check subs
683 return myDoc->HasOpenCommand() == Standard_True ;
686 bool Model_Document::isModified()
688 // is modified if at least one operation was commited and not undoed
689 return myTransactions.size() != myTransactionSave || isOperation();
692 bool Model_Document::canUndo()
694 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
695 int aCurrentNum = isOperation() ? 1 : 0;
696 if (myDoc->GetAvailableUndos() > 0 &&
697 // there is something to undo in nested
698 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
699 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
701 // check other subs contains operation that can be undoed
702 const std::set<int> aSubs = subDocuments();
703 std::set<int>::iterator aSubIter = aSubs.begin();
704 for (; aSubIter != aSubs.end(); aSubIter++) {
705 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
706 if (aSub->myObjs) {// if it was not closed before
715 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
717 if (myTransactions.empty())
719 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
720 myRedos.push_back(*myTransactions.rbegin());
721 myTransactions.pop_back();
722 if (!myNestedNum.empty())
723 (*myNestedNum.rbegin())--;
724 // roll back the needed number of transactions
725 TDF_LabelList aDeltaLabels;
726 for(int a = 0; a < aNumTransactions; a++) {
728 modifiedLabels(myDoc, aDeltaLabels);
734 const std::set<int> aSubs = subDocuments();
735 std::set<int>::iterator aSubIter = aSubs.begin();
736 for (; aSubIter != aSubs.end(); aSubIter++) {
737 if (!subDoc(*aSubIter)->myObjs)
739 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
742 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
743 if (theSynchronize) {
744 myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
745 // update the current features status
746 setCurrentFeature(currentFeature(false), false);
750 void Model_Document::undo()
752 undoInternal(true, true);
755 bool Model_Document::canRedo()
757 if (!myRedos.empty())
759 // check other subs contains operation that can be redoed
760 const std::set<int> aSubs = subDocuments();
761 std::set<int>::iterator aSubIter = aSubs.begin();
762 for (; aSubIter != aSubs.end(); aSubIter++) {
763 if (!subDoc(*aSubIter)->myObjs)
765 if (subDoc(*aSubIter)->canRedo())
771 void Model_Document::redo()
773 if (!myNestedNum.empty())
774 (*myNestedNum.rbegin())++;
775 int aNumRedos = myRedos.rbegin()->myOCAFNum;
776 myTransactions.push_back(*myRedos.rbegin());
778 TDF_LabelList aDeltaLabels;
779 for(int a = 0; a < aNumRedos; a++) {
780 modifiedLabels(myDoc, aDeltaLabels, true);
785 const std::set<int> aSubs = subDocuments();
786 std::set<int>::iterator aSubIter = aSubs.begin();
787 for (; aSubIter != aSubs.end(); aSubIter++)
788 subDoc(*aSubIter)->redo();
790 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
791 myObjs->synchronizeFeatures(aDeltaLabels, true, false, isRoot());
792 // update the current features status
793 setCurrentFeature(currentFeature(false), false);
796 std::list<std::string> Model_Document::undoList() const
798 std::list<std::string> aResult;
799 // the number of skipped current operations (on undo they will be aborted)
800 int aSkipCurrent = isOperation() ? 1 : 0;
801 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
802 int aNumUndo = int(myTransactions.size());
803 if (!myNestedNum.empty())
804 aNumUndo = *myNestedNum.rbegin();
805 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
806 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
812 std::list<std::string> Model_Document::redoList() const
814 std::list<std::string> aResult;
815 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
816 for( ; aTrIter != myRedos.crend(); aTrIter++) {
817 aResult.push_back(aTrIter->myId);
822 void Model_Document::operationId(const std::string& theId)
824 myTransactions.rbegin()->myId = theId;
827 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
829 std::shared_ptr<Model_Session> aSession =
830 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
831 FeaturePtr aFeature = aSession->createFeature(theID, this);
835 Model_Document* aDocToAdd;
836 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
837 if (aFeature->documentToAdd() != kind()) { // the root document by default
838 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
842 } else { // if customized is not presented, add to "this" document
846 // searching for feature after which must be added the next feature: this is the current feature
847 // but also all sub-features of this feature
848 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
849 bool isModified = true;
850 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
851 aComp.get() && isModified;
852 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
854 int aSubs = aComp->numberOfSubs(false);
855 for(int a = 0; a < aSubs; a++) {
856 FeaturePtr aSub = aComp->subFeature(a, false);
857 if (myObjs->isLater(aSub, aCurrent)) {
863 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
864 if (!aFeature->isAction()) { // do not add action to the data model
865 if (theMakeCurrent) // after all this feature stays in the document, so make it current
866 aDocToAdd->setCurrentFeature(aFeature, false);
867 } else { // feature must be executed
868 // no creation event => updater not working, problem with remove part
876 void Model_Document::refsToFeature(FeaturePtr theFeature,
877 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
879 myObjs->refsToFeature(theFeature, theRefs, isSendError);
882 void Model_Document::removeFeature(FeaturePtr theFeature)
884 myObjs->removeFeature(theFeature);
887 // recursive function to check if theSub is a child of theMain composite feature
888 // through all the hierarchy of parents
889 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
890 CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
893 if (aParent == theMain)
895 return isSub(theMain, aParent);
899 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
901 bool aCurrentUp = theMoved == currentFeature(false);
903 setCurrentFeatureUp();
905 // if user adds after high-level feature with nested,
906 // add it after all nested (otherwise the nested will be disabled)
907 CompositeFeaturePtr aCompositeAfter =
908 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
909 if (aCompositeAfter.get()) {
910 FeaturePtr aSub = aCompositeAfter;
912 FeaturePtr aNext = myObjs->nextFeature(aSub);
913 if (!isSub(aCompositeAfter, aNext)) {
918 } while (aSub.get());
921 myObjs->moveFeature(theMoved, theAfterThis);
922 if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
923 setCurrentFeature(currentFeature(false), false);
924 } else if (theAfterThis == currentFeature(false)) {
925 // must be after move to make enabled all features which are before theMoved
926 setCurrentFeature(theMoved, true);
930 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
932 myObjs->updateHistory(theObject);
935 void Model_Document::updateHistory(const std::string theGroup)
937 myObjs->updateHistory(theGroup);
940 const std::set<int> Model_Document::subDocuments() const
942 std::set<int> aResult;
943 std::list<ResultPtr> aPartResults;
944 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
945 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
946 for(; aPartRes != aPartResults.end(); aPartRes++) {
947 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
948 if (aPart && aPart->isActivated()) {
949 aResult.insert(aPart->original()->partDoc()->id());
955 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
957 // just store sub-document identifier here to manage it later
958 return std::dynamic_pointer_cast<Model_Document>(
959 Model_Application::getApplication()->document(theDocID));
962 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
964 return myObjs->object(theGroupID, theIndex);
967 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
968 const std::string& theGroupID, const std::string& theName)
970 return myObjs->objectByName(theGroupID, theName);
973 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
975 return myObjs->index(theObject);
978 int Model_Document::size(const std::string& theGroupID)
980 if (myObjs == 0) // may be on close
982 return myObjs->size(theGroupID);
985 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
987 if (!myObjs) // on close document feature destruction it may call this method
988 return std::shared_ptr<ModelAPI_Feature>();
989 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
990 Handle(TDF_Reference) aRef;
991 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
992 TDF_Label aLab = aRef->Get();
993 FeaturePtr aResult = myObjs->feature(aLab);
994 if (theVisible) { // get nearest visible (in history) going up
995 while(aResult.get() && !aResult->isInHistory()) {
996 aResult = myObjs->nextFeature(aResult, true);
1001 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1004 void Model_Document::setCurrentFeature(
1005 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1007 // blocks the flush signals to avoid each objects visualization in the viewer
1008 // they should not be shown once after all modifications are performed
1009 Events_Loop* aLoop = Events_Loop::loop();
1010 bool isActive = aLoop->activateFlushes(false);
1012 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1013 CompositeFeaturePtr aMain; // main feature that may nest the new current
1014 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1015 if (theCurrent.get()) {
1016 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1017 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1018 while(anOwner.get()) {
1022 anOwners.insert(anOwner);
1023 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1027 if (theVisible && !theCurrent.get()) {
1028 // needed to avoid disabling of PartSet initial constructions
1030 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1031 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1032 if (aNext->isInHistory()) {
1033 break; // next in history is not needed
1034 } else { // next not in history is good for making current
1039 if (theCurrent.get()) {
1040 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1041 if (!aData.get() || !aData->isValid()) {
1042 aLoop->activateFlushes(isActive);
1045 TDF_Label aFeatureLabel = aData->label().Father();
1047 Handle(TDF_Reference) aRef;
1048 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1049 aRef->Set(aFeatureLabel);
1051 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1053 } else { // remove reference for the null feature
1054 aRefLab.ForgetAttribute(TDF_Reference::GetID());
1056 // make all features after this feature disabled in reversed order
1057 // (to remove results without deps)
1058 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1060 bool aPassed = false; // flag that the current object is already passed in cycle
1061 FeaturePtr anIter = myObjs->lastFeature();
1062 bool aWasChanged = false;
1063 bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1064 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1065 // check this before passed become enabled: the current feature is enabled!
1066 if (anIter == theCurrent) aPassed = true;
1068 bool aDisabledFlag = !aPassed;
1070 if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1071 aDisabledFlag = false;
1072 else if (anOwners.find(anIter) != anOwners.end())
1073 // disable the higher-level feature is the nested is the current
1074 aDisabledFlag = true;
1077 if (anIter->getKind() == "Parameter") {
1078 // parameters are always out of the history of features, but not parameters
1079 // due to the issue 1491 all parameters are kept enabled any time
1080 //if (!isCurrentParameter)
1081 aDisabledFlag = false;
1082 } else if (isCurrentParameter) {
1083 // if paramater is active, all other features become enabled (issue 1307)
1084 aDisabledFlag = false;
1087 if (anIter->setDisabled(aDisabledFlag)) {
1088 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1089 // state of feature is changed => so inform that it must be updated if it has such state
1090 if (!aDisabledFlag &&
1091 (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1092 anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1093 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1094 // flush is in the end of this method
1095 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1098 // update for everyone the concealment flag immideately: on edit feature in the midle of history
1100 std::list<ResultPtr> aResults;
1101 ModelAPI_Tools::allResults(anIter, aResults);
1102 std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1103 for(; aRes != aResults.end(); aRes++) {
1104 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1105 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1107 // update the concealment status for disply in isConcealed of ResultBody
1108 for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1109 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1110 (*aRes)->isConcealed();
1114 // unblock the flush signals and up them after this
1115 aLoop->activateFlushes(isActive);
1118 void Model_Document::setCurrentFeatureUp()
1120 // on remove just go up for minimum step: highlight external objects in sketch causes
1121 // problems if it is true: here and in "setCurrentFeature"
1122 FeaturePtr aCurrent = currentFeature(false);
1123 if (aCurrent.get()) { // if not, do nothing because null is the upper
1124 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1125 // make the higher level composite as current (sketch becomes disabled if line is enabled)
1127 FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1128 // without cycle (issue 1555): otherwise extrusion fuse
1129 // will be enabled and displayed whaen inside sketch
1133 // do not flush: it is called only on remove, it will be flushed in the end of transaction
1134 setCurrentFeature(aPrev, false);
1138 TDF_Label Model_Document::generalLabel() const
1140 return myDoc->Main().FindChild(TAG_GENERAL);
1143 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1144 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1146 return myObjs->createConstruction(theFeatureData, theIndex);
1149 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1150 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1152 return myObjs->createBody(theFeatureData, theIndex);
1155 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1156 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1158 return myObjs->createPart(theFeatureData, theIndex);
1161 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1162 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1163 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1165 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1168 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1169 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1171 return myObjs->createGroup(theFeatureData, theIndex);
1174 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1175 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1177 return myObjs->createField(theFeatureData, theIndex);
1180 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1181 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1183 return myObjs->createParameter(theFeatureData, theIndex);
1186 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1187 const std::shared_ptr<ModelAPI_Result>& theResult)
1189 return myObjs->feature(theResult);
1192 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1194 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1197 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1199 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1202 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1204 myNamingNames[theName] = theLabel;
1207 void Model_Document::changeNamingName(const std::string theOldName, const std::string theNewName)
1209 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theOldName);
1210 if (aFind != myNamingNames.end()) {
1211 myNamingNames[theNewName] = aFind->second;
1212 myNamingNames.erase(theOldName);
1216 TDF_Label Model_Document::findNamingName(std::string theName)
1218 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1219 if (aFind != myNamingNames.end()) {
1220 return aFind->second;
1222 // not found exact name, try to find by sub-components
1223 std::string::size_type aSlash = theName.rfind('/');
1224 if (aSlash != std::string::npos) {
1225 std::string anObjName = theName.substr(0, aSlash);
1226 aFind = myNamingNames.find(anObjName);
1227 if (aFind != myNamingNames.end()) {
1228 TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1229 // searching sub-labels with this name
1230 TDF_ChildIDIterator aNamesIter(aFind->second, TDataStd_Name::GetID(), Standard_True);
1231 for(; aNamesIter.More(); aNamesIter.Next()) {
1232 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1233 if (aName->Get() == aSubName)
1234 return aName->Label();
1238 return TDF_Label(); // not found
1241 ResultPtr Model_Document::findByName(const std::string theName)
1243 return myObjs->findByName(theName);
1246 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1248 return myObjs->allFeatures();
1251 void Model_Document::setActive(const bool theFlag)
1253 if (theFlag != myIsActive) {
1254 myIsActive = theFlag;
1255 // redisplay all the objects of this part
1256 static Events_Loop* aLoop = Events_Loop::loop();
1257 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1259 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1260 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1261 object(ModelAPI_Feature::group(), a));
1262 if (aFeature.get() && aFeature->data()->isValid()) {
1263 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1264 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1265 for(; aRes != aResList.end(); aRes++) {
1266 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1267 // #issue 1048: sub-compsolids also
1268 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1269 if (aCompRes.get()) {
1270 int aNumSubs = aCompRes->numberOfSubs();
1271 for(int a = 0; a < aNumSubs; a++) {
1272 ResultPtr aSub = aCompRes->subResult(a);
1274 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1284 bool Model_Document::isActive() const
1289 int Model_Document::transactionID()
1291 Handle(TDataStd_Integer) anIndex;
1292 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1293 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1294 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1296 return anIndex->Get();
1299 void Model_Document::incrementTransactionID()
1301 int aNewVal = transactionID() + 1;
1302 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1304 void Model_Document::decrementTransactionID()
1306 int aNewVal = transactionID() - 1;
1307 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1310 bool Model_Document::isOpened()
1312 return myObjs && !myDoc.IsNull();
1315 int Model_Document::numInternalFeatures()
1317 return myObjs->numInternalFeatures();
1320 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1322 return myObjs->internalFeature(theIndex);
1325 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1327 return myObjs->featureById(theId);
1330 void Model_Document::synchronizeTransactions()
1332 Model_Document* aRoot =
1333 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1335 return; // don't need to synchronise root with root
1337 std::shared_ptr<Model_Session> aSession =
1338 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1339 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1340 aSession->setCheckTransactions(false);
1342 aSession->setCheckTransactions(true);
1344 /* this case can not be reproduced in any known case for the current moment, so, just comment
1345 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1346 undoInternal(false, true);
1350 /// Feature that is used for selection in the Part document by the external request
1351 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1353 /// Nothing to do in constructor
1354 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1356 /// Returns the unique kind of a feature
1357 virtual const std::string& getKind() {
1358 static std::string MY_KIND("InternalSelectionInPartFeature");
1361 /// Request for initialization of data model of the object: adding all attributes
1362 virtual void initAttributes() {
1363 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1365 /// Nothing to do in the execution function
1366 virtual void execute() {}
1370 //! Returns the feature that is used for calculation of selection externally from the document
1371 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1373 // return already created, otherwise create
1374 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1376 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1378 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1379 std::shared_ptr<Model_Data> aData(new Model_Data);
1380 aData->setLabel(aFeatureLab.FindChild(1));
1381 aData->setObject(mySelectionFeature);
1382 mySelectionFeature->setDoc(myObjs->owner());
1383 mySelectionFeature->setData(aData);
1384 std::string aName = id() + "_Part";
1385 mySelectionFeature->data()->setName(aName);
1386 mySelectionFeature->setDoc(myObjs->owner());
1387 mySelectionFeature->initAttributes();
1388 mySelectionFeature->init(); // to make it enabled and Update correctly
1389 // this update may cause recomputation of the part after selection on it, that is not needed
1390 mySelectionFeature->data()->blockSendAttributeUpdated(true);
1392 return mySelectionFeature->selectionList("selection");
1395 FeaturePtr Model_Document::lastFeature()
1398 return myObjs->lastFeature();
1399 return FeaturePtr();
1402 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1403 Handle(TNaming_NamedShape) aResult;
1404 while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1405 TopoDS_Shape aShape = theShape;
1407 // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1408 if (!TNaming_Tool::HasLabel(aMain, aShape))
1410 for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1411 TDF_Label aNSLab = anIter.Label();
1412 Handle(TNaming_NamedShape) aNS;
1413 if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1414 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1415 if (aShapesIter.Evolution() == TNaming_SELECTED ||
1416 aShapesIter.Evolution() == TNaming_DELETE)
1417 continue; // don't use the selection evolution
1418 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1420 if (aResult->Evolution() == TNaming_MODIFY)
1421 theShape = aShapesIter.OldShape();
1422 // otherwise may me searching for another item of this shape with longer history
1423 if (!theShape.IsNull())
1433 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1434 std::shared_ptr<ModelAPI_Result> theResult,
1435 const std::shared_ptr<GeomAPI_Shape>& theShape)
1437 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1439 return feature(theResult); // for not-body just returns the feature that produced this result
1441 // otherwise get the shape and search the very initial label for it
1442 TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1443 if (aShape.IsNull())
1444 return FeaturePtr();
1446 // for comsolids and compounds all the naming is located in the main object, so, try to use
1448 ResultCompSolidPtr aMain = ModelAPI_Tools::compSolidOwner(theResult);
1450 FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1455 std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1456 if (!aBodyData.get() || !aBodyData->isValid())
1457 return FeaturePtr();
1459 TopoDS_Shape anOldShape; // old shape in the pair oldshape->theShape in the named shape
1460 TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1461 Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1462 TDF_Label aBodyLab = aBodyData->label();
1463 // use childs and this label (the lowest priority)
1464 TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1465 bool aUseThis = !aNSIter.More();
1466 while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1467 Handle(TNaming_NamedShape) aNS;
1469 if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1472 aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1474 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1475 if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1476 continue; // don't use the selection evolution
1477 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1478 aCandidatInThis = aNS;
1479 if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1480 anOldShape = aShapesIter.OldShape();
1481 // otherwise may me searching for another item of this shape with longer history
1482 if (!anOldShape.IsNull())
1485 // check that the shape contains aShape as sub-shape to fill container
1486 if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1487 TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1488 for(; anExp.More(); anExp.Next()) {
1489 if (aShape.IsSame(anExp.Current())) {
1490 aCandidatContainer = aNS;
1491 aShapeContainer = aShapesIter.NewShape();
1496 // iterate to the next label or to the body label in the end
1499 if (!aNSIter.More()) {
1505 if (aCandidatInThis.IsNull()) {
1506 // to fix 1512: searching for original shape of this shape
1507 // if modification of it is not in this result
1508 aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1509 if (aCandidatInThis.IsNull()) {
1510 if (aCandidatContainer.IsNull())
1511 return FeaturePtr();
1512 // with the lower priority use the higher level shape that contains aShape
1513 aCandidatInThis = aCandidatContainer;
1514 anOldShape = aShapeContainer;
1516 // to stop the searching by the following searchForOriginalShape
1517 anOldShape.Nullify();
1521 Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1523 aCandidatInThis = aNS;
1526 TDF_Label aResultLab = aCandidatInThis->Label();
1527 while(aResultLab.Depth() > 3)
1528 aResultLab = aResultLab.Father();
1529 FeaturePtr aFeature = myObjs->feature(aResultLab);
1530 if (aFeature.get()) {
1531 if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1538 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1540 return myObjs->isLater(theLater, theCurrent);
1543 void Model_Document::storeNodesState(const std::list<bool>& theStates)
1545 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1546 aLab.ForgetAllAttributes();
1547 if (!theStates.empty()) {
1548 Handle(TDataStd_BooleanArray) anArray =
1549 TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
1550 std::list<bool>::const_iterator aState = theStates.begin();
1551 for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
1552 anArray->SetValue(anIndex, *aState);
1557 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
1559 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1560 Handle(TDataStd_BooleanArray) anArray;
1561 if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
1562 int anUpper = anArray->Upper();
1563 for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
1564 theStates.push_back(anArray->Value(anIndex) == Standard_True);