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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
20 #include <Model_Document.h>
21 #include <Model_Data.h>
22 #include <Model_Objects.h>
23 #include <Model_Application.h>
24 #include <Model_Session.h>
25 #include <Model_Events.h>
26 #include <ModelAPI_ResultPart.h>
27 #include <ModelAPI_Validator.h>
28 #include <ModelAPI_CompositeFeature.h>
29 #include <ModelAPI_AttributeSelectionList.h>
30 #include <ModelAPI_Tools.h>
31 #include <ModelAPI_ResultBody.h>
32 #include <ModelAPI_ResultCompSolid.h>
33 #include <Events_Loop.h>
34 #include <Events_InfoMessage.h>
36 #include <TDataStd_Integer.hxx>
37 #include <TDataStd_Comment.hxx>
38 #include <TDF_ChildIDIterator.hxx>
39 #include <TDataStd_ReferenceArray.hxx>
40 #include <TDataStd_ReferenceList.hxx>
41 #include <TDataStd_IntegerArray.hxx>
42 #include <TDataStd_HLabelArray1.hxx>
43 #include <TDataStd_Name.hxx>
44 #include <TDataStd_AsciiString.hxx>
45 #include <TDF_Reference.hxx>
46 #include <TDF_ChildIDIterator.hxx>
47 #include <TDF_LabelMapHasher.hxx>
48 #include <TDF_Delta.hxx>
49 #include <TDF_AttributeDelta.hxx>
50 #include <TDF_AttributeDeltaList.hxx>
51 #include <TDF_ListIteratorOfAttributeDeltaList.hxx>
52 #include <TDF_ListIteratorOfLabelList.hxx>
53 #include <TDF_LabelMap.hxx>
54 #include <TDF_DeltaOnAddition.hxx>
55 #include <TNaming_Builder.hxx>
56 #include <TNaming_SameShapeIterator.hxx>
57 #include <TNaming_Iterator.hxx>
58 #include <TNaming_NamedShape.hxx>
59 #include <TNaming_Tool.hxx>
61 #include <TopExp_Explorer.hxx>
62 #include <TopoDS_Shape.hxx>
64 #include <OSD_File.hxx>
65 #include <OSD_Path.hxx>
66 #include <CDF_Session.hxx>
67 #include <CDF_Directory.hxx>
75 # define _separator_ '\\'
77 # define _separator_ '/'
80 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
82 static const int TAG_GENERAL = 1; // general properties tag
85 /// where the reference to the current feature label is located (or no attribute if null feature)
86 static const int TAG_CURRENT_FEATURE = 1; ///< reference to the current feature
87 static const int TAG_CURRENT_TRANSACTION = 2; ///< integer, index of the transaction
88 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
89 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
90 ///< naming structures constructions selected from other document
91 static const int TAG_EXTERNAL_CONSTRUCTIONS = 5;
93 Model_Document::Model_Document(const int theID, const std::string theKind)
94 : myID(theID), myKind(theKind), myIsActive(false),
95 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
98 CDF_Session::CurrentSession()->Directory()->Add(myDoc);
100 myObjs = new Model_Objects(myDoc->Main());
101 myDoc->SetUndoLimit(UNDO_LIMIT);
102 myTransactionSave = 0;
103 myExecuteFeatures = true;
104 // to have something in the document and avoid empty doc open/save problem
105 // in transaction for nesting correct working
107 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
108 // this to avoid creation of integer attribute outside the transaction after undo
110 myDoc->CommitCommand();
113 void Model_Document::setThis(DocumentPtr theDoc)
115 myObjs->setOwner(theDoc);
118 /// Returns the file name of this document by the name of directory and identifier of a document
119 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
121 TCollection_ExtendedString aPath((const Standard_CString) theDirName);
122 // remove end-separators
123 while(aPath.Length() &&
124 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
125 aPath.Remove(aPath.Length());
126 aPath += _separator_;
127 aPath += theID.c_str();
128 aPath += ".cbf"; // standard binary file extension
132 bool Model_Document::isRoot() const
134 return this == Model_Session::get()->moduleDocument().get();
137 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
139 Handle(Model_Application) anApp = Model_Application::getApplication();
141 anApp->setLoadPath(theDirName);
143 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
144 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
145 Handle(TDocStd_Document) aLoaded;
147 aStatus = anApp->Open(aPath, aLoaded);
148 } catch (Standard_Failure) {
149 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
150 Events_InfoMessage("Model_Document",
151 "Exception in opening of document: %1").arg(aFail->GetMessageString()).send();
154 bool isError = aStatus != PCDM_RS_OK;
157 case PCDM_RS_UnknownDocument:
158 Events_InfoMessage("Model_Document", "Can not open document").send();
160 case PCDM_RS_AlreadyRetrieved:
161 Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
163 case PCDM_RS_AlreadyRetrievedAndModified:
164 Events_InfoMessage("Model_Document",
165 "Can not open document: already opened and modified").send();
167 case PCDM_RS_NoDriver:
168 Events_InfoMessage("Model_Document",
169 "Can not open document: driver library is not found").send();
171 case PCDM_RS_UnknownFileDriver:
172 Events_InfoMessage("Model_Document",
173 "Can not open document: unknown driver for opening").send();
175 case PCDM_RS_OpenError:
176 Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
178 case PCDM_RS_NoVersion:
179 Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
181 case PCDM_RS_NoModel:
182 Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
184 case PCDM_RS_NoDocument:
185 Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
187 case PCDM_RS_FormatFailure:
188 Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
190 case PCDM_RS_TypeNotFoundInSchema:
191 Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
193 case PCDM_RS_UnrecognizedFileFormat:
194 Events_InfoMessage("Model_Document",
195 "Can not open document: unrecognized file format").send();
197 case PCDM_RS_MakeFailure:
198 Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
200 case PCDM_RS_PermissionDenied:
201 Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
203 case PCDM_RS_DriverFailure:
204 Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
207 Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
211 std::shared_ptr<Model_Session> aSession =
212 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
215 myDoc->SetUndoLimit(UNDO_LIMIT);
217 // to avoid the problem that feature is created in the current, not this, document
218 aSession->setActiveDocument(anApp->document(myID), false);
219 aSession->setCheckTransactions(false);
222 myObjs = new Model_Objects(myDoc->Main()); // synchronisation is inside
223 myObjs->setOwner(theThis);
224 // update the current features status
225 setCurrentFeature(currentFeature(false), false);
226 aSession->setCheckTransactions(true);
227 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
228 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
229 // aSession->setActiveDocument(anApp->getDocument(myID), true);
231 // make sub-parts as loaded by demand
232 std::list<ResultPtr> aPartResults;
233 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
234 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
235 for(; aPartRes != aPartResults.end(); aPartRes++) {
236 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
238 anApp->setLoadByDemand(aPart->data()->name(),
239 aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->docId());
242 } else { // open failed, but new documnet was created to work with it: inform the model
243 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
248 bool Model_Document::save(
249 const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
251 // if the history line is not in the end, move it to the end before save, otherwise
252 // problems with results restore and (the most important) naming problems will appear
253 // due to change evolution to SELECTION (problems in NamedShape and Name)
254 FeaturePtr aWasCurrent;
255 std::shared_ptr<Model_Session> aSession =
256 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
257 if (currentFeature(false) != lastFeature()) {
258 aSession->setCheckTransactions(false);
259 aWasCurrent = currentFeature(false);
260 // if last is nested into something else, make this something else as last:
261 // otherwise it will look like edition of sub-element, so, the main will be disabled
262 FeaturePtr aLast = lastFeature();
264 CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
267 aMain = ModelAPI_Tools::compositeOwner(aLast);
270 setCurrentFeature(aLast, true);
272 // create a directory in the root document if it is not yet exist
273 Handle(Model_Application) anApp = Model_Application::getApplication();
276 CreateDirectory(theDirName, NULL);
278 mkdir(theDirName, 0x1ff);
281 // filename in the dir is id of document inside of the given directory
282 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
283 PCDM_StoreStatus aStatus;
285 aStatus = anApp->SaveAs(myDoc, aPath);
286 } catch (Standard_Failure) {
287 Handle(Standard_Failure) aFail = Standard_Failure::Caught();
288 Events_InfoMessage("Model_Document",
289 "Exception in saving of document: %1").arg(aFail->GetMessageString()).send();
290 if (aWasCurrent.get()) { // return the current feature to the initial position
291 setCurrentFeature(aWasCurrent, false);
292 aSession->setCheckTransactions(true);
296 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
299 case PCDM_SS_DriverFailure:
300 Events_InfoMessage("Model_Document",
301 "Can not save document: save driver-library failure").send();
303 case PCDM_SS_WriteFailure:
304 Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
306 case PCDM_SS_Failure:
308 Events_InfoMessage("Model_Document", "Can not save document").send();
313 if (aWasCurrent.get()) { // return the current feature to the initial position
314 setCurrentFeature(aWasCurrent, false);
315 aSession->setCheckTransactions(true);
318 myTransactionSave = int(myTransactions.size());
319 if (isDone) { // save also sub-documents if any
320 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
321 // iterate all result parts to find all loaded or not yet loaded documents
322 std::list<ResultPtr> aPartResults;
323 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
324 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
325 for(; aPartRes != aPartResults.end(); aPartRes++) {
326 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
327 if (!aPart->isActivated()) {
328 // copy not-activated document that is not in the memory
329 std::string aDocName = aPart->data()->name();
330 if (!aDocName.empty()) {
332 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
333 OSD_Path aPath(aSubPath);
334 OSD_File aFile(aPath);
335 if (aFile.Exists()) {
336 TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
337 OSD_Path aDestination(aDestinationDir);
338 aFile.Copy(aDestination);
339 theResults.push_back(aDestinationDir.ToCString());
341 Events_InfoMessage("Model_Document",
342 "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
345 } else { // simply save opened document
346 isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
347 save(theDirName, aPart->data()->name().c_str(), theResults);
354 void Model_Document::close(const bool theForever)
356 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
357 if (!isRoot() && this == aPM->activeDocument().get()) {
358 aPM->setActiveDocument(aPM->moduleDocument());
359 } else if (isRoot()) {
360 // erase the active document if root is closed
361 aPM->setActiveDocument(DocumentPtr());
364 const std::set<int> aSubs = subDocuments();
365 std::set<int>::iterator aSubIter = aSubs.begin();
366 for (; aSubIter != aSubs.end(); aSubIter++) {
367 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
368 if (aSub->myObjs) // if it was not closed before
369 aSub->close(theForever);
372 // close for thid document needs no transaction in this document
373 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
375 // close all only if it is really asked, otherwise it can be undoed/redoed
377 // flush everything to avoid messages with bad objects
380 if (myDoc->CanClose() == CDM_CCS_OK)
382 mySelectionFeature.reset();
384 setCurrentFeature(FeaturePtr(), false); // disables all features
385 // update the OB: features are disabled (on remove of Part)
386 Events_Loop* aLoop = Events_Loop::loop();
387 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
388 aLoop->flush(aDeleteEvent);
391 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
394 void Model_Document::startOperation()
396 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
397 if (myDoc->HasOpenCommand()) { // start of nested command
398 if (myDoc->CommitCommand()) {
399 // commit the current: it will contain all nested after compactification
400 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
402 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
403 myDoc->OpenCommand();
404 } else { // start the simple command
407 // starts a new operation
408 myTransactions.push_back(Transaction());
409 if (!myNestedNum.empty())
410 (*myNestedNum.rbegin())++;
412 // new command for all subs
413 const std::set<int> aSubs = subDocuments();
414 std::set<int>::iterator aSubIter = aSubs.begin();
415 for (; aSubIter != aSubs.end(); aSubIter++)
416 subDoc(*aSubIter)->startOperation();
419 void Model_Document::compactNested()
421 if (!myNestedNum.empty()) {
422 int aNumToCompact = *(myNestedNum.rbegin());
423 int aSumOfTransaction = 0;
424 for(int a = 0; a < aNumToCompact; a++) {
425 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
426 myTransactions.pop_back();
428 // the latest transaction is the start of lower-level operation which startes the nested
429 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
430 myNestedNum.pop_back();
434 /// Compares the content of the given attributes, returns true if equal.
435 /// This method is used to avoid empty transactions when only "current" is changed
436 /// to some value and then comes back in this transaction, so, it compares only
437 /// references and Boolean and Integer Arrays for the current moment.
438 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
440 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
441 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
442 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
443 if (aRef1.IsNull() && aRef2.IsNull())
445 if (aRef1.IsNull() || aRef2.IsNull())
447 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
448 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
449 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
450 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
451 if (anArr1.IsNull() && anArr2.IsNull())
453 if (anArr1.IsNull() || anArr2.IsNull())
455 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
456 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++) {
457 if (a == 1 && // second is for display
458 anArr2->Label().Tag() == 1 && (anArr2->Label().Depth() == 4 ||
459 anArr2->Label().Depth() == 6))
461 if (anArr1->Value(a) != anArr2->Value(a))
466 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
467 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
468 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
469 if (anArr1.IsNull() && anArr2.IsNull())
471 if (anArr1.IsNull() || anArr2.IsNull())
473 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
474 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
475 if (anArr1->Value(a) != anArr2->Value(a)) {
476 // avoid the transaction ID checking
477 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
478 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
484 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
485 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
486 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
487 if (anArr1.IsNull() && anArr2.IsNull())
489 if (anArr1.IsNull() || anArr2.IsNull())
491 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
492 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
493 if (anArr1->Value(a) != anArr2->Value(a)) {
494 // avoid the transaction ID checking
495 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
496 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
502 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
503 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
504 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
505 if (aList1.IsNull() && aList2.IsNull())
507 if (aList1.IsNull() || aList2.IsNull())
509 const TDF_LabelList& aLList1 = aList1->List();
510 const TDF_LabelList& aLList2 = aList2->List();
511 TDF_ListIteratorOfLabelList aLIter1(aLList1);
512 TDF_ListIteratorOfLabelList aLIter2(aLList2);
513 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
514 if (aLIter1.Value() != aLIter2.Value())
517 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
518 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
519 return true; // it just for created and removed feature: nothing is changed
524 /// Returns true if the last transaction is actually empty: modification to te same values
525 /// were performed only
526 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
527 Handle(TDF_Delta) aDelta;
528 aDelta = theDoc->GetUndos().Last();
529 TDF_LabelList aDeltaList;
530 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
531 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
534 // add also label of the modified attributes
535 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
536 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
537 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
538 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
539 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
540 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
541 Handle(TDF_Attribute) aCurrentAttr;
542 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
543 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
544 continue; // attribute is not changed actually
547 if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
548 continue; // error message is disappeared
557 bool Model_Document::finishOperation()
559 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
560 static std::shared_ptr<Model_Session> aSession =
561 std::static_pointer_cast<Model_Session>(Model_Session::get());
563 // open transaction if nested is closed to fit inside
564 // all synchronizeBackRefs and flushed consequences
565 if (isNestedClosed) {
566 myDoc->OpenCommand();
568 // do it before flashes to enable and recompute nesting features correctly
569 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
570 // if all nested operations are closed, make current the higher level objects (to perform
571 // it in the python scripts correctly): sketch become current after creation ofsub-elements
572 FeaturePtr aCurrent = currentFeature(false);
573 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
576 aNext = ModelAPI_Tools::compositeOwner(aMain);
578 if (aMain.get() && aMain != aCurrent)
579 setCurrentFeature(aMain, false);
581 myObjs->synchronizeBackRefs();
582 Events_Loop* aLoop = Events_Loop::loop();
583 static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
584 static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
585 static const Events_ID kRedispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
586 static const Events_ID kDeletedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_DELETED);
587 aLoop->flush(kCreatedEvent);
588 aLoop->flush(kUpdatedEvent);
589 aLoop->flush(kRedispEvent);
590 aLoop->flush(kDeletedEvent);
592 if (isNestedClosed) {
593 if (myDoc->CommitCommand())
594 myTransactions.rbegin()->myOCAFNum++;
597 // this must be here just after everything is finished but before real transaction stop
598 // to avoid messages about modifications outside of the transaction
599 // and to rebuild everything after all updates and creates
600 if (isRoot()) { // once for root document
601 static std::shared_ptr<Events_Message> aFinishMsg
602 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
603 Events_Loop::loop()->send(aFinishMsg);
606 // for open of document with primitive box inside (finish transaction in initAttributes)
607 bool aWasActivatedFlushes = aLoop->activateFlushes(true);
608 while(aLoop->hasGrouppedEvent(kCreatedEvent) || aLoop->hasGrouppedEvent(kUpdatedEvent) ||
609 aLoop->hasGrouppedEvent(kRedispEvent) || aLoop->hasGrouppedEvent(kDeletedEvent)) {
610 aLoop->flush(kCreatedEvent);
611 aLoop->flush(kUpdatedEvent);
612 aLoop->flush(kRedispEvent);
613 aLoop->flush(kDeletedEvent);
615 aLoop->activateFlushes(aWasActivatedFlushes);
617 // to avoid "updated" message appearance by updater
618 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
620 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
621 bool aResult = false;
622 const std::set<int> aSubs = subDocuments();
623 std::set<int>::iterator aSubIter = aSubs.begin();
624 for (; aSubIter != aSubs.end(); aSubIter++)
625 if (subDoc(*aSubIter)->finishOperation())
628 // transaction may be empty if this document was created during this transaction (create part)
629 if (!myTransactions.empty() && myDoc->CommitCommand()) {
630 // if commit is successfull, just increment counters
631 if (isEmptyTransaction(myDoc)) { // erase this transaction
635 myTransactions.rbegin()->myOCAFNum++;
640 if (isNestedClosed) {
643 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
644 aResult = myTransactions.rbegin()->myOCAFNum != 0;
646 if (!aResult && isRoot()) {
647 // nothing inside in all documents, so remove this transaction from the transactions list
648 undoInternal(true, false);
650 // on finish clear redos in any case (issue 446) and for all subs (issue 408)
653 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
654 subDoc(*aSubIter)->myDoc->ClearRedos();
655 subDoc(*aSubIter)->myRedos.clear();
661 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
662 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
663 const bool isRedo = false) {
664 Handle(TDF_Delta) aDelta;
666 aDelta = theDoc->GetRedos().First();
668 aDelta = theDoc->GetUndos().Last();
669 TDF_LabelList aDeltaList;
670 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
671 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
672 theDelta.Append(aListIter.Value());
674 // add also label of the modified attributes
675 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
676 /// named shape evolution also modifies integer on this label: exclude it
677 TDF_LabelMap anExcludedInt;
678 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
679 if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
680 // Boolean array is used for feature auxiliary attributes only, feature args are not modified
683 if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
684 anExcludedInt.Add(anAttr.Value()->Label());
685 // named shape evolution is changed in history update => skip them,
686 // they are not the features arguents
689 if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
690 if (anExcludedInt.Contains(anAttr.Value()->Label()))
693 theDelta.Append(anAttr.Value()->Label());
695 TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
696 for(; aDeltaIter.More(); aDeltaIter.Next()) {
697 if (anExcludedInt.Contains(aDeltaIter.Value())) {
698 theDelta.Remove(aDeltaIter);
699 if (!aDeltaIter.More())
705 void Model_Document::abortOperation()
707 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
708 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
710 // store undo-delta here as undo actually does in the method later
711 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
712 for(a = 0; a < aNumTransactions; a++) {
713 modifiedLabels(myDoc, aDeltaLabels);
716 for(a = 0; a < aNumTransactions; a++) {
720 undoInternal(false, false);
723 } else { // abort the current
724 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
725 myTransactions.pop_back();
726 if (!myNestedNum.empty())
727 (*myNestedNum.rbegin())--;
728 // roll back the needed number of transactions
729 //myDoc->AbortCommand();
730 // instead of abort, do commit and undo: to get the delta of modifications
731 if (myDoc->CommitCommand()) {
732 modifiedLabels(myDoc, aDeltaLabels);
735 for(int a = 0; a < aNumTransactions; a++) {
736 modifiedLabels(myDoc, aDeltaLabels);
741 // abort for all subs, flushes will be later, in the end of root abort
742 const std::set<int> aSubs = subDocuments();
743 std::set<int>::iterator aSubIter = aSubs.begin();
744 for (; aSubIter != aSubs.end(); aSubIter++)
745 subDoc(*aSubIter)->abortOperation();
746 // references may be changed because they are set in attributes on the fly
747 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
750 bool Model_Document::isOperation() const
752 // operation is opened for all documents: no need to check subs
753 return myDoc->HasOpenCommand() == Standard_True ;
756 bool Model_Document::isModified()
758 // is modified if at least one operation was commited and not undoed
759 return myTransactions.size() != myTransactionSave || isOperation();
762 bool Model_Document::canUndo()
764 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
765 int aCurrentNum = isOperation() ? 1 : 0;
766 if (myDoc->GetAvailableUndos() > 0 &&
767 // there is something to undo in nested
768 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
769 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
771 // check other subs contains operation that can be undoed
772 const std::set<int> aSubs = subDocuments();
773 std::set<int>::iterator aSubIter = aSubs.begin();
774 for (; aSubIter != aSubs.end(); aSubIter++) {
775 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
776 if (aSub->myObjs) {// if it was not closed before
785 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
787 if (myTransactions.empty())
789 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
790 myRedos.push_back(*myTransactions.rbegin());
791 myTransactions.pop_back();
792 if (!myNestedNum.empty())
793 (*myNestedNum.rbegin())--;
794 // roll back the needed number of transactions
795 TDF_LabelList aDeltaLabels;
796 for(int a = 0; a < aNumTransactions; a++) {
798 modifiedLabels(myDoc, aDeltaLabels);
804 const std::set<int> aSubs = subDocuments();
805 std::set<int>::iterator aSubIter = aSubs.begin();
806 for (; aSubIter != aSubs.end(); aSubIter++) {
807 if (!subDoc(*aSubIter)->myObjs)
809 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
812 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
813 if (theSynchronize) {
814 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
815 // update the current features status
816 setCurrentFeature(currentFeature(false), false);
820 void Model_Document::undo()
822 undoInternal(true, true);
825 bool Model_Document::canRedo()
827 if (!myRedos.empty())
829 // check other subs contains operation that can be redoed
830 const std::set<int> aSubs = subDocuments();
831 std::set<int>::iterator aSubIter = aSubs.begin();
832 for (; aSubIter != aSubs.end(); aSubIter++) {
833 if (!subDoc(*aSubIter)->myObjs)
835 if (subDoc(*aSubIter)->canRedo())
841 void Model_Document::redo()
843 if (!myNestedNum.empty())
844 (*myNestedNum.rbegin())++;
845 int aNumRedos = myRedos.rbegin()->myOCAFNum;
846 myTransactions.push_back(*myRedos.rbegin());
848 TDF_LabelList aDeltaLabels;
849 for(int a = 0; a < aNumRedos; a++) {
850 modifiedLabels(myDoc, aDeltaLabels, true);
855 const std::set<int> aSubs = subDocuments();
856 std::set<int>::iterator aSubIter = aSubs.begin();
857 for (; aSubIter != aSubs.end(); aSubIter++)
858 subDoc(*aSubIter)->redo();
860 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
861 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
862 // update the current features status
863 setCurrentFeature(currentFeature(false), false);
866 std::list<std::string> Model_Document::undoList() const
868 std::list<std::string> aResult;
869 // the number of skipped current operations (on undo they will be aborted)
870 int aSkipCurrent = isOperation() ? 1 : 0;
871 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
872 int aNumUndo = int(myTransactions.size());
873 if (!myNestedNum.empty())
874 aNumUndo = *myNestedNum.rbegin();
875 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
876 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
882 std::list<std::string> Model_Document::redoList() const
884 std::list<std::string> aResult;
885 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
886 for( ; aTrIter != myRedos.crend(); aTrIter++) {
887 aResult.push_back(aTrIter->myId);
892 void Model_Document::operationId(const std::string& theId)
894 myTransactions.rbegin()->myId = theId;
897 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
899 std::shared_ptr<Model_Session> aSession =
900 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
901 FeaturePtr aFeature = aSession->createFeature(theID, this);
905 Model_Document* aDocToAdd;
906 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
907 if (aFeature->documentToAdd() != kind()) { // the root document by default
908 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
912 } else { // if customized is not presented, add to "this" document
916 // searching for feature after which must be added the next feature: this is the current feature
917 // but also all sub-features of this feature
918 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
919 bool isModified = true;
920 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
921 aComp.get() && isModified;
922 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
924 int aSubs = aComp->numberOfSubs(false);
925 for(int a = 0; a < aSubs; a++) {
926 FeaturePtr aSub = aComp->subFeature(a, false);
927 if (myObjs->isLater(aSub, aCurrent)) {
933 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
934 if (!aFeature->isAction()) { // do not add action to the data model
935 if (theMakeCurrent) // after all this feature stays in the document, so make it current
936 aDocToAdd->setCurrentFeature(aFeature, false);
937 } else { // feature must be executed
938 // no creation event => updater not working, problem with remove part
946 void Model_Document::refsToFeature(FeaturePtr theFeature,
947 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
949 myObjs->refsToFeature(theFeature, theRefs, isSendError);
952 void Model_Document::removeFeature(FeaturePtr theFeature)
954 myObjs->removeFeature(theFeature);
957 // recursive function to check if theSub is a child of theMain composite feature
958 // through all the hierarchy of parents
959 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
960 CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
963 if (aParent == theMain)
965 return isSub(theMain, aParent);
969 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
971 bool aCurrentUp = theMoved == currentFeature(false);
973 setCurrentFeatureUp();
975 // if user adds after high-level feature with nested,
976 // add it after all nested (otherwise the nested will be disabled)
977 CompositeFeaturePtr aCompositeAfter =
978 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
979 FeaturePtr anAfterThisSub = theAfterThis;
980 if (aCompositeAfter.get()) {
981 FeaturePtr aSub = aCompositeAfter;
983 FeaturePtr aNext = myObjs->nextFeature(aSub);
984 if (!isSub(aCompositeAfter, aNext)) {
985 anAfterThisSub = aSub;
989 } while (aSub.get());
992 myObjs->moveFeature(theMoved, anAfterThisSub);
993 if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
994 setCurrentFeature(currentFeature(false), false);
995 } else if (theAfterThis == currentFeature(false) || anAfterThisSub == currentFeature(false)) {
996 // must be after move to make enabled all features which are before theMoved
997 setCurrentFeature(theMoved, true);
1001 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
1003 myObjs->updateHistory(theObject);
1006 void Model_Document::updateHistory(const std::string theGroup)
1008 myObjs->updateHistory(theGroup);
1011 const std::set<int> Model_Document::subDocuments() const
1013 std::set<int> aResult;
1014 std::list<ResultPtr> aPartResults;
1015 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
1016 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
1017 for(; aPartRes != aPartResults.end(); aPartRes++) {
1018 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
1019 if (aPart && aPart->isActivated()) {
1020 aResult.insert(aPart->original()->partDoc()->id());
1026 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
1028 // just store sub-document identifier here to manage it later
1029 return std::dynamic_pointer_cast<Model_Document>(
1030 Model_Application::getApplication()->document(theDocID));
1033 ObjectPtr Model_Document::object(const std::string& theGroupID, const int theIndex)
1035 return myObjs->object(theGroupID, theIndex);
1038 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
1039 const std::string& theGroupID, const std::string& theName)
1041 return myObjs->objectByName(theGroupID, theName);
1044 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject)
1046 return myObjs->index(theObject);
1049 int Model_Document::size(const std::string& theGroupID)
1051 if (myObjs == 0) // may be on close
1053 return myObjs->size(theGroupID);
1056 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
1058 if (!myObjs) // on close document feature destruction it may call this method
1059 return std::shared_ptr<ModelAPI_Feature>();
1060 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1061 Handle(TDF_Reference) aRef;
1062 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1063 TDF_Label aLab = aRef->Get();
1064 FeaturePtr aResult = myObjs->feature(aLab);
1065 if (theVisible) { // get nearest visible (in history) going up
1066 while(aResult.get() && !aResult->isInHistory()) {
1067 aResult = myObjs->nextFeature(aResult, true);
1072 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1075 void Model_Document::setCurrentFeature(
1076 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1078 // blocks the flush signals to avoid each objects visualization in the viewer
1079 // they should not be shown once after all modifications are performed
1080 Events_Loop* aLoop = Events_Loop::loop();
1081 bool isActive = aLoop->activateFlushes(false);
1083 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1084 CompositeFeaturePtr aMain; // main feature that may nest the new current
1085 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1086 if (theCurrent.get()) {
1087 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1088 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1089 while(anOwner.get()) {
1093 anOwners.insert(anOwner);
1094 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1098 if (theVisible && !theCurrent.get()) {
1099 // needed to avoid disabling of PartSet initial constructions
1101 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1102 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1103 if (aNext->isInHistory()) {
1104 break; // next in history is not needed
1105 } else { // next not in history is good for making current
1110 if (theCurrent.get()) {
1111 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1112 if (!aData.get() || !aData->isValid()) {
1113 aLoop->activateFlushes(isActive);
1116 TDF_Label aFeatureLabel = aData->label().Father();
1118 Handle(TDF_Reference) aRef;
1119 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1120 aRef->Set(aFeatureLabel);
1122 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1124 } else { // remove reference for the null feature
1125 aRefLab.ForgetAttribute(TDF_Reference::GetID());
1127 // make all features after this feature disabled in reversed order
1128 // (to remove results without deps)
1129 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1131 bool aPassed = false; // flag that the current object is already passed in cycle
1132 FeaturePtr anIter = myObjs->lastFeature();
1133 bool aWasChanged = false;
1134 bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1135 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1136 // check this before passed become enabled: the current feature is enabled!
1137 if (anIter == theCurrent) aPassed = true;
1139 bool aDisabledFlag = !aPassed;
1141 if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1142 aDisabledFlag = false;
1143 else if (anOwners.find(anIter) != anOwners.end())
1144 // disable the higher-level feature if the nested is the current
1145 aDisabledFlag = true;
1148 if (anIter->getKind() == "Parameter") {
1149 // parameters are always out of the history of features, but not parameters
1150 // due to the issue 1491 all parameters are kept enabled any time
1151 //if (!isCurrentParameter)
1152 aDisabledFlag = false;
1153 } else if (isCurrentParameter) {
1154 // if paramater is active, all other features become enabled (issue 1307)
1155 aDisabledFlag = false;
1158 if (anIter->setDisabled(aDisabledFlag)) {
1159 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1160 // state of feature is changed => so inform that it must be updated if it has such state
1161 if (!aDisabledFlag &&
1162 (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1163 anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1164 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1165 // flush is in the end of this method
1166 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1169 // update for everyone the concealment flag immideately: on edit feature in the midle of history
1171 std::list<ResultPtr> aResults;
1172 ModelAPI_Tools::allResults(anIter, aResults);
1173 std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1174 for(; aRes != aResults.end(); aRes++) {
1175 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1176 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1178 // update the concealment status for disply in isConcealed of ResultBody
1179 for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1180 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1181 (*aRes)->isConcealed();
1185 // unblock the flush signals and up them after this
1186 aLoop->activateFlushes(isActive);
1189 void Model_Document::setCurrentFeatureUp()
1191 // on remove just go up for minimum step: highlight external objects in sketch causes
1192 // problems if it is true: here and in "setCurrentFeature"
1193 FeaturePtr aCurrent = currentFeature(false);
1194 if (aCurrent.get()) { // if not, do nothing because null is the upper
1195 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1196 // make the higher level composite as current (sketch becomes disabled if line is enabled)
1198 FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1199 // without cycle (issue 1555): otherwise extrusion fuse
1200 // will be enabled and displayed whaen inside sketch
1204 // do not flush: it is called only on remove, it will be flushed in the end of transaction
1205 setCurrentFeature(aPrev, false);
1209 TDF_Label Model_Document::generalLabel() const
1211 return myDoc->Main().FindChild(TAG_GENERAL);
1214 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1215 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1217 return myObjs->createConstruction(theFeatureData, theIndex);
1220 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1221 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1223 return myObjs->createBody(theFeatureData, theIndex);
1226 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1227 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1229 return myObjs->createPart(theFeatureData, theIndex);
1232 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1233 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1234 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1236 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1239 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1240 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1242 return myObjs->createGroup(theFeatureData, theIndex);
1245 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1246 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1248 return myObjs->createField(theFeatureData, theIndex);
1251 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1252 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1254 return myObjs->createParameter(theFeatureData, theIndex);
1257 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1258 const std::shared_ptr<ModelAPI_Result>& theResult)
1260 return myObjs->feature(theResult);
1263 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1265 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1268 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1270 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1273 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1275 myNamingNames[theName] = theLabel;
1278 void Model_Document::changeNamingName(const std::string theOldName, const std::string theNewName)
1280 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theOldName);
1281 if (aFind != myNamingNames.end()) {
1282 myNamingNames[theNewName] = aFind->second;
1283 myNamingNames.erase(theOldName);
1287 TDF_Label Model_Document::findNamingName(std::string theName)
1289 std::map<std::string, TDF_Label>::iterator aFind = myNamingNames.find(theName);
1290 if (aFind != myNamingNames.end()) {
1291 return aFind->second;
1293 // not found exact name, try to find by sub-components
1294 std::string::size_type aSlash = theName.rfind('/');
1295 if (aSlash != std::string::npos) {
1296 std::string anObjName = theName.substr(0, aSlash);
1297 aFind = myNamingNames.find(anObjName);
1298 if (aFind != myNamingNames.end()) {
1299 TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1300 // searching sub-labels with this name
1301 TDF_ChildIDIterator aNamesIter(aFind->second, TDataStd_Name::GetID(), Standard_True);
1302 for(; aNamesIter.More(); aNamesIter.Next()) {
1303 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1304 if (aName->Get() == aSubName)
1305 return aName->Label();
1307 // If not found child label with the exact sub-name, then try to find compound with
1308 // such sub-name without suffix.
1309 Standard_Integer aSuffixPos = aSubName.SearchFromEnd('_');
1310 if (aSuffixPos != -1) {
1311 TCollection_ExtendedString anIndexStr = aSubName.Split(aSuffixPos);
1312 aSubName.Remove(aSuffixPos);
1313 aNamesIter.Initialize(aFind->second, TDataStd_Name::GetID(), Standard_True);
1314 for(; aNamesIter.More(); aNamesIter.Next()) {
1315 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1316 if (aName->Get() == aSubName) {
1317 return aName->Label();
1323 return TDF_Label(); // not found
1326 ResultPtr Model_Document::findByName(const std::string theName)
1328 return myObjs->findByName(theName);
1331 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1333 return myObjs->allFeatures();
1336 void Model_Document::setActive(const bool theFlag)
1338 if (theFlag != myIsActive) {
1339 myIsActive = theFlag;
1340 // redisplay all the objects of this part
1341 static Events_Loop* aLoop = Events_Loop::loop();
1342 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1344 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1345 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1346 object(ModelAPI_Feature::group(), a));
1347 if (aFeature.get() && aFeature->data()->isValid()) {
1348 const std::list<std::shared_ptr<ModelAPI_Result> >& aResList = aFeature->results();
1349 std::list<std::shared_ptr<ModelAPI_Result> >::const_iterator aRes = aResList.begin();
1350 for(; aRes != aResList.end(); aRes++) {
1351 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1352 // #issue 1048: sub-compsolids also
1353 ResultCompSolidPtr aCompRes = std::dynamic_pointer_cast<ModelAPI_ResultCompSolid>(*aRes);
1354 if (aCompRes.get()) {
1355 int aNumSubs = aCompRes->numberOfSubs();
1356 for(int a = 0; a < aNumSubs; a++) {
1357 ResultPtr aSub = aCompRes->subResult(a);
1359 ModelAPI_EventCreator::get()->sendUpdated(aSub, aRedispEvent);
1369 bool Model_Document::isActive() const
1374 int Model_Document::transactionID()
1376 Handle(TDataStd_Integer) anIndex;
1377 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1378 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1379 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1381 return anIndex->Get();
1384 void Model_Document::incrementTransactionID()
1386 int aNewVal = transactionID() + 1;
1387 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1389 void Model_Document::decrementTransactionID()
1391 int aNewVal = transactionID() - 1;
1392 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1395 TDF_Label Model_Document::extConstructionsLabel() const
1397 return myDoc->Main().FindChild(TAG_EXTERNAL_CONSTRUCTIONS);
1400 bool Model_Document::isOpened()
1402 return myObjs && !myDoc.IsNull();
1405 int Model_Document::numInternalFeatures()
1407 return myObjs->numInternalFeatures();
1410 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1412 return myObjs->internalFeature(theIndex);
1415 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1417 return myObjs->featureById(theId);
1420 void Model_Document::synchronizeTransactions()
1422 Model_Document* aRoot =
1423 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1425 return; // don't need to synchronise root with root
1427 std::shared_ptr<Model_Session> aSession =
1428 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1429 while(myRedos.size() > aRoot->myRedos.size()) { // remove redos in this
1430 aSession->setCheckTransactions(false);
1432 aSession->setCheckTransactions(true);
1434 /* this case can not be reproduced in any known case for the current moment, so, just comment
1435 while(myRedos.size() < aRoot->myRedos.size()) { // add more redos in this
1436 undoInternal(false, true);
1440 /// Feature that is used for selection in the Part document by the external request
1441 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1443 /// Nothing to do in constructor
1444 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1446 /// Returns the unique kind of a feature
1447 virtual const std::string& getKind() {
1448 static std::string MY_KIND("InternalSelectionInPartFeature");
1451 /// Request for initialization of data model of the object: adding all attributes
1452 virtual void initAttributes() {
1453 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1455 /// Nothing to do in the execution function
1456 virtual void execute() {}
1460 //! Returns the feature that is used for calculation of selection externally from the document
1461 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1463 // return already created, otherwise create
1464 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1466 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1468 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1469 std::shared_ptr<Model_Data> aData(new Model_Data);
1470 aData->setLabel(aFeatureLab.FindChild(1));
1471 aData->setObject(mySelectionFeature);
1472 mySelectionFeature->setDoc(myObjs->owner());
1473 mySelectionFeature->setData(aData);
1474 std::string aName = id() + "_Part";
1475 mySelectionFeature->data()->setName(aName);
1476 mySelectionFeature->setDoc(myObjs->owner());
1477 mySelectionFeature->initAttributes();
1478 mySelectionFeature->init(); // to make it enabled and Update correctly
1479 // this update may cause recomputation of the part after selection on it, that is not needed
1480 mySelectionFeature->data()->blockSendAttributeUpdated(true);
1482 return mySelectionFeature->selectionList("selection");
1485 FeaturePtr Model_Document::lastFeature()
1488 return myObjs->lastFeature();
1489 return FeaturePtr();
1492 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1493 Handle(TNaming_NamedShape) aResult;
1494 while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1495 TopoDS_Shape aShape = theShape;
1497 // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1498 if (!TNaming_Tool::HasLabel(aMain, aShape))
1500 for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1501 TDF_Label aNSLab = anIter.Label();
1502 Handle(TNaming_NamedShape) aNS;
1503 if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1504 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1505 if (aShapesIter.Evolution() == TNaming_SELECTED ||
1506 aShapesIter.Evolution() == TNaming_DELETE)
1507 continue; // don't use the selection evolution
1508 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1510 if (aResult->Evolution() == TNaming_MODIFY)
1511 theShape = aShapesIter.OldShape();
1512 // otherwise may me searching for another item of this shape with longer history
1513 if (!theShape.IsNull())
1523 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1524 std::shared_ptr<ModelAPI_Result> theResult,
1525 const std::shared_ptr<GeomAPI_Shape>& theShape)
1527 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1529 return feature(theResult); // for not-body just returns the feature that produced this result
1531 // otherwise get the shape and search the very initial label for it
1532 TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1533 if (aShape.IsNull())
1534 return FeaturePtr();
1536 // for comsolids and compounds all the naming is located in the main object, so, try to use
1538 ResultCompSolidPtr aMain = ModelAPI_Tools::compSolidOwner(theResult);
1540 FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1545 std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1546 if (!aBodyData.get() || !aBodyData->isValid())
1547 return FeaturePtr();
1549 TopoDS_Shape anOldShape; // old shape in the pair oldshape->theShape in the named shape
1550 TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1551 Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1552 TDF_Label aBodyLab = aBodyData->label();
1553 // use childs and this label (the lowest priority)
1554 TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1555 bool aUseThis = !aNSIter.More();
1556 while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1557 Handle(TNaming_NamedShape) aNS;
1559 if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1562 aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1564 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1565 if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1566 continue; // don't use the selection evolution
1567 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1568 aCandidatInThis = aNS;
1569 if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1570 anOldShape = aShapesIter.OldShape();
1571 // otherwise may me searching for another item of this shape with longer history
1572 if (!anOldShape.IsNull())
1575 // check that the shape contains aShape as sub-shape to fill container
1576 if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1577 TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1578 for(; anExp.More(); anExp.Next()) {
1579 if (aShape.IsSame(anExp.Current())) {
1580 aCandidatContainer = aNS;
1581 aShapeContainer = aShapesIter.NewShape();
1586 // iterate to the next label or to the body label in the end
1589 if (!aNSIter.More()) {
1595 if (aCandidatInThis.IsNull()) {
1596 // to fix 1512: searching for original shape of this shape
1597 // if modification of it is not in this result
1598 aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1599 if (aCandidatInThis.IsNull()) {
1600 if (aCandidatContainer.IsNull())
1601 return FeaturePtr();
1602 // with the lower priority use the higher level shape that contains aShape
1603 aCandidatInThis = aCandidatContainer;
1604 anOldShape = aShapeContainer;
1606 // to stop the searching by the following searchForOriginalShape
1607 anOldShape.Nullify();
1611 Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1613 aCandidatInThis = aNS;
1616 TDF_Label aResultLab = aCandidatInThis->Label();
1617 while(aResultLab.Depth() > 3)
1618 aResultLab = aResultLab.Father();
1619 FeaturePtr aFeature = myObjs->feature(aResultLab);
1620 if (aFeature.get()) {
1621 if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1628 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1630 return myObjs->isLater(theLater, theCurrent);
1633 void Model_Document::storeNodesState(const std::list<bool>& theStates)
1635 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1636 aLab.ForgetAllAttributes();
1637 if (!theStates.empty()) {
1638 Handle(TDataStd_BooleanArray) anArray =
1639 TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
1640 std::list<bool>::const_iterator aState = theStates.begin();
1641 for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
1642 anArray->SetValue(anIndex, *aState);
1647 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
1649 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
1650 Handle(TDataStd_BooleanArray) anArray;
1651 if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
1652 int anUpper = anArray->Upper();
1653 for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
1654 theStates.push_back(anArray->Value(anIndex) == Standard_True);
1659 void Model_Document::eraseAllFeatures()
1662 myObjs->eraseAllFeatures();