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 <ModelAPI_ResultCompSolid.h>
20 #include <Events_Loop.h>
21 #include <Events_InfoMessage.h>
23 #include <TDataStd_Integer.hxx>
24 #include <TDataStd_Comment.hxx>
25 #include <TDF_ChildIDIterator.hxx>
26 #include <TDataStd_ReferenceArray.hxx>
27 #include <TDataStd_ReferenceList.hxx>
28 #include <TDataStd_IntegerArray.hxx>
29 #include <TDataStd_HLabelArray1.hxx>
30 #include <TDataStd_Name.hxx>
31 #include <TDataStd_AsciiString.hxx>
32 #include <TDF_Reference.hxx>
33 #include <TDF_ChildIDIterator.hxx>
34 #include <TDF_LabelMapHasher.hxx>
35 #include <TDF_Delta.hxx>
36 #include <TDF_AttributeDelta.hxx>
37 #include <TDF_AttributeDeltaList.hxx>
38 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
39 #include <TDF_ListIteratorOfLabelList.hxx>
40 #include <TDF_LabelMap.hxx>
41 #include <TDF_DeltaOnAddition.hxx>
42 #include <TNaming_Builder.hxx>
43 #include <TNaming_SameShapeIterator.hxx>
44 #include <TNaming_Iterator.hxx>
45 #include <TNaming_NamedShape.hxx>
46 #include <TNaming_Tool.hxx>
48 #include <TopExp_Explorer.hxx>
49 #include <TopoDS_Shape.hxx>
51 #include <OSD_File.hxx>
52 #include <OSD_Path.hxx>
53 #include <CDF_Session.hxx>
54 #include <CDF_Directory.hxx>
62 # define _separator_ '\\'
64 # define _separator_ '/'
67 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
69 static const int TAG_GENERAL = 1; // general properties tag
72 /// where the reference to the current feature label is located (or no attribute if null feature)
73 static const int TAG_CURRENT_FEATURE = 1; ///< reference to the current feature
74 static const int TAG_CURRENT_TRANSACTION = 2; ///< integer, index of the transaction
75 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
76 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
77 ///< naming structures constructions selected from other document
78 static const int TAG_EXTERNAL_CONSTRUCTIONS = 5;
80 Model_Document::Model_Document(const int theID, const std::string theKind)
81 : myID(theID), myKind(theKind), myIsActive(false),
82 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
85 CDF_Session::CurrentSession()->Directory()->Add(myDoc);
87 myObjs = new Model_Objects(myDoc->Main());
88 myDoc->SetUndoLimit(UNDO_LIMIT);
89 myTransactionSave = 0;
90 myExecuteFeatures = true;
91 // to have something in the document and avoid empty doc open/save problem
92 // in transaction for nesting correct working
94 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
95 // this to avoid creation of integer attribute outside the transaction after undo
97 myDoc->CommitCommand();
100 void Model_Document::setThis(DocumentPtr theDoc)
102 myObjs->setOwner(theDoc);
105 /// Returns the file name of this document by the name of directory and identifier of a document
106 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
108 TCollection_ExtendedString aPath((const Standard_CString) theDirName);
109 // remove end-separators
110 while(aPath.Length() &&
111 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
112 aPath.Remove(aPath.Length());
113 aPath += _separator_;
114 aPath += theID.c_str();
115 aPath += ".cbf"; // standard binary file extension
119 bool Model_Document::isRoot() const
121 return this == Model_Session::get()->moduleDocument().get();
124 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
126 Handle(Model_Application) anApp = Model_Application::getApplication();
128 anApp->setLoadPath(theDirName);
130 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
131 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
132 Handle(TDocStd_Document) aLoaded;
134 aStatus = anApp->Open(aPath, aLoaded);
135 } catch (Standard_Failure) {
136 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
137 Events_InfoMessage("Model_Document",
138 "Exception in opening of document: %1").arg(aFail->GetMessageString()).send();
141 bool isError = aStatus != PCDM_RS_OK;
144 case PCDM_RS_UnknownDocument:
145 Events_InfoMessage("Model_Document", "Can not open document").send();
147 case PCDM_RS_AlreadyRetrieved:
148 Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
150 case PCDM_RS_AlreadyRetrievedAndModified:
151 Events_InfoMessage("Model_Document",
152 "Can not open document: already opened and modified").send();
154 case PCDM_RS_NoDriver:
155 Events_InfoMessage("Model_Document",
156 "Can not open document: driver library is not found").send();
158 case PCDM_RS_UnknownFileDriver:
159 Events_InfoMessage("Model_Document",
160 "Can not open document: unknown driver for opening").send();
162 case PCDM_RS_OpenError:
163 Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
165 case PCDM_RS_NoVersion:
166 Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
168 case PCDM_RS_NoModel:
169 Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
171 case PCDM_RS_NoDocument:
172 Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
174 case PCDM_RS_FormatFailure:
175 Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
177 case PCDM_RS_TypeNotFoundInSchema:
178 Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
180 case PCDM_RS_UnrecognizedFileFormat:
181 Events_InfoMessage("Model_Document",
182 "Can not open document: unrecognized file format").send();
184 case PCDM_RS_MakeFailure:
185 Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
187 case PCDM_RS_PermissionDenied:
188 Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
190 case PCDM_RS_DriverFailure:
191 Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
194 Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
198 std::shared_ptr<Model_Session> aSession =
199 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
202 myDoc->SetUndoLimit(UNDO_LIMIT);
204 // to avoid the problem that feature is created in the current, not this, document
205 aSession->setActiveDocument(anApp->document(myID), false);
206 aSession->setCheckTransactions(false);
209 myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
210 myObjs->setOwner(theThis);
211 // update the current features status
212 setCurrentFeature(currentFeature(false), false);
213 aSession->setCheckTransactions(true);
214 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
215 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
216 // aSession->setActiveDocument(anApp->getDocument(myID), true);
218 // make sub-parts as loaded by demand
219 std::list<ResultPtr> aPartResults;
220 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
221 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
222 for(; aPartRes != aPartResults.end(); aPartRes++) {
223 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
225 anApp->setLoadByDemand(aPart->data()->name(),
226 aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->docId());
229 } else { // open failed, but new documnet was created to work with it: inform the model
230 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
235 bool Model_Document::save(
236 const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
238 // if the history line is not in the end, move it to the end before save, otherwise
239 // problems with results restore and (the most important) naming problems will appear
240 // due to change evolution to SELECTION (problems in NamedShape and Name)
241 FeaturePtr aWasCurrent;
242 std::shared_ptr<Model_Session> aSession =
243 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
244 if (currentFeature(false) != lastFeature()) {
245 aSession->setCheckTransactions(false);
246 aWasCurrent = currentFeature(false);
247 // if last is nested into something else, make this something else as last:
248 // otherwise it will look like edition of sub-element, so, the main will be disabled
249 FeaturePtr aLast = lastFeature();
251 CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
254 aMain = ModelAPI_Tools::compositeOwner(aLast);
257 setCurrentFeature(aLast, true);
259 // create a directory in the root document if it is not yet exist
260 Handle(Model_Application) anApp = Model_Application::getApplication();
263 CreateDirectory(theDirName, NULL);
265 mkdir(theDirName, 0x1ff);
268 // filename in the dir is id of document inside of the given directory
269 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
270 PCDM_StoreStatus aStatus;
272 aStatus = anApp->SaveAs(myDoc, aPath);
273 } catch (Standard_Failure) {
274 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
275 Events_InfoMessage("Model_Document",
276 "Exception in saving of document: %1").arg(aFail->GetMessageString()).send();
277 if (aWasCurrent.get()) { // return the current feature to the initial position
278 setCurrentFeature(aWasCurrent, false);
279 aSession->setCheckTransactions(true);
283 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
286 case PCDM_SS_DriverFailure:
287 Events_InfoMessage("Model_Document",
288 "Can not save document: save driver-library failure").send();
290 case PCDM_SS_WriteFailure:
291 Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
293 case PCDM_SS_Failure:
295 Events_InfoMessage("Model_Document", "Can not save document").send();
300 if (aWasCurrent.get()) { // return the current feature to the initial position
301 setCurrentFeature(aWasCurrent, false);
302 aSession->setCheckTransactions(true);
305 myTransactionSave = int(myTransactions.size());
306 if (isDone) { // save also sub-documents if any
307 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
308 // iterate all result parts to find all loaded or not yet loaded documents
309 std::list<ResultPtr> aPartResults;
310 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
311 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
312 for(; aPartRes != aPartResults.end(); aPartRes++) {
313 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
314 if (!aPart->isActivated()) {
315 // copy not-activated document that is not in the memory
316 std::string aDocName = aPart->data()->name();
317 if (!aDocName.empty()) {
319 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
320 OSD_Path aPath(aSubPath);
321 OSD_File aFile(aPath);
322 if (aFile.Exists()) {
323 TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
324 OSD_Path aDestination(aDestinationDir);
325 aFile.Copy(aDestination);
326 theResults.push_back(aDestinationDir.ToCString());
328 Events_InfoMessage("Model_Document",
329 "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
332 } else { // simply save opened document
333 isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
334 save(theDirName, aPart->data()->name().c_str(), theResults);
341 void Model_Document::close(const bool theForever)
343 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
344 if (!isRoot() && this == aPM->activeDocument().get()) {
345 aPM->setActiveDocument(aPM->moduleDocument());
346 } else if (isRoot()) {
347 // erase the active document if root is closed
348 aPM->setActiveDocument(DocumentPtr());
351 const std::set<int> aSubs = subDocuments();
352 std::set<int>::iterator aSubIter = aSubs.begin();
353 for (; aSubIter != aSubs.end(); aSubIter++) {
354 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
355 if (aSub->myObjs) // if it was not closed before
356 aSub->close(theForever);
359 // close for thid document needs no transaction in this document
360 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
362 // close all only if it is really asked, otherwise it can be undoed/redoed
364 // flush everything to avoid messages with bad objects
367 if (myDoc->CanClose() == CDM_CCS_OK)
369 mySelectionFeature.reset();
371 setCurrentFeature(FeaturePtr(), false); // disables all features
372 // update the OB: features are disabled (on remove of Part)
373 Events_Loop* aLoop = Events_Loop::loop();
374 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
375 aLoop->flush(aDeleteEvent);
378 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
381 void Model_Document::startOperation()
383 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
384 if (myDoc->HasOpenCommand()) { // start of nested command
385 if (myDoc->CommitCommand()) {
386 // commit the current: it will contain all nested after compactification
387 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
389 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
390 myDoc->OpenCommand();
391 } else { // start the simple command
394 // starts a new operation
395 myTransactions.push_back(Transaction());
396 if (!myNestedNum.empty())
397 (*myNestedNum.rbegin())++;
399 // new command for all subs
400 const std::set<int> aSubs = subDocuments();
401 std::set<int>::iterator aSubIter = aSubs.begin();
402 for (; aSubIter != aSubs.end(); aSubIter++)
403 subDoc(*aSubIter)->startOperation();
406 void Model_Document::compactNested()
408 if (!myNestedNum.empty()) {
409 int aNumToCompact = *(myNestedNum.rbegin());
410 int aSumOfTransaction = 0;
411 for(int a = 0; a < aNumToCompact; a++) {
412 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
413 myTransactions.pop_back();
415 // the latest transaction is the start of lower-level operation which startes the nested
416 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
417 myNestedNum.pop_back();
421 /// Compares the content of the given attributes, returns true if equal.
422 /// This method is used to avoid empty transactions when only "current" is changed
423 /// to some value and then comes back in this transaction, so, it compares only
424 /// references and Boolean and Integer Arrays for the current moment.
425 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
427 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
428 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
429 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
430 if (aRef1.IsNull() && aRef2.IsNull())
432 if (aRef1.IsNull() || aRef2.IsNull())
434 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
435 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
436 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
437 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
438 if (anArr1.IsNull() && anArr2.IsNull())
440 if (anArr1.IsNull() || anArr2.IsNull())
442 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
443 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++) {
444 if (a == 1 && // second is for display
445 anArr2->Label().Tag() == 1 && (anArr2->Label().Depth() == 4 ||
446 anArr2->Label().Depth() == 6))
448 if (anArr1->Value(a) != anArr2->Value(a))
453 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
454 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
455 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
456 if (anArr1.IsNull() && anArr2.IsNull())
458 if (anArr1.IsNull() || anArr2.IsNull())
460 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
461 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
462 if (anArr1->Value(a) != anArr2->Value(a)) {
463 // avoid the transaction ID checking
464 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
465 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
471 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
472 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
473 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
474 if (anArr1.IsNull() && anArr2.IsNull())
476 if (anArr1.IsNull() || anArr2.IsNull())
478 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
479 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
480 if (anArr1->Value(a) != anArr2->Value(a)) {
481 // avoid the transaction ID checking
482 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
483 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
489 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
490 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
491 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
492 if (aList1.IsNull() && aList2.IsNull())
494 if (aList1.IsNull() || aList2.IsNull())
496 const TDF_LabelList& aLList1 = aList1->List();
497 const TDF_LabelList& aLList2 = aList2->List();
498 TDF_ListIteratorOfLabelList aLIter1(aLList1);
499 TDF_ListIteratorOfLabelList aLIter2(aLList2);
500 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
501 if (aLIter1.Value() != aLIter2.Value())
504 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
505 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
506 return true; // it just for created and removed feature: nothing is changed
511 /// Returns true if the last transaction is actually empty: modification to te same values
512 /// were performed only
513 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
514 Handle(TDF_Delta) aDelta;
515 aDelta = theDoc->GetUndos().Last();
516 TDF_LabelList aDeltaList;
517 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
518 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
521 // add also label of the modified attributes
522 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
523 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
524 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
525 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
526 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
527 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
528 Handle(TDF_Attribute) aCurrentAttr;
529 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
530 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
531 continue; // attribute is not changed actually
534 if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
535 continue; // error message is disappeared
544 bool Model_Document::finishOperation()
546 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
547 static std::shared_ptr<Model_Session> aSession =
548 std::static_pointer_cast<Model_Session>(Model_Session::get());
550 // open transaction if nested is closed to fit inside
551 // all synchronizeBackRefs and flushed consequences
552 if (isNestedClosed) {
553 myDoc->OpenCommand();
555 // do it before flashes to enable and recompute nesting features correctly
556 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
557 // if all nested operations are closed, make current the higher level objects (to perform
558 // it in the python scripts correctly): sketch become current after creation ofsub-elements
559 FeaturePtr aCurrent = currentFeature(false);
560 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
563 aNext = ModelAPI_Tools::compositeOwner(aMain);
565 if (aMain.get() && aMain != aCurrent)
566 setCurrentFeature(aMain, false);
568 myObjs->synchronizeBackRefs();
569 Events_Loop* aLoop = Events_Loop::loop();
570 static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
571 static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
572 static const Events_ID kRedispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
573 static const Events_ID kDeletedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_DELETED);
574 aLoop->flush(kCreatedEvent);
575 aLoop->flush(kUpdatedEvent);
576 aLoop->flush(kRedispEvent);
577 aLoop->flush(kDeletedEvent);
579 if (isNestedClosed) {
580 if (myDoc->CommitCommand())
581 myTransactions.rbegin()->myOCAFNum++;
584 // this must be here just after everything is finished but before real transaction stop
585 // to avoid messages about modifications outside of the transaction
586 // and to rebuild everything after all updates and creates
587 if (isRoot()) { // once for root document
588 static std::shared_ptr<Events_Message> aFinishMsg
589 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
590 Events_Loop::loop()->send(aFinishMsg);
593 while(aLoop->hasGrouppedEvent(kCreatedEvent) || aLoop->hasGrouppedEvent(kUpdatedEvent) ||
594 aLoop->hasGrouppedEvent(kRedispEvent) || aLoop->hasGrouppedEvent(kDeletedEvent)) {
595 aLoop->flush(kCreatedEvent);
596 aLoop->flush(kUpdatedEvent);
597 aLoop->flush(kRedispEvent);
598 aLoop->flush(kDeletedEvent);
601 // to avoid "updated" message appearance by updater
602 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
604 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
605 bool aResult = false;
606 const std::set<int> aSubs = subDocuments();
607 std::set<int>::iterator aSubIter = aSubs.begin();
608 for (; aSubIter != aSubs.end(); aSubIter++)
609 if (subDoc(*aSubIter)->finishOperation())
612 // transaction may be empty if this document was created during this transaction (create part)
613 if (!myTransactions.empty() && myDoc->CommitCommand()) {
614 // if commit is successfull, just increment counters
615 if (isEmptyTransaction(myDoc)) { // erase this transaction
619 myTransactions.rbegin()->myOCAFNum++;
624 if (isNestedClosed) {
627 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
628 aResult = myTransactions.rbegin()->myOCAFNum != 0;
630 if (!aResult && isRoot()) {
631 // nothing inside in all documents, so remove this transaction from the transactions list
632 undoInternal(true, false);
634 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
637 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
638 subDoc(*aSubIter)->myDoc->ClearRedos();
639 subDoc(*aSubIter)->myRedos.clear();
645 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
646 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
647 const bool isRedo = false) {
648 Handle(TDF_Delta) aDelta;
650 aDelta = theDoc->GetRedos().First();
652 aDelta = theDoc->GetUndos().Last();
653 TDF_LabelList aDeltaList;
654 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
655 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
656 theDelta.Append(aListIter.Value());
658 // add also label of the modified attributes
659 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
660 /// named shape evolution also modifies integer on this label: exclude it
661 TDF_LabelMap anExcludedInt;
662 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
663 if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
664 // Boolean array is used for feature auxiliary attributes only, feature args are not modified
667 if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
668 anExcludedInt.Add(anAttr.Value()->Label());
669 // named shape evolution is changed in history update => skip them,
670 // they are not the features arguents
673 if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
674 if (anExcludedInt.Contains(anAttr.Value()->Label()))
677 theDelta.Append(anAttr.Value()->Label());
679 TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
680 for(; aDeltaIter.More(); aDeltaIter.Next()) {
681 if (anExcludedInt.Contains(aDeltaIter.Value())) {
682 theDelta.Remove(aDeltaIter);
683 if (!aDeltaIter.More())
689 void Model_Document::abortOperation()
691 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
692 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
694 // store undo-delta here as undo actually does in the method later
695 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
696 for(a = 0; a < aNumTransactions; a++) {
697 modifiedLabels(myDoc, aDeltaLabels);
700 for(a = 0; a < aNumTransactions; a++) {
704 undoInternal(false, false);
707 } else { // abort the current
708 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
709 myTransactions.pop_back();
710 if (!myNestedNum.empty())
711 (*myNestedNum.rbegin())--;
712 // roll back the needed number of transactions
713 //myDoc->AbortCommand();
714 // instead of abort, do commit and undo: to get the delta of modifications
715 if (myDoc->CommitCommand()) {
716 modifiedLabels(myDoc, aDeltaLabels);
719 for(int a = 0; a < aNumTransactions; a++) {
720 modifiedLabels(myDoc, aDeltaLabels);
725 // abort for all subs, flushes will be later, in the end of root abort
726 const std::set<int> aSubs = subDocuments();
727 std::set<int>::iterator aSubIter = aSubs.begin();
728 for (; aSubIter != aSubs.end(); aSubIter++)
729 subDoc(*aSubIter)->abortOperation();
730 // references may be changed because they are set in attributes on the fly
731 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
734 bool Model_Document::isOperation() const
736 // operation is opened for all documents: no need to check subs
737 return myDoc->HasOpenCommand() == Standard_True ;
740 bool Model_Document::isModified()
742 // is modified if at least one operation was commited and not undoed
743 return myTransactions.size() != myTransactionSave || isOperation();
746 bool Model_Document::canUndo()
748 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
749 int aCurrentNum = isOperation() ? 1 : 0;
750 if (myDoc->GetAvailableUndos() > 0 &&
751 // there is something to undo in nested
752 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
753 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
755 // check other subs contains operation that can be undoed
756 const std::set<int> aSubs = subDocuments();
757 std::set<int>::iterator aSubIter = aSubs.begin();
758 for (; aSubIter != aSubs.end(); aSubIter++) {
759 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
760 if (aSub->myObjs) {// if it was not closed before
769 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
771 if (myTransactions.empty())
773 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
774 myRedos.push_back(*myTransactions.rbegin());
775 myTransactions.pop_back();
776 if (!myNestedNum.empty())
777 (*myNestedNum.rbegin())--;
778 // roll back the needed number of transactions
779 TDF_LabelList aDeltaLabels;
780 for(int a = 0; a < aNumTransactions; a++) {
782 modifiedLabels(myDoc, aDeltaLabels);
788 const std::set<int> aSubs = subDocuments();
789 std::set<int>::iterator aSubIter = aSubs.begin();
790 for (; aSubIter != aSubs.end(); aSubIter++) {
791 if (!subDoc(*aSubIter)->myObjs)
793 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
796 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
797 if (theSynchronize) {
798 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
799 // update the current features status
800 setCurrentFeature(currentFeature(false), false);
804 void Model_Document::undo()
806 undoInternal(true, true);
809 bool Model_Document::canRedo()
811 if (!myRedos.empty())
813 // check other subs contains operation that can be redoed
814 const std::set<int> aSubs = subDocuments();
815 std::set<int>::iterator aSubIter = aSubs.begin();
816 for (; aSubIter != aSubs.end(); aSubIter++) {
817 if (!subDoc(*aSubIter)->myObjs)
819 if (subDoc(*aSubIter)->canRedo())
825 void Model_Document::redo()
827 if (!myNestedNum.empty())
828 (*myNestedNum.rbegin())++;
829 int aNumRedos = myRedos.rbegin()->myOCAFNum;
830 myTransactions.push_back(*myRedos.rbegin());
832 TDF_LabelList aDeltaLabels;
833 for(int a = 0; a < aNumRedos; a++) {
834 modifiedLabels(myDoc, aDeltaLabels, true);
839 const std::set<int> aSubs = subDocuments();
840 std::set<int>::iterator aSubIter = aSubs.begin();
841 for (; aSubIter != aSubs.end(); aSubIter++)
842 subDoc(*aSubIter)->redo();
844 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
845 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
846 // update the current features status
847 setCurrentFeature(currentFeature(false), false);
850 std::list<std::string> Model_Document::undoList() const
852 std::list<std::string> aResult;
853 // the number of skipped current operations (on undo they will be aborted)
854 int aSkipCurrent = isOperation() ? 1 : 0;
855 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
856 int aNumUndo = int(myTransactions.size());
857 if (!myNestedNum.empty())
858 aNumUndo = *myNestedNum.rbegin();
859 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
860 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
866 std::list<std::string> Model_Document::redoList() const
868 std::list<std::string> aResult;
869 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
870 for( ; aTrIter != myRedos.crend(); aTrIter++) {
871 aResult.push_back(aTrIter->myId);
876 void Model_Document::operationId(const std::string& theId)
878 myTransactions.rbegin()->myId = theId;
881 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
883 std::shared_ptr<Model_Session> aSession =
884 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
885 FeaturePtr aFeature = aSession->createFeature(theID, this);
889 Model_Document* aDocToAdd;
890 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
891 if (aFeature->documentToAdd() != kind()) { // the root document by default
892 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
896 } else { // if customized is not presented, add to "this" document
900 // searching for feature after which must be added the next feature: this is the current feature
901 // but also all sub-features of this feature
902 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
903 bool isModified = true;
904 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
905 aComp.get() && isModified;
906 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
908 int aSubs = aComp->numberOfSubs(false);
909 for(int a = 0; a < aSubs; a++) {
910 FeaturePtr aSub = aComp->subFeature(a, false);
911 if (myObjs->isLater(aSub, aCurrent)) {
917 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
918 if (!aFeature->isAction()) { // do not add action to the data model
919 if (theMakeCurrent) // after all this feature stays in the document, so make it current
920 aDocToAdd->setCurrentFeature(aFeature, false);
921 } else { // feature must be executed
922 // no creation event => updater not working, problem with remove part
930 void Model_Document::refsToFeature(FeaturePtr theFeature,
931 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
933 myObjs->refsToFeature(theFeature, theRefs, isSendError);
936 void Model_Document::removeFeature(FeaturePtr theFeature)
938 myObjs->removeFeature(theFeature);
941 // recursive function to check if theSub is a child of theMain composite feature
942 // through all the hierarchy of parents
943 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
944 CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
947 if (aParent == theMain)
949 return isSub(theMain, aParent);
953 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
955 bool aCurrentUp = theMoved == currentFeature(false);
957 setCurrentFeatureUp();
959 // if user adds after high-level feature with nested,
960 // add it after all nested (otherwise the nested will be disabled)
961 CompositeFeaturePtr aCompositeAfter =
962 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
963 FeaturePtr anAfterThisSub = theAfterThis;
964 if (aCompositeAfter.get()) {
965 FeaturePtr aSub = aCompositeAfter;
967 FeaturePtr aNext = myObjs->nextFeature(aSub);
968 if (!isSub(aCompositeAfter, aNext)) {
969 anAfterThisSub = aSub;
973 } while (aSub.get());
976 myObjs->moveFeature(theMoved, anAfterThisSub);
977 if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
978 setCurrentFeature(currentFeature(false), false);
979 } else if (theAfterThis == currentFeature(false) || anAfterThisSub == currentFeature(false)) {
980 // must be after move to make enabled all features which are before theMoved
981 setCurrentFeature(theMoved, true);
985 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
987 myObjs->updateHistory(theObject);
990 void Model_Document::updateHistory(const std::string theGroup)
992 myObjs->updateHistory(theGroup);
995 const std::set<int> Model_Document::subDocuments() const
997 std::set<int> aResult;
998 std::list<ResultPtr> aPartResults;
999 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
1000 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
1001 for(; aPartRes != aPartResults.end(); aPartRes++) {
1002 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
1003 if (aPart && aPart->isActivated()) {
1004 aResult.insert(aPart->original()->partDoc()->id());
1010 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
1012 // just store sub-document identifier here to manage it later
1013 return std::dynamic_pointer_cast<Model_Document>(
1014 Model_Application::getApplication()->document(theDocID));
1017 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
1019 return myObjs->object(theGroupID, theIndex);
1022 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
1023 const std::string& theGroupID, const std::string& theName)
1025 return myObjs->objectByName(theGroupID, theName);
1028 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
1030 return myObjs->index(theObject);
1033 int Model_Document::size(const std::string& theGroupID)
1035 if (myObjs == 0) // may be on close
1037 return myObjs->size(theGroupID);
1040 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
1042 if (!myObjs) // on close document feature destruction it may call this method
1043 return std::shared_ptr<ModelAPI_Feature>();
1044 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1045 Handle(TDF_Reference) aRef;
1046 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1047 TDF_Label aLab = aRef->Get();
1048 FeaturePtr aResult = myObjs->feature(aLab);
1049 if (theVisible) { // get nearest visible (in history) going up
1050 while(aResult.get() && !aResult->isInHistory()) {
1051 aResult = myObjs->nextFeature(aResult, true);
1056 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1059 void Model_Document::setCurrentFeature(
1060 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1062 // blocks the flush signals to avoid each objects visualization in the viewer
1063 // they should not be shown once after all modifications are performed
1064 Events_Loop* aLoop = Events_Loop::loop();
1065 bool isActive = aLoop->activateFlushes(false);
1067 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1068 CompositeFeaturePtr aMain; // main feature that may nest the new current
1069 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1070 if (theCurrent.get()) {
1071 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1072 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1073 while(anOwner.get()) {
1077 anOwners.insert(anOwner);
1078 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1082 if (theVisible && !theCurrent.get()) {
1083 // needed to avoid disabling of PartSet initial constructions
1085 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1086 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1087 if (aNext->isInHistory()) {
1088 break; // next in history is not needed
1089 } else { // next not in history is good for making current
1094 if (theCurrent.get()) {
1095 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1096 if (!aData.get() || !aData->isValid()) {
1097 aLoop->activateFlushes(isActive);
1100 TDF_Label aFeatureLabel = aData->label().Father();
1102 Handle(TDF_Reference) aRef;
1103 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1104 aRef->Set(aFeatureLabel);
1106 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1108 } else { // remove reference for the null feature
1109 aRefLab.ForgetAttribute(TDF_Reference::GetID());
1111 // make all features after this feature disabled in reversed order
1112 // (to remove results without deps)
1113 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1115 bool aPassed = false; // flag that the current object is already passed in cycle
1116 FeaturePtr anIter = myObjs->lastFeature();
1117 bool aWasChanged = false;
1118 bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1119 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1120 // check this before passed become enabled: the current feature is enabled!
1121 if (anIter == theCurrent) aPassed = true;
1123 bool aDisabledFlag = !aPassed;
1125 if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1126 aDisabledFlag = false;
1127 else if (anOwners.find(anIter) != anOwners.end())
1128 // disable the higher-level feature if the nested is the current
1129 aDisabledFlag = true;
1132 if (anIter->getKind() == "Parameter") {
1133 // parameters are always out of the history of features, but not parameters
1134 // due to the issue 1491 all parameters are kept enabled any time
1135 //if (!isCurrentParameter)
1136 aDisabledFlag = false;
1137 } else if (isCurrentParameter) {
1138 // if paramater is active, all other features become enabled (issue 1307)
1139 aDisabledFlag = false;
1142 if (anIter->setDisabled(aDisabledFlag)) {
1143 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1144 // state of feature is changed => so inform that it must be updated if it has such state
1145 if (!aDisabledFlag &&
1146 (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1147 anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1148 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1149 // flush is in the end of this method
1150 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1153 // update for everyone the concealment flag immideately: on edit feature in the midle of history
1155 std::list<ResultPtr> aResults;
1156 ModelAPI_Tools::allResults(anIter, aResults);
1157 std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1158 for(; aRes != aResults.end(); aRes++) {
1159 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1160 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1162 // update the concealment status for disply in isConcealed of ResultBody
1163 for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1164 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1165 (*aRes)->isConcealed();
1169 // unblock the flush signals and up them after this
1170 aLoop->activateFlushes(isActive);
1173 void Model_Document::setCurrentFeatureUp()
1175 // on remove just go up for minimum step: highlight external objects in sketch causes
1176 // problems if it is true: here and in "setCurrentFeature"
1177 FeaturePtr aCurrent = currentFeature(false);
1178 if (aCurrent.get()) { // if not, do nothing because null is the upper
1179 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1180 // make the higher level composite as current (sketch becomes disabled if line is enabled)
1182 FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1183 // without cycle (issue 1555): otherwise extrusion fuse
1184 // will be enabled and displayed whaen inside sketch
1188 // do not flush: it is called only on remove, it will be flushed in the end of transaction
1189 setCurrentFeature(aPrev, false);
1193 TDF_Label Model_Document::generalLabel() const
1195 return myDoc->Main().FindChild(TAG_GENERAL);
1198 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1199 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1201 return myObjs->createConstruction(theFeatureData, theIndex);
1204 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1205 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1207 return myObjs->createBody(theFeatureData, theIndex);
1210 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1211 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1213 return myObjs->createPart(theFeatureData, theIndex);
1216 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1217 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1218 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1220 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1223 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1224 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1226 return myObjs->createGroup(theFeatureData, theIndex);
1229 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1230 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1232 return myObjs->createField(theFeatureData, theIndex);
1235 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1236 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1238 return myObjs->createParameter(theFeatureData, theIndex);
1241 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1242 const std::shared_ptr<ModelAPI_Result>& theResult)
1244 return myObjs->feature(theResult);
1247 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1249 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1252 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1254 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1257 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1259 myNamingNames[theName] = theLabel;
1262 void Model_Document::changeNamingName(const std::string theOldName, const std::string theNewName)
1264 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theOldName);
1265 if (aFind != myNamingNames.end()) {
1266 myNamingNames[theNewName] = aFind->second;
1267 myNamingNames.erase(theOldName);
1271 TDF_Label Model_Document::findNamingName(std::string theName)
1273 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1274 if (aFind != myNamingNames.end()) {
1275 return aFind->second;
1277 // not found exact name, try to find by sub-components
1278 std::string::size_type aSlash = theName.rfind('/');
1279 if (aSlash != std::string::npos) {
1280 std::string anObjName = theName.substr(0, aSlash);
1281 aFind = myNamingNames.find(anObjName);
1282 if (aFind != myNamingNames.end()) {
1283 TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1284 // searching sub-labels with this name
1285 TDF_ChildIDIterator aNamesIter(aFind->second, TDataStd_Name::GetID(), Standard_True);
1286 for(; aNamesIter.More(); aNamesIter.Next()) {
1287 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1288 if (aName->Get() == aSubName)
1289 return aName->Label();
1291 // If not found child label with the exact sub-name, then try to find compound with
1292 // such sub-name without suffix.
1293 Standard_Integer aSuffixPos = aSubName.SearchFromEnd('_');
1294 if (aSuffixPos != -1) {
1295 TCollection_ExtendedString anIndexStr = aSubName.Split(aSuffixPos);
1296 aSubName.Remove(aSuffixPos);
1297 aNamesIter.Initialize(aFind->second, TDataStd_Name::GetID(), Standard_True);
1298 for(; aNamesIter.More(); aNamesIter.Next()) {
1299 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1300 if (aName->Get() == aSubName) {
1301 return aName->Label();
1307 return TDF_Label(); // not found
1310 ResultPtr Model_Document::findByName(const std::string theName)
1312 return myObjs->findByName(theName);
1315 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1317 return myObjs->allFeatures();
1320 void Model_Document::setActive(const bool theFlag)
1322 if (theFlag != myIsActive) {
1323 myIsActive = theFlag;
1324 // redisplay all the objects of this part
1325 static Events_Loop* aLoop = Events_Loop::loop();
1326 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1328 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1329 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1330 object(ModelAPI_Feature::group(), a));
1331 if (aFeature.get() && aFeature->data()->isValid()) {
1332 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1333 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1334 for(; aRes != aResList.end(); aRes++) {
1335 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1336 // #issue 1048: sub-compsolids also
1337 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1338 if (aCompRes.get()) {
1339 int aNumSubs = aCompRes->numberOfSubs();
1340 for(int a = 0; a < aNumSubs; a++) {
1341 ResultPtr aSub = aCompRes->subResult(a);
1343 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1353 bool Model_Document::isActive() const
1358 int Model_Document::transactionID()
1360 Handle(TDataStd_Integer) anIndex;
1361 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1362 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1363 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1365 return anIndex->Get();
1368 void Model_Document::incrementTransactionID()
1370 int aNewVal = transactionID() + 1;
1371 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1373 void Model_Document::decrementTransactionID()
1375 int aNewVal = transactionID() - 1;
1376 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1379 TDF_Label Model_Document::extConstructionsLabel() const
1381 return myDoc->Main().FindChild(TAG_EXTERNAL_CONSTRUCTIONS);
1384 bool Model_Document::isOpened()
1386 return myObjs && !myDoc.IsNull();
1389 int Model_Document::numInternalFeatures()
1391 return myObjs->numInternalFeatures();
1394 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1396 return myObjs->internalFeature(theIndex);
1399 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1401 return myObjs->featureById(theId);
1404 void Model_Document::synchronizeTransactions()
1406 Model_Document* aRoot =
1407 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1409 return; // don't need to synchronise root with root
1411 std::shared_ptr<Model_Session> aSession =
1412 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1413 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1414 aSession->setCheckTransactions(false);
1416 aSession->setCheckTransactions(true);
1418 /* this case can not be reproduced in any known case for the current moment, so, just comment
1419 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1420 undoInternal(false, true);
1424 /// Feature that is used for selection in the Part document by the external request
1425 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1427 /// Nothing to do in constructor
1428 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1430 /// Returns the unique kind of a feature
1431 virtual const std::string& getKind() {
1432 static std::string MY_KIND("InternalSelectionInPartFeature");
1435 /// Request for initialization of data model of the object: adding all attributes
1436 virtual void initAttributes() {
1437 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1439 /// Nothing to do in the execution function
1440 virtual void execute() {}
1444 //! Returns the feature that is used for calculation of selection externally from the document
1445 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1447 // return already created, otherwise create
1448 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1450 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1452 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1453 std::shared_ptr<Model_Data> aData(new Model_Data);
1454 aData->setLabel(aFeatureLab.FindChild(1));
1455 aData->setObject(mySelectionFeature);
1456 mySelectionFeature->setDoc(myObjs->owner());
1457 mySelectionFeature->setData(aData);
1458 std::string aName = id() + "_Part";
1459 mySelectionFeature->data()->setName(aName);
1460 mySelectionFeature->setDoc(myObjs->owner());
1461 mySelectionFeature->initAttributes();
1462 mySelectionFeature->init(); // to make it enabled and Update correctly
1463 // this update may cause recomputation of the part after selection on it, that is not needed
1464 mySelectionFeature->data()->blockSendAttributeUpdated(true);
1466 return mySelectionFeature->selectionList("selection");
1469 FeaturePtr Model_Document::lastFeature()
1472 return myObjs->lastFeature();
1473 return FeaturePtr();
1476 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1477 Handle(TNaming_NamedShape) aResult;
1478 while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1479 TopoDS_Shape aShape = theShape;
1481 // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1482 if (!TNaming_Tool::HasLabel(aMain, aShape))
1484 for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1485 TDF_Label aNSLab = anIter.Label();
1486 Handle(TNaming_NamedShape) aNS;
1487 if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1488 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1489 if (aShapesIter.Evolution() == TNaming_SELECTED ||
1490 aShapesIter.Evolution() == TNaming_DELETE)
1491 continue; // don't use the selection evolution
1492 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1494 if (aResult->Evolution() == TNaming_MODIFY)
1495 theShape = aShapesIter.OldShape();
1496 // otherwise may me searching for another item of this shape with longer history
1497 if (!theShape.IsNull())
1507 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1508 std::shared_ptr<ModelAPI_Result> theResult,
1509 const std::shared_ptr<GeomAPI_Shape>& theShape)
1511 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1513 return feature(theResult); // for not-body just returns the feature that produced this result
1515 // otherwise get the shape and search the very initial label for it
1516 TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1517 if (aShape.IsNull())
1518 return FeaturePtr();
1520 // for comsolids and compounds all the naming is located in the main object, so, try to use
1522 ResultCompSolidPtr aMain = ModelAPI_Tools::compSolidOwner(theResult);
1524 FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1529 std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1530 if (!aBodyData.get() || !aBodyData->isValid())
1531 return FeaturePtr();
1533 TopoDS_Shape anOldShape; // old shape in the pair oldshape->theShape in the named shape
1534 TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1535 Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1536 TDF_Label aBodyLab = aBodyData->label();
1537 // use childs and this label (the lowest priority)
1538 TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1539 bool aUseThis = !aNSIter.More();
1540 while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1541 Handle(TNaming_NamedShape) aNS;
1543 if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1546 aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1548 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1549 if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1550 continue; // don't use the selection evolution
1551 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1552 aCandidatInThis = aNS;
1553 if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1554 anOldShape = aShapesIter.OldShape();
1555 // otherwise may me searching for another item of this shape with longer history
1556 if (!anOldShape.IsNull())
1559 // check that the shape contains aShape as sub-shape to fill container
1560 if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1561 TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1562 for(; anExp.More(); anExp.Next()) {
1563 if (aShape.IsSame(anExp.Current())) {
1564 aCandidatContainer = aNS;
1565 aShapeContainer = aShapesIter.NewShape();
1570 // iterate to the next label or to the body label in the end
1573 if (!aNSIter.More()) {
1579 if (aCandidatInThis.IsNull()) {
1580 // to fix 1512: searching for original shape of this shape
1581 // if modification of it is not in this result
1582 aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1583 if (aCandidatInThis.IsNull()) {
1584 if (aCandidatContainer.IsNull())
1585 return FeaturePtr();
1586 // with the lower priority use the higher level shape that contains aShape
1587 aCandidatInThis = aCandidatContainer;
1588 anOldShape = aShapeContainer;
1590 // to stop the searching by the following searchForOriginalShape
1591 anOldShape.Nullify();
1595 Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1597 aCandidatInThis = aNS;
1600 TDF_Label aResultLab = aCandidatInThis->Label();
1601 while(aResultLab.Depth() > 3)
1602 aResultLab = aResultLab.Father();
1603 FeaturePtr aFeature = myObjs->feature(aResultLab);
1604 if (aFeature.get()) {
1605 if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1612 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1614 return myObjs->isLater(theLater, theCurrent);
1617 void Model_Document::storeNodesState(const std::list<bool>& theStates)
1619 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1620 aLab.ForgetAllAttributes();
1621 if (!theStates.empty()) {
1622 Handle(TDataStd_BooleanArray) anArray =
1623 TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
1624 std::list<bool>::const_iterator aState = theStates.begin();
1625 for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
1626 anArray->SetValue(anIndex, *aState);
1631 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
1633 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1634 Handle(TDataStd_BooleanArray) anArray;
1635 if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
1636 int anUpper = anArray->Upper();
1637 for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
1638 theStates.push_back(anArray->Value(anIndex) == Standard_True);
1643 void Model_Document::eraseAllFeatures()
1646 myObjs->eraseAllFeatures();