1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #include <Model_Document.h>
22 #include <Model_Data.h>
23 #include <Model_Objects.h>
24 #include <Model_Application.h>
25 #include <Model_Session.h>
26 #include <Model_Events.h>
27 #include <ModelAPI_ResultPart.h>
28 #include <ModelAPI_Validator.h>
29 #include <ModelAPI_CompositeFeature.h>
30 #include <ModelAPI_AttributeSelectionList.h>
31 #include <ModelAPI_Tools.h>
32 #include <ModelAPI_ResultBody.h>
33 #include <ModelAPI_ResultCompSolid.h>
34 #include <Events_Loop.h>
35 #include <Events_InfoMessage.h>
37 #include <TDataStd_Integer.hxx>
38 #include <TDataStd_Comment.hxx>
39 #include <TDF_ChildIDIterator.hxx>
40 #include <TDataStd_ReferenceArray.hxx>
41 #include <TDataStd_ReferenceList.hxx>
42 #include <TDataStd_IntegerArray.hxx>
43 #include <TDataStd_HLabelArray1.hxx>
44 #include <TDataStd_Name.hxx>
45 #include <TDataStd_AsciiString.hxx>
46 #include <TDF_Reference.hxx>
47 #include <TDF_ChildIDIterator.hxx>
48 #include <TDF_LabelMapHasher.hxx>
49 #include <TDF_Delta.hxx>
50 #include <TDF_AttributeDelta.hxx>
51 #include <TDF_AttributeDeltaList.hxx>
52 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
53 #include <TDF_ListIteratorOfLabelList.hxx>
54 #include <TDF_LabelMap.hxx>
55 #include <TDF_DeltaOnAddition.hxx>
56 #include <TNaming_Builder.hxx>
57 #include <TNaming_SameShapeIterator.hxx>
58 #include <TNaming_Iterator.hxx>
59 #include <TNaming_NamedShape.hxx>
60 #include <TNaming_Tool.hxx>
62 #include <TopExp_Explorer.hxx>
63 #include <TopoDS_Shape.hxx>
65 #include <OSD_File.hxx>
66 #include <OSD_Path.hxx>
67 #include <CDF_Session.hxx>
68 #include <CDF_Directory.hxx>
76 # define _separator_ '\\'
78 # define _separator_ '/'
81 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
83 static const int TAG_GENERAL = 1; // general properties tag
86 /// where the reference to the current feature label is located (or no attribute if null feature)
87 static const int TAG_CURRENT_FEATURE = 1; ///< reference to the current feature
88 static const int TAG_CURRENT_TRANSACTION = 2; ///< integer, index of the transaction
89 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
90 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
91 ///< naming structures constructions selected from other document
92 static const int TAG_EXTERNAL_CONSTRUCTIONS = 5;
94 Model_Document::Model_Document(const int theID, const std::string theKind)
95 : myID(theID), myKind(theKind), myIsActive(false),
96 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
99 CDF_Session::CurrentSession()->Directory()->Add(myDoc);
101 myObjs = new Model_Objects(myDoc->Main());
102 myDoc->SetUndoLimit(UNDO_LIMIT);
103 myTransactionSave = 0;
104 myExecuteFeatures = true;
105 // to have something in the document and avoid empty doc open/save problem
106 // in transaction for nesting correct working
108 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
109 // this to avoid creation of integer attribute outside the transaction after undo
111 myDoc->CommitCommand();
114 void Model_Document::setThis(DocumentPtr theDoc)
116 myObjs->setOwner(theDoc);
119 /// Returns the file name of this document by the name of directory and identifier of a document
120 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
122 TCollection_ExtendedString aPath((const Standard_CString) theDirName);
123 // remove end-separators
124 while(aPath.Length() &&
125 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
126 aPath.Remove(aPath.Length());
127 aPath += _separator_;
128 aPath += theID.c_str();
129 aPath += ".cbf"; // standard binary file extension
133 bool Model_Document::isRoot() const
135 return this == Model_Session::get()->moduleDocument().get();
138 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
140 Handle(Model_Application) anApp = Model_Application::getApplication();
142 anApp->setLoadPath(theDirName);
144 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
145 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
146 Handle(TDocStd_Document) aLoaded;
148 aStatus = anApp->Open(aPath, aLoaded);
149 } catch (Standard_Failure) {
150 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
151 Events_InfoMessage("Model_Document",
152 "Exception in opening of document: %1").arg(aFail->GetMessageString()).send();
155 bool isError = aStatus != PCDM_RS_OK;
158 case PCDM_RS_UnknownDocument:
159 Events_InfoMessage("Model_Document", "Can not open document").send();
161 case PCDM_RS_AlreadyRetrieved:
162 Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
164 case PCDM_RS_AlreadyRetrievedAndModified:
165 Events_InfoMessage("Model_Document",
166 "Can not open document: already opened and modified").send();
168 case PCDM_RS_NoDriver:
169 Events_InfoMessage("Model_Document",
170 "Can not open document: driver library is not found").send();
172 case PCDM_RS_UnknownFileDriver:
173 Events_InfoMessage("Model_Document",
174 "Can not open document: unknown driver for opening").send();
176 case PCDM_RS_OpenError:
177 Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
179 case PCDM_RS_NoVersion:
180 Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
182 case PCDM_RS_NoModel:
183 Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
185 case PCDM_RS_NoDocument:
186 Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
188 case PCDM_RS_FormatFailure:
189 Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
191 case PCDM_RS_TypeNotFoundInSchema:
192 Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
194 case PCDM_RS_UnrecognizedFileFormat:
195 Events_InfoMessage("Model_Document",
196 "Can not open document: unrecognized file format").send();
198 case PCDM_RS_MakeFailure:
199 Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
201 case PCDM_RS_PermissionDenied:
202 Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
204 case PCDM_RS_DriverFailure:
205 Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
208 Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
212 std::shared_ptr<Model_Session> aSession =
213 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
216 myDoc->SetUndoLimit(UNDO_LIMIT);
218 // to avoid the problem that feature is created in the current, not this, document
219 aSession->setActiveDocument(anApp->document(myID), false);
220 aSession->setCheckTransactions(false);
223 myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
224 myObjs->setOwner(theThis);
225 // update the current features status
226 setCurrentFeature(currentFeature(false), false);
227 aSession->setCheckTransactions(true);
228 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
229 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
230 // aSession->setActiveDocument(anApp->getDocument(myID), true);
232 // make sub-parts as loaded by demand
233 std::list<ResultPtr> aPartResults;
234 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
235 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
236 for(; aPartRes != aPartResults.end(); aPartRes++) {
237 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
239 anApp->setLoadByDemand(aPart->data()->name(),
240 aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->docId());
243 } else { // open failed, but new documnet was created to work with it: inform the model
244 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
249 bool Model_Document::save(
250 const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
252 // if the history line is not in the end, move it to the end before save, otherwise
253 // problems with results restore and (the most important) naming problems will appear
254 // due to change evolution to SELECTION (problems in NamedShape and Name)
255 FeaturePtr aWasCurrent;
256 std::shared_ptr<Model_Session> aSession =
257 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
258 if (currentFeature(false) != lastFeature()) {
259 aSession->setCheckTransactions(false);
260 aWasCurrent = currentFeature(false);
261 // if last is nested into something else, make this something else as last:
262 // otherwise it will look like edition of sub-element, so, the main will be disabled
263 FeaturePtr aLast = lastFeature();
265 CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
268 aMain = ModelAPI_Tools::compositeOwner(aLast);
271 setCurrentFeature(aLast, true);
273 // create a directory in the root document if it is not yet exist
274 Handle(Model_Application) anApp = Model_Application::getApplication();
277 CreateDirectory(theDirName, NULL);
279 mkdir(theDirName, 0x1ff);
282 // filename in the dir is id of document inside of the given directory
283 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
284 PCDM_StoreStatus aStatus;
286 aStatus = anApp->SaveAs(myDoc, aPath);
287 } catch (Standard_Failure) {
288 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
289 Events_InfoMessage("Model_Document",
290 "Exception in saving of document: %1").arg(aFail->GetMessageString()).send();
291 if (aWasCurrent.get()) { // return the current feature to the initial position
292 setCurrentFeature(aWasCurrent, false);
293 aSession->setCheckTransactions(true);
297 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
300 case PCDM_SS_DriverFailure:
301 Events_InfoMessage("Model_Document",
302 "Can not save document: save driver-library failure").send();
304 case PCDM_SS_WriteFailure:
305 Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
307 case PCDM_SS_Failure:
309 Events_InfoMessage("Model_Document", "Can not save document").send();
314 if (aWasCurrent.get()) { // return the current feature to the initial position
315 setCurrentFeature(aWasCurrent, false);
316 aSession->setCheckTransactions(true);
319 myTransactionSave = int(myTransactions.size());
320 if (isDone) { // save also sub-documents if any
321 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
322 // iterate all result parts to find all loaded or not yet loaded documents
323 std::list<ResultPtr> aPartResults;
324 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
325 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
326 for(; aPartRes != aPartResults.end(); aPartRes++) {
327 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
328 if (!aPart->isActivated()) {
329 // copy not-activated document that is not in the memory
330 std::string aDocName = aPart->data()->name();
331 if (!aDocName.empty()) {
333 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
334 OSD_Path aPath(aSubPath);
335 OSD_File aFile(aPath);
336 if (aFile.Exists()) {
337 TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
338 OSD_Path aDestination(aDestinationDir);
339 aFile.Copy(aDestination);
340 theResults.push_back(aDestinationDir.ToCString());
342 Events_InfoMessage("Model_Document",
343 "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
346 } else { // simply save opened document
347 isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
348 save(theDirName, aPart->data()->name().c_str(), theResults);
355 void Model_Document::close(const bool theForever)
357 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
358 if (!isRoot() && this == aPM->activeDocument().get()) {
359 aPM->setActiveDocument(aPM->moduleDocument());
360 } else if (isRoot()) {
361 // erase the active document if root is closed
362 aPM->setActiveDocument(DocumentPtr());
365 const std::set<int> aSubs = subDocuments();
366 std::set<int>::iterator aSubIter = aSubs.begin();
367 for (; aSubIter != aSubs.end(); aSubIter++) {
368 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
369 if (aSub->myObjs) // if it was not closed before
370 aSub->close(theForever);
373 // close for thid document needs no transaction in this document
374 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
376 // close all only if it is really asked, otherwise it can be undoed/redoed
378 // flush everything to avoid messages with bad objects
381 if (myDoc->CanClose() == CDM_CCS_OK)
383 mySelectionFeature.reset();
385 setCurrentFeature(FeaturePtr(), false); // disables all features
386 // update the OB: features are disabled (on remove of Part)
387 Events_Loop* aLoop = Events_Loop::loop();
388 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
389 aLoop->flush(aDeleteEvent);
392 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
395 void Model_Document::startOperation()
397 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
398 if (myDoc->HasOpenCommand()) { // start of nested command
399 if (myDoc->CommitCommand()) {
400 // commit the current: it will contain all nested after compactification
401 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
403 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
404 myDoc->OpenCommand();
405 } else { // start the simple command
408 // starts a new operation
409 myTransactions.push_back(Transaction());
410 if (!myNestedNum.empty())
411 (*myNestedNum.rbegin())++;
413 // new command for all subs
414 const std::set<int> aSubs = subDocuments();
415 std::set<int>::iterator aSubIter = aSubs.begin();
416 for (; aSubIter != aSubs.end(); aSubIter++)
417 subDoc(*aSubIter)->startOperation();
420 void Model_Document::compactNested()
422 if (!myNestedNum.empty()) {
423 int aNumToCompact = *(myNestedNum.rbegin());
424 int aSumOfTransaction = 0;
425 for(int a = 0; a < aNumToCompact; a++) {
426 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
427 myTransactions.pop_back();
429 // the latest transaction is the start of lower-level operation which startes the nested
430 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
431 myNestedNum.pop_back();
435 /// Compares the content of the given attributes, returns true if equal.
436 /// This method is used to avoid empty transactions when only "current" is changed
437 /// to some value and then comes back in this transaction, so, it compares only
438 /// references and Boolean and Integer Arrays for the current moment.
439 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
441 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
442 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
443 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
444 if (aRef1.IsNull() && aRef2.IsNull())
446 if (aRef1.IsNull() || aRef2.IsNull())
448 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
449 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
450 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
451 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
452 if (anArr1.IsNull() && anArr2.IsNull())
454 if (anArr1.IsNull() || anArr2.IsNull())
456 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
457 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++) {
458 if (a == 1 && // second is for display
459 anArr2->Label().Tag() == 1 && (anArr2->Label().Depth() == 4 ||
460 anArr2->Label().Depth() == 6))
462 if (anArr1->Value(a) != anArr2->Value(a))
467 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
468 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
469 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
470 if (anArr1.IsNull() && anArr2.IsNull())
472 if (anArr1.IsNull() || anArr2.IsNull())
474 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
475 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
476 if (anArr1->Value(a) != anArr2->Value(a)) {
477 // avoid the transaction ID checking
478 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
479 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
485 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
486 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
487 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
488 if (anArr1.IsNull() && anArr2.IsNull())
490 if (anArr1.IsNull() || anArr2.IsNull())
492 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
493 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
494 if (anArr1->Value(a) != anArr2->Value(a)) {
495 // avoid the transaction ID checking
496 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
497 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
503 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
504 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
505 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
506 if (aList1.IsNull() && aList2.IsNull())
508 if (aList1.IsNull() || aList2.IsNull())
510 const TDF_LabelList& aLList1 = aList1->List();
511 const TDF_LabelList& aLList2 = aList2->List();
512 TDF_ListIteratorOfLabelList aLIter1(aLList1);
513 TDF_ListIteratorOfLabelList aLIter2(aLList2);
514 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
515 if (aLIter1.Value() != aLIter2.Value())
518 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
519 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
520 return true; // it just for created and removed feature: nothing is changed
525 /// Returns true if the last transaction is actually empty: modification to te same values
526 /// were performed only
527 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
528 Handle(TDF_Delta) aDelta;
529 aDelta = theDoc->GetUndos().Last();
530 TDF_LabelList aDeltaList;
531 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
532 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
535 // add also label of the modified attributes
536 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
537 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
538 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
539 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
540 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
541 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
542 Handle(TDF_Attribute) aCurrentAttr;
543 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
544 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
545 continue; // attribute is not changed actually
548 if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
549 continue; // error message is disappeared
558 bool Model_Document::finishOperation()
560 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
561 static std::shared_ptr<Model_Session> aSession =
562 std::static_pointer_cast<Model_Session>(Model_Session::get());
564 // open transaction if nested is closed to fit inside
565 // all synchronizeBackRefs and flushed consequences
566 if (isNestedClosed) {
567 myDoc->OpenCommand();
569 // do it before flashes to enable and recompute nesting features correctly
570 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
571 // if all nested operations are closed, make current the higher level objects (to perform
572 // it in the python scripts correctly): sketch become current after creation ofsub-elements
573 FeaturePtr aCurrent = currentFeature(false);
574 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
577 aNext = ModelAPI_Tools::compositeOwner(aMain);
579 if (aMain.get() && aMain != aCurrent)
580 setCurrentFeature(aMain, false);
582 myObjs->synchronizeBackRefs();
583 Events_Loop* aLoop = Events_Loop::loop();
584 static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
585 static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
586 static const Events_ID kRedispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
587 static const Events_ID kDeletedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_DELETED);
588 aLoop->flush(kCreatedEvent);
589 aLoop->flush(kUpdatedEvent);
590 aLoop->flush(kRedispEvent);
591 aLoop->flush(kDeletedEvent);
593 if (isNestedClosed) {
594 if (myDoc->CommitCommand())
595 myTransactions.rbegin()->myOCAFNum++;
598 // this must be here just after everything is finished but before real transaction stop
599 // to avoid messages about modifications outside of the transaction
600 // and to rebuild everything after all updates and creates
601 if (isRoot()) { // once for root document
602 static std::shared_ptr<Events_Message> aFinishMsg
603 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
604 Events_Loop::loop()->send(aFinishMsg);
607 // for open of document with primitive box inside (finish transaction in initAttributes)
608 bool aWasActivatedFlushes = aLoop->activateFlushes(true);
609 while(aLoop->hasGrouppedEvent(kCreatedEvent) || aLoop->hasGrouppedEvent(kUpdatedEvent) ||
610 aLoop->hasGrouppedEvent(kRedispEvent) || aLoop->hasGrouppedEvent(kDeletedEvent)) {
611 aLoop->flush(kCreatedEvent);
612 aLoop->flush(kUpdatedEvent);
613 aLoop->flush(kRedispEvent);
614 aLoop->flush(kDeletedEvent);
616 aLoop->activateFlushes(aWasActivatedFlushes);
618 // to avoid "updated" message appearance by updater
619 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
621 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
622 bool aResult = false;
623 const std::set<int> aSubs = subDocuments();
624 std::set<int>::iterator aSubIter = aSubs.begin();
625 for (; aSubIter != aSubs.end(); aSubIter++)
626 if (subDoc(*aSubIter)->finishOperation())
629 // transaction may be empty if this document was created during this transaction (create part)
630 if (!myTransactions.empty() && myDoc->CommitCommand()) {
631 // if commit is successfull, just increment counters
632 if (isEmptyTransaction(myDoc)) { // erase this transaction
636 myTransactions.rbegin()->myOCAFNum++;
641 if (isNestedClosed) {
644 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
645 aResult = myTransactions.rbegin()->myOCAFNum != 0;
647 if (!aResult && isRoot()) {
648 // nothing inside in all documents, so remove this transaction from the transactions list
649 undoInternal(true, false);
651 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
654 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
655 subDoc(*aSubIter)->myDoc->ClearRedos();
656 subDoc(*aSubIter)->myRedos.clear();
662 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
663 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
664 const bool isRedo = false) {
665 Handle(TDF_Delta) aDelta;
667 aDelta = theDoc->GetRedos().First();
669 aDelta = theDoc->GetUndos().Last();
670 TDF_LabelList aDeltaList;
671 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
672 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
673 theDelta.Append(aListIter.Value());
675 // add also label of the modified attributes
676 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
677 /// named shape evolution also modifies integer on this label: exclude it
678 TDF_LabelMap anExcludedInt;
679 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
680 if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
681 // Boolean array is used for feature auxiliary attributes only, feature args are not modified
684 if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
685 anExcludedInt.Add(anAttr.Value()->Label());
686 // named shape evolution is changed in history update => skip them,
687 // they are not the features arguents
690 if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
691 if (anExcludedInt.Contains(anAttr.Value()->Label()))
694 theDelta.Append(anAttr.Value()->Label());
696 TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
697 for(; aDeltaIter.More(); aDeltaIter.Next()) {
698 if (anExcludedInt.Contains(aDeltaIter.Value())) {
699 theDelta.Remove(aDeltaIter);
700 if (!aDeltaIter.More())
706 void Model_Document::abortOperation()
708 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
709 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
711 // store undo-delta here as undo actually does in the method later
712 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
713 for(a = 0; a < aNumTransactions; a++) {
714 modifiedLabels(myDoc, aDeltaLabels);
717 for(a = 0; a < aNumTransactions; a++) {
721 undoInternal(false, false);
724 } else { // abort the current
725 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
726 myTransactions.pop_back();
727 if (!myNestedNum.empty())
728 (*myNestedNum.rbegin())--;
729 // roll back the needed number of transactions
730 //myDoc->AbortCommand();
731 // instead of abort, do commit and undo: to get the delta of modifications
732 if (myDoc->CommitCommand()) {
733 modifiedLabels(myDoc, aDeltaLabels);
736 for(int a = 0; a < aNumTransactions; a++) {
737 modifiedLabels(myDoc, aDeltaLabels);
742 // abort for all subs, flushes will be later, in the end of root abort
743 const std::set<int> aSubs = subDocuments();
744 std::set<int>::iterator aSubIter = aSubs.begin();
745 for (; aSubIter != aSubs.end(); aSubIter++)
746 subDoc(*aSubIter)->abortOperation();
747 // references may be changed because they are set in attributes on the fly
748 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
751 bool Model_Document::isOperation() const
753 // operation is opened for all documents: no need to check subs
754 return myDoc->HasOpenCommand() == Standard_True ;
757 bool Model_Document::isModified()
759 // is modified if at least one operation was commited and not undoed
760 return myTransactions.size() != myTransactionSave || isOperation();
763 bool Model_Document::canUndo()
765 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
766 int aCurrentNum = isOperation() ? 1 : 0;
767 if (myDoc->GetAvailableUndos() > 0 &&
768 // there is something to undo in nested
769 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
770 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
772 // check other subs contains operation that can be undoed
773 const std::set<int> aSubs = subDocuments();
774 std::set<int>::iterator aSubIter = aSubs.begin();
775 for (; aSubIter != aSubs.end(); aSubIter++) {
776 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
777 if (aSub->myObjs) {// if it was not closed before
786 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
788 if (myTransactions.empty())
790 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
791 myRedos.push_back(*myTransactions.rbegin());
792 myTransactions.pop_back();
793 if (!myNestedNum.empty())
794 (*myNestedNum.rbegin())--;
795 // roll back the needed number of transactions
796 TDF_LabelList aDeltaLabels;
797 for(int a = 0; a < aNumTransactions; a++) {
799 modifiedLabels(myDoc, aDeltaLabels);
805 const std::set<int> aSubs = subDocuments();
806 std::set<int>::iterator aSubIter = aSubs.begin();
807 for (; aSubIter != aSubs.end(); aSubIter++) {
808 if (!subDoc(*aSubIter)->myObjs)
810 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
813 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
814 if (theSynchronize) {
815 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
816 // update the current features status
817 setCurrentFeature(currentFeature(false), false);
821 void Model_Document::undo()
823 undoInternal(true, true);
826 bool Model_Document::canRedo()
828 if (!myRedos.empty())
830 // check other subs contains operation that can be redoed
831 const std::set<int> aSubs = subDocuments();
832 std::set<int>::iterator aSubIter = aSubs.begin();
833 for (; aSubIter != aSubs.end(); aSubIter++) {
834 if (!subDoc(*aSubIter)->myObjs)
836 if (subDoc(*aSubIter)->canRedo())
842 void Model_Document::redo()
844 if (!myNestedNum.empty())
845 (*myNestedNum.rbegin())++;
846 int aNumRedos = myRedos.rbegin()->myOCAFNum;
847 myTransactions.push_back(*myRedos.rbegin());
849 TDF_LabelList aDeltaLabels;
850 for(int a = 0; a < aNumRedos; a++) {
851 modifiedLabels(myDoc, aDeltaLabels, true);
856 const std::set<int> aSubs = subDocuments();
857 std::set<int>::iterator aSubIter = aSubs.begin();
858 for (; aSubIter != aSubs.end(); aSubIter++)
859 subDoc(*aSubIter)->redo();
861 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
862 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
863 // update the current features status
864 setCurrentFeature(currentFeature(false), false);
867 std::list<std::string> Model_Document::undoList() const
869 std::list<std::string> aResult;
870 // the number of skipped current operations (on undo they will be aborted)
871 int aSkipCurrent = isOperation() ? 1 : 0;
872 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
873 int aNumUndo = int(myTransactions.size());
874 if (!myNestedNum.empty())
875 aNumUndo = *myNestedNum.rbegin();
876 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
877 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
883 std::list<std::string> Model_Document::redoList() const
885 std::list<std::string> aResult;
886 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
887 for( ; aTrIter != myRedos.crend(); aTrIter++) {
888 aResult.push_back(aTrIter->myId);
893 void Model_Document::operationId(const std::string& theId)
895 myTransactions.rbegin()->myId = theId;
898 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
900 std::shared_ptr<Model_Session> aSession =
901 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
902 FeaturePtr aFeature = aSession->createFeature(theID, this);
906 Model_Document* aDocToAdd;
907 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
908 if (aFeature->documentToAdd() != kind()) { // the root document by default
909 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
913 } else { // if customized is not presented, add to "this" document
917 // searching for feature after which must be added the next feature: this is the current feature
918 // but also all sub-features of this feature
919 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
920 bool isModified = true;
921 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
922 aComp.get() && isModified;
923 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
925 int aSubs = aComp->numberOfSubs(false);
926 for(int a = 0; a < aSubs; a++) {
927 FeaturePtr aSub = aComp->subFeature(a, false);
928 if (myObjs->isLater(aSub, aCurrent)) {
934 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
935 if (!aFeature->isAction()) { // do not add action to the data model
936 if (theMakeCurrent) // after all this feature stays in the document, so make it current
937 aDocToAdd->setCurrentFeature(aFeature, false);
938 } else { // feature must be executed
939 // no creation event => updater not working, problem with remove part
947 void Model_Document::refsToFeature(FeaturePtr theFeature,
948 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
950 myObjs->refsToFeature(theFeature, theRefs, isSendError);
953 void Model_Document::removeFeature(FeaturePtr theFeature)
955 myObjs->removeFeature(theFeature);
958 // recursive function to check if theSub is a child of theMain composite feature
959 // through all the hierarchy of parents
960 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
961 CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
964 if (aParent == theMain)
966 return isSub(theMain, aParent);
970 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
972 bool aCurrentUp = theMoved == currentFeature(false);
974 setCurrentFeatureUp();
976 // if user adds after high-level feature with nested,
977 // add it after all nested (otherwise the nested will be disabled)
978 CompositeFeaturePtr aCompositeAfter =
979 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
980 FeaturePtr anAfterThisSub = theAfterThis;
981 if (aCompositeAfter.get()) {
982 FeaturePtr aSub = aCompositeAfter;
984 FeaturePtr aNext = myObjs->nextFeature(aSub);
985 if (!isSub(aCompositeAfter, aNext)) {
986 anAfterThisSub = aSub;
990 } while (aSub.get());
993 myObjs->moveFeature(theMoved, anAfterThisSub);
994 if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
995 setCurrentFeature(currentFeature(false), false);
996 } else if (theAfterThis == currentFeature(false) || anAfterThisSub == currentFeature(false)) {
997 // must be after move to make enabled all features which are before theMoved
998 setCurrentFeature(theMoved, true);
1002 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
1004 myObjs->updateHistory(theObject);
1007 void Model_Document::updateHistory(const std::string theGroup)
1009 myObjs->updateHistory(theGroup);
1012 const std::set<int> Model_Document::subDocuments() const
1014 std::set<int> aResult;
1015 std::list<ResultPtr> aPartResults;
1016 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
1017 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
1018 for(; aPartRes != aPartResults.end(); aPartRes++) {
1019 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
1020 if (aPart && aPart->isActivated()) {
1021 aResult.insert(aPart->original()->partDoc()->id());
1027 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
1029 // just store sub-document identifier here to manage it later
1030 return std::dynamic_pointer_cast<Model_Document>(
1031 Model_Application::getApplication()->document(theDocID));
1034 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
1036 return myObjs->object(theGroupID, theIndex);
1039 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
1040 const std::string& theGroupID, const std::string& theName)
1042 return myObjs->objectByName(theGroupID, theName);
1045 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
1047 return myObjs->index(theObject);
1050 int Model_Document::size(const std::string& theGroupID)
1052 if (myObjs == 0) // may be on close
1054 return myObjs->size(theGroupID);
1057 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
1059 if (!myObjs) // on close document feature destruction it may call this method
1060 return std::shared_ptr<ModelAPI_Feature>();
1061 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1062 Handle(TDF_Reference) aRef;
1063 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1064 TDF_Label aLab = aRef->Get();
1065 FeaturePtr aResult = myObjs->feature(aLab);
1066 if (theVisible) { // get nearest visible (in history) going up
1067 while(aResult.get() && !aResult->isInHistory()) {
1068 aResult = myObjs->nextFeature(aResult, true);
1073 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1076 void Model_Document::setCurrentFeature(
1077 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1079 // blocks the flush signals to avoid each objects visualization in the viewer
1080 // they should not be shown once after all modifications are performed
1081 Events_Loop* aLoop = Events_Loop::loop();
1082 bool isActive = aLoop->activateFlushes(false);
1084 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1085 CompositeFeaturePtr aMain; // main feature that may nest the new current
1086 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1087 if (theCurrent.get()) {
1088 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1089 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1090 while(anOwner.get()) {
1094 anOwners.insert(anOwner);
1095 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1099 if (theVisible && !theCurrent.get()) {
1100 // needed to avoid disabling of PartSet initial constructions
1102 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1103 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1104 if (aNext->isInHistory()) {
1105 break; // next in history is not needed
1106 } else { // next not in history is good for making current
1111 if (theCurrent.get()) {
1112 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1113 if (!aData.get() || !aData->isValid()) {
1114 aLoop->activateFlushes(isActive);
1117 TDF_Label aFeatureLabel = aData->label().Father();
1119 Handle(TDF_Reference) aRef;
1120 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1121 aRef->Set(aFeatureLabel);
1123 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1125 } else { // remove reference for the null feature
1126 aRefLab.ForgetAttribute(TDF_Reference::GetID());
1128 // make all features after this feature disabled in reversed order
1129 // (to remove results without deps)
1130 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1132 bool aPassed = false; // flag that the current object is already passed in cycle
1133 FeaturePtr anIter = myObjs->lastFeature();
1134 bool aWasChanged = false;
1135 bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1136 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1137 // check this before passed become enabled: the current feature is enabled!
1138 if (anIter == theCurrent) aPassed = true;
1140 bool aDisabledFlag = !aPassed;
1142 if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1143 aDisabledFlag = false;
1144 else if (anOwners.find(anIter) != anOwners.end())
1145 // disable the higher-level feature if the nested is the current
1146 aDisabledFlag = true;
1149 if (anIter->getKind() == "Parameter") {
1150 // parameters are always out of the history of features, but not parameters
1151 // due to the issue 1491 all parameters are kept enabled any time
1152 //if (!isCurrentParameter)
1153 aDisabledFlag = false;
1154 } else if (isCurrentParameter) {
1155 // if paramater is active, all other features become enabled (issue 1307)
1156 aDisabledFlag = false;
1159 if (anIter->setDisabled(aDisabledFlag)) {
1160 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1161 // state of feature is changed => so inform that it must be updated if it has such state
1162 if (!aDisabledFlag &&
1163 (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1164 anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1165 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1166 // flush is in the end of this method
1167 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1170 // update for everyone the concealment flag immideately: on edit feature in the midle of history
1172 std::list<ResultPtr> aResults;
1173 ModelAPI_Tools::allResults(anIter, aResults);
1174 std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1175 for(; aRes != aResults.end(); aRes++) {
1176 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1177 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1179 // update the concealment status for disply in isConcealed of ResultBody
1180 for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1181 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1182 (*aRes)->isConcealed();
1186 // unblock the flush signals and up them after this
1187 aLoop->activateFlushes(isActive);
1190 void Model_Document::setCurrentFeatureUp()
1192 // on remove just go up for minimum step: highlight external objects in sketch causes
1193 // problems if it is true: here and in "setCurrentFeature"
1194 FeaturePtr aCurrent = currentFeature(false);
1195 if (aCurrent.get()) { // if not, do nothing because null is the upper
1196 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1197 // make the higher level composite as current (sketch becomes disabled if line is enabled)
1199 FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1200 // without cycle (issue 1555): otherwise extrusion fuse
1201 // will be enabled and displayed whaen inside sketch
1205 // do not flush: it is called only on remove, it will be flushed in the end of transaction
1206 setCurrentFeature(aPrev, false);
1210 TDF_Label Model_Document::generalLabel() const
1212 return myDoc->Main().FindChild(TAG_GENERAL);
1215 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1216 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1218 return myObjs->createConstruction(theFeatureData, theIndex);
1221 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1222 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1224 return myObjs->createBody(theFeatureData, theIndex);
1227 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1228 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1230 return myObjs->createPart(theFeatureData, theIndex);
1233 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1234 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1235 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1237 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1240 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1241 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1243 return myObjs->createGroup(theFeatureData, theIndex);
1246 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1247 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1249 return myObjs->createField(theFeatureData, theIndex);
1252 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1253 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1255 return myObjs->createParameter(theFeatureData, theIndex);
1258 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1259 const std::shared_ptr<ModelAPI_Result>& theResult)
1261 return myObjs->feature(theResult);
1264 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1266 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1269 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1271 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1274 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1276 myNamingNames[theName] = theLabel;
1279 void Model_Document::changeNamingName(const std::string theOldName, const std::string theNewName)
1281 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theOldName);
1282 if (aFind != myNamingNames.end()) {
1283 myNamingNames[theNewName] = aFind->second;
1284 myNamingNames.erase(theOldName);
1288 TDF_Label Model_Document::findNamingName(std::string theName)
1290 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1291 if (aFind != myNamingNames.end()) {
1292 return aFind->second;
1294 // not found exact name, try to find by sub-components
1295 std::string::size_type aSlash = theName.rfind('/');
1296 if (aSlash != std::string::npos) {
1297 std::string anObjName = theName.substr(0, aSlash);
1298 aFind = myNamingNames.find(anObjName);
1299 if (aFind != myNamingNames.end()) {
1300 TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1301 // searching sub-labels with this name
1302 TDF_ChildIDIterator aNamesIter(aFind->second, TDataStd_Name::GetID(), Standard_True);
1303 for(; aNamesIter.More(); aNamesIter.Next()) {
1304 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1305 if (aName->Get() == aSubName)
1306 return aName->Label();
1308 // If not found child label with the exact sub-name, then try to find compound with
1309 // such sub-name without suffix.
1310 Standard_Integer aSuffixPos = aSubName.SearchFromEnd('_');
1311 if (aSuffixPos != -1 && aSuffixPos != aSubName.Length()) {
1312 TCollection_ExtendedString anIndexStr = aSubName.Split(aSuffixPos);
1313 aSubName.Remove(aSuffixPos);
1314 aNamesIter.Initialize(aFind->second, TDataStd_Name::GetID(), Standard_True);
1315 for(; aNamesIter.More(); aNamesIter.Next()) {
1316 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1317 if (aName->Get() == aSubName) {
1318 return aName->Label();
1324 return TDF_Label(); // not found
1327 ResultPtr Model_Document::findByName(const std::string theName)
1329 return myObjs->findByName(theName);
1332 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1334 return myObjs->allFeatures();
1337 void Model_Document::setActive(const bool theFlag)
1339 if (theFlag != myIsActive) {
1340 myIsActive = theFlag;
1341 // redisplay all the objects of this part
1342 static Events_Loop* aLoop = Events_Loop::loop();
1343 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1345 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1346 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1347 object(ModelAPI_Feature::group(), a));
1348 if (aFeature.get() && aFeature->data()->isValid()) {
1349 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1350 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1351 for(; aRes != aResList.end(); aRes++) {
1352 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1353 // #issue 1048: sub-compsolids also
1354 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1355 if (aCompRes.get()) {
1356 int aNumSubs = aCompRes->numberOfSubs();
1357 for(int a = 0; a < aNumSubs; a++) {
1358 ResultPtr aSub = aCompRes->subResult(a);
1360 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1370 bool Model_Document::isActive() const
1375 int Model_Document::transactionID()
1377 Handle(TDataStd_Integer) anIndex;
1378 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1379 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1380 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1382 return anIndex->Get();
1385 void Model_Document::incrementTransactionID()
1387 int aNewVal = transactionID() + 1;
1388 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1390 void Model_Document::decrementTransactionID()
1392 int aNewVal = transactionID() - 1;
1393 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1396 TDF_Label Model_Document::extConstructionsLabel() const
1398 return myDoc->Main().FindChild(TAG_EXTERNAL_CONSTRUCTIONS);
1401 bool Model_Document::isOpened()
1403 return myObjs && !myDoc.IsNull();
1406 int Model_Document::numInternalFeatures()
1408 return myObjs->numInternalFeatures();
1411 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1413 return myObjs->internalFeature(theIndex);
1416 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1418 return myObjs->featureById(theId);
1421 void Model_Document::synchronizeTransactions()
1423 Model_Document* aRoot =
1424 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1426 return; // don't need to synchronise root with root
1428 std::shared_ptr<Model_Session> aSession =
1429 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1430 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1431 aSession->setCheckTransactions(false);
1433 aSession->setCheckTransactions(true);
1435 /* this case can not be reproduced in any known case for the current moment, so, just comment
1436 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1437 undoInternal(false, true);
1441 /// Feature that is used for selection in the Part document by the external request
1442 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1444 /// Nothing to do in constructor
1445 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1447 /// Returns the unique kind of a feature
1448 virtual const std::string& getKind() {
1449 static std::string MY_KIND("InternalSelectionInPartFeature");
1452 /// Request for initialization of data model of the object: adding all attributes
1453 virtual void initAttributes() {
1454 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1456 /// Nothing to do in the execution function
1457 virtual void execute() {}
1461 //! Returns the feature that is used for calculation of selection externally from the document
1462 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1464 // return already created, otherwise create
1465 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1467 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1469 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1470 std::shared_ptr<Model_Data> aData(new Model_Data);
1471 aData->setLabel(aFeatureLab.FindChild(1));
1472 aData->setObject(mySelectionFeature);
1473 mySelectionFeature->setDoc(myObjs->owner());
1474 mySelectionFeature->setData(aData);
1475 std::string aName = id() + "_Part";
1476 mySelectionFeature->data()->setName(aName);
1477 mySelectionFeature->setDoc(myObjs->owner());
1478 mySelectionFeature->initAttributes();
1479 mySelectionFeature->init(); // to make it enabled and Update correctly
1480 // this update may cause recomputation of the part after selection on it, that is not needed
1481 mySelectionFeature->data()->blockSendAttributeUpdated(true);
1483 return mySelectionFeature->selectionList("selection");
1486 FeaturePtr Model_Document::lastFeature()
1489 return myObjs->lastFeature();
1490 return FeaturePtr();
1493 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1494 Handle(TNaming_NamedShape) aResult;
1495 while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1496 TopoDS_Shape aShape = theShape;
1498 // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1499 if (!TNaming_Tool::HasLabel(aMain, aShape))
1501 for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1502 TDF_Label aNSLab = anIter.Label();
1503 Handle(TNaming_NamedShape) aNS;
1504 if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1505 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1506 if (aShapesIter.Evolution() == TNaming_SELECTED ||
1507 aShapesIter.Evolution() == TNaming_DELETE)
1508 continue; // don't use the selection evolution
1509 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1511 if (aResult->Evolution() == TNaming_MODIFY)
1512 theShape = aShapesIter.OldShape();
1513 // otherwise may me searching for another item of this shape with longer history
1514 if (!theShape.IsNull())
1524 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1525 std::shared_ptr<ModelAPI_Result> theResult,
1526 const std::shared_ptr<GeomAPI_Shape>& theShape)
1528 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1530 return feature(theResult); // for not-body just returns the feature that produced this result
1532 // otherwise get the shape and search the very initial label for it
1533 TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1534 if (aShape.IsNull())
1535 return FeaturePtr();
1537 // for comsolids and compounds all the naming is located in the main object, so, try to use
1539 ResultCompSolidPtr aMain = ModelAPI_Tools::compSolidOwner(theResult);
1541 FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1546 std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1547 if (!aBodyData.get() || !aBodyData->isValid())
1548 return FeaturePtr();
1550 TopoDS_Shape anOldShape; // old shape in the pair oldshape->theShape in the named shape
1551 TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1552 Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1553 TDF_Label aBodyLab = aBodyData->label();
1554 // use childs and this label (the lowest priority)
1555 TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1556 bool aUseThis = !aNSIter.More();
1557 while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1558 Handle(TNaming_NamedShape) aNS;
1560 if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1563 aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1565 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1566 if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1567 continue; // don't use the selection evolution
1568 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1569 aCandidatInThis = aNS;
1570 if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1571 anOldShape = aShapesIter.OldShape();
1572 // otherwise may me searching for another item of this shape with longer history
1573 if (!anOldShape.IsNull())
1576 // check that the shape contains aShape as sub-shape to fill container
1577 if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1578 TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1579 for(; anExp.More(); anExp.Next()) {
1580 if (aShape.IsSame(anExp.Current())) {
1581 aCandidatContainer = aNS;
1582 aShapeContainer = aShapesIter.NewShape();
1587 // iterate to the next label or to the body label in the end
1590 if (!aNSIter.More()) {
1596 if (aCandidatInThis.IsNull()) {
1597 // to fix 1512: searching for original shape of this shape
1598 // if modification of it is not in this result
1599 aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1600 if (aCandidatInThis.IsNull()) {
1601 if (aCandidatContainer.IsNull())
1602 return FeaturePtr();
1603 // with the lower priority use the higher level shape that contains aShape
1604 aCandidatInThis = aCandidatContainer;
1605 anOldShape = aShapeContainer;
1607 // to stop the searching by the following searchForOriginalShape
1608 anOldShape.Nullify();
1612 Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1614 aCandidatInThis = aNS;
1617 TDF_Label aResultLab = aCandidatInThis->Label();
1618 while(aResultLab.Depth() > 3)
1619 aResultLab = aResultLab.Father();
1620 FeaturePtr aFeature = myObjs->feature(aResultLab);
1621 if (aFeature.get()) {
1622 if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1629 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1631 return myObjs->isLater(theLater, theCurrent);
1634 void Model_Document::storeNodesState(const std::list<bool>& theStates)
1636 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1637 aLab.ForgetAllAttributes();
1638 if (!theStates.empty()) {
1639 Handle(TDataStd_BooleanArray) anArray =
1640 TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
1641 std::list<bool>::const_iterator aState = theStates.begin();
1642 for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
1643 anArray->SetValue(anIndex, *aState);
1648 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
1650 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1651 Handle(TDataStd_BooleanArray) anArray;
1652 if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
1653 int anUpper = anArray->Upper();
1654 for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
1655 theStates.push_back(anArray->Value(anIndex) == Standard_True);
1660 void Model_Document::eraseAllFeatures()
1663 myObjs->eraseAllFeatures();