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 <Events_Loop.h>
34 #include <Events_InfoMessage.h>
35 #include <GeomAPI_Tools.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_Tool.hxx>
56 #include <TDF_DeltaOnAddition.hxx>
57 #include <TDataStd_ExtStringList.hxx>
58 #include <TDataStd_UAttribute.hxx>
59 #include <TNaming_Builder.hxx>
60 #include <TNaming_SameShapeIterator.hxx>
61 #include <TNaming_Iterator.hxx>
62 #include <TNaming_NamedShape.hxx>
63 #include <TNaming_Tool.hxx>
64 #include<TNaming_OldShapeIterator.hxx>
65 #include <TopTools_DataMapOfShapeShape.hxx>
66 #include <TopTools_ListOfShape.hxx>
68 #include <TopExp_Explorer.hxx>
69 #include <TopoDS_Shape.hxx>
71 #include <OSD_File.hxx>
72 #include <OSD_Path.hxx>
73 #include <CDF_Session.hxx>
74 #include <CDF_Directory.hxx>
82 # define _separator_ '\\'
84 # define _separator_ '/'
87 static const int UNDO_LIMIT = 1000; // number of possible undo operations (big for sketcher)
89 static const int TAG_GENERAL = 1; // general properties tag
92 /// where the reference to the current feature label is located (or no attribute if null feature)
93 static const int TAG_CURRENT_FEATURE = 1; ///< reference to the current feature
94 /// integer, index of the transaction + GUID for auto recomputation blocking
95 static const int TAG_CURRENT_TRANSACTION = 2;
96 static const int TAG_SELECTION_FEATURE = 3; ///< integer, tag of the selection feature label
97 static const int TAG_NODES_STATE = 4; ///< array, tag of the Object Browser nodes states
98 ///< naming structures constructions selected from other document
99 static const int TAG_EXTERNAL_CONSTRUCTIONS = 5;
101 /// reference to the shape in external document: sting list attribute identifier
102 static const Standard_GUID kEXTERNAL_SHAPE_REF("9aa5dd14-6d34-4a8d-8786-05842fd7bbbd");
104 Model_Document::Model_Document(const int theID, const std::string theKind)
105 : myID(theID), myKind(theKind), myIsActive(false), myIsSetCurrentFeature(false),
106 myDoc(new TDocStd_Document("BinOcaf")) // binary OCAF format
109 CDF_Session::CurrentSession()->Directory()->Add(myDoc);
111 myObjs = new Model_Objects(myDoc->Main());
112 myDoc->SetUndoLimit(UNDO_LIMIT);
113 myTransactionSave = 0;
114 myExecuteFeatures = true;
115 // to have something in the document and avoid empty doc open/save problem
116 // in transaction for nesting correct working
118 TDataStd_Integer::Set(myDoc->Main().Father(), 0);
119 // this to avoid creation of integer attribute outside the transaction after undo
121 myDoc->CommitCommand();
124 void Model_Document::setThis(DocumentPtr theDoc)
126 myObjs->setOwner(theDoc);
129 /// Returns the file name of this document by the name of directory and identifier of a document
130 static TCollection_ExtendedString DocFileName(const char* theDirName, const std::string& theID)
132 TCollection_ExtendedString aPath((const Standard_CString) theDirName);
133 // remove end-separators
134 while(aPath.Length() &&
135 (aPath.Value(aPath.Length()) == '\\' || aPath.Value(aPath.Length()) == '/'))
136 aPath.Remove(aPath.Length());
137 aPath += _separator_;
138 aPath += theID.c_str();
139 aPath += ".cbf"; // standard binary file extension
143 bool Model_Document::isRoot() const
145 return this == Model_Session::get()->moduleDocument().get();
148 /// Makes all modification and generation naming shapes that have old shapes corresponding to
149 /// shapes in a root document be equal to this root document
150 static void updateShapesFromRoot(const TDF_Label theThisAccess, const TDF_Label theRootAccess)
152 TopTools_DataMapOfShapeShape aCurrentToRoot; // shapes that must be updated: from this to root
153 TDF_ChildIDIterator aThisIter(theThisAccess.Root(), kEXTERNAL_SHAPE_REF, true);
154 for(; aThisIter.More(); aThisIter.Next()) {
155 aCurrentToRoot.Clear();
156 Handle(TNaming_NamedShape) aNS;
157 if (!aThisIter.Value()->Label().FindAttribute(TNaming_NamedShape::GetID(), aNS))
159 if (aNS->Evolution() != TNaming_GENERATED && aNS->Evolution() != TNaming_MODIFY)
161 for (TNaming_Iterator aNSIter(aNS); aNSIter.More(); aNSIter.Next()) {
162 const TopoDS_Shape& anOld = aNSIter.OldShape();
165 TNaming_OldShapeIterator aNewIter(anOld, theThisAccess);
166 for (; aNewIter.More(); aNewIter.Next()) {
167 TNaming_Evolution anEvolution = aNewIter.NamedShape()->Evolution();
168 if (anEvolution != TNaming_SELECTED && anEvolution != TNaming_DELETE)
173 GeomShapePtr anOldShape(new GeomAPI_Shape), aRootShape(new GeomAPI_Shape);
174 anOldShape->setImpl<TopoDS_Shape>(new TopoDS_Shape(anOld));
175 anOldShape = GeomAPI_Tools::getTypedShape(anOldShape);
177 // search the same shape in the root document
178 Handle(TDataStd_ExtStringList) anEntries =
179 Handle(TDataStd_ExtStringList)::DownCast(aThisIter.Value());
180 TDataStd_ListOfExtendedString::Iterator anIter(anEntries->List());
181 for (; anIter.More(); anIter.Next()) {
183 TDF_Tool::Label(theRootAccess.Data(), anIter.Value(), aRootLab);
184 if (aRootLab.IsNull())
186 Handle(TNaming_NamedShape) aRootNS;
187 if (!aRootLab.FindAttribute(TNaming_NamedShape::GetID(), aRootNS))
189 TNaming_Iterator aRootShapes(aRootNS);
190 for (; aRootShapes.More(); aRootShapes.Next()) {
191 if (aRootShapes.NewShape().IsNull())
193 aRootShape->setImpl(new TopoDS_Shape(aRootShapes.NewShape()));
194 aRootShape = GeomAPI_Tools::getTypedShape(aRootShape);
195 if (!anOldShape->isEqual(aRootShape)) // special checking by geometry
197 // found a good corresponded shape
198 if (!anOld.IsEqual(aRootShapes.NewShape()))
199 aCurrentToRoot.Bind(anOld, aRootShapes.NewShape());
203 if (!aCurrentToRoot.IsEmpty()) { // update the whole named shape content
204 TopTools_ListOfShape anOld, aNew;
205 TNaming_Evolution anEvol = aNS->Evolution();
206 for(TNaming_Iterator aNSIter(aNS); aNSIter.More(); aNSIter.Next()) {
207 anOld.Prepend(aCurrentToRoot.IsBound(aNSIter.OldShape()) ?
208 aCurrentToRoot.Find(aNSIter.OldShape()) : aNSIter.OldShape());
209 aNew.Prepend(aNSIter.NewShape());
211 TNaming_Builder aBuilder(aNS->Label());
212 TopTools_ListOfShape::Iterator anOldIter(anOld), aNewIter(aNew);
213 for(; anOldIter.More(); anOldIter.Next(), aNewIter.Next()) {
214 if (anEvol == TNaming_GENERATED) {
215 aBuilder.Generated(anOldIter.Value(), aNewIter.Value());
216 } else if (anEvol == TNaming_MODIFY) {
217 aBuilder.Modify(anOldIter.Value(), aNewIter.Value());
224 bool Model_Document::load(const char* theDirName, const char* theFileName, DocumentPtr theThis)
226 Handle(Model_Application) anApp = Model_Application::getApplication();
228 anApp->setLoadPath(theDirName);
230 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
231 PCDM_ReaderStatus aStatus = (PCDM_ReaderStatus) -1;
232 Handle(TDocStd_Document) aLoaded;
234 aStatus = anApp->Open(aPath, aLoaded);
235 } catch (Standard_Failure const& anException) {
236 Events_InfoMessage("Model_Document",
237 "Exception in opening of document: %1").arg(anException.GetMessageString()).send();
240 bool isError = aStatus != PCDM_RS_OK;
243 case PCDM_RS_UnknownDocument:
244 Events_InfoMessage("Model_Document", "Can not open document").send();
246 case PCDM_RS_AlreadyRetrieved:
247 Events_InfoMessage("Model_Document", "Can not open document: already opened").send();
249 case PCDM_RS_AlreadyRetrievedAndModified:
250 Events_InfoMessage("Model_Document",
251 "Can not open document: already opened and modified").send();
253 case PCDM_RS_NoDriver:
254 Events_InfoMessage("Model_Document",
255 "Can not open document: driver library is not found").send();
257 case PCDM_RS_UnknownFileDriver:
258 Events_InfoMessage("Model_Document",
259 "Can not open document: unknown driver for opening").send();
261 case PCDM_RS_OpenError:
262 Events_InfoMessage("Model_Document", "Can not open document: file open error").send();
264 case PCDM_RS_NoVersion:
265 Events_InfoMessage("Model_Document", "Can not open document: invalid version").send();
267 case PCDM_RS_NoModel:
268 Events_InfoMessage("Model_Document", "Can not open document: no data model").send();
270 case PCDM_RS_NoDocument:
271 Events_InfoMessage("Model_Document", "Can not open document: no document inside").send();
273 case PCDM_RS_FormatFailure:
274 Events_InfoMessage("Model_Document", "Can not open document: format failure").send();
276 case PCDM_RS_TypeNotFoundInSchema:
277 Events_InfoMessage("Model_Document", "Can not open document: invalid object").send();
279 case PCDM_RS_UnrecognizedFileFormat:
280 Events_InfoMessage("Model_Document",
281 "Can not open document: unrecognized file format").send();
283 case PCDM_RS_MakeFailure:
284 Events_InfoMessage("Model_Document", "Can not open document: make failure").send();
286 case PCDM_RS_PermissionDenied:
287 Events_InfoMessage("Model_Document", "Can not open document: permission denied").send();
289 case PCDM_RS_DriverFailure:
290 Events_InfoMessage("Model_Document", "Can not open document: driver failure").send();
293 Events_InfoMessage("Model_Document", "Can not open document: unknown error").send();
297 std::shared_ptr<Model_Session> aSession =
298 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
301 myDoc->SetUndoLimit(UNDO_LIMIT);
303 // to avoid the problem that feature is created in the current, not this, document
304 aSession->setActiveDocument(anApp->document(myID), false);
305 aSession->setCheckTransactions(false);
308 myObjs = new Model_Objects(myDoc->Main()); // synchronization is inside
309 myObjs->setOwner(theThis);
310 // update the current features status
311 setCurrentFeature(currentFeature(false), false);
312 aSession->setCheckTransactions(true);
313 aSession->setActiveDocument(aSession->moduleDocument(), false);
314 // this is done in Part result "activate", so no needed here. Causes not-blue active part.
315 // aSession->setActiveDocument(anApp->getDocument(myID), true);
317 // make sub-parts as loaded by demand
318 std::list<ResultPtr> aPartResults;
319 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
320 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
321 for(; aPartRes != aPartResults.end(); aPartRes++) {
322 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
324 anApp->setLoadByDemand(aPart->data()->name(),
325 aPart->data()->document(ModelAPI_ResultPart::DOC_REF())->docId());
328 updateShapesFromRoot(myDoc->Main(),
329 std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument())->generalLabel());
331 } else { // open failed, but new document was created to work with it: inform the model
332 aSession->setActiveDocument(Model_Session::get()->moduleDocument(), false);
337 bool Model_Document::save(
338 const char* theDirName, const char* theFileName, std::list<std::string>& theResults)
340 // if the history line is not in the end, move it to the end before save, otherwise
341 // problems with results restore and (the most important) naming problems will appear
342 // due to change evolution to SELECTION (problems in NamedShape and Name)
343 FeaturePtr aWasCurrent;
344 std::shared_ptr<Model_Session> aSession =
345 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
346 if (currentFeature(false) != lastFeature()) {
347 aSession->setCheckTransactions(false);
348 aWasCurrent = currentFeature(false);
349 // if last is nested into something else, make this something else as last:
350 // otherwise it will look like edition of sub-element, so, the main will be disabled
351 FeaturePtr aLast = lastFeature();
353 CompositeFeaturePtr aMain = ModelAPI_Tools::compositeOwner(aLast);
356 aMain = ModelAPI_Tools::compositeOwner(aLast);
359 setCurrentFeature(aLast, true);
361 // create a directory in the root document if it is not yet exist
362 Handle(Model_Application) anApp = Model_Application::getApplication();
365 CreateDirectory((LPTSTR) theDirName, NULL);
367 mkdir(theDirName, 0x1ff);
370 // filename in the dir is id of document inside of the given directory
371 TCollection_ExtendedString aPath(DocFileName(theDirName, theFileName));
372 PCDM_StoreStatus aStatus;
374 aStatus = anApp->SaveAs(myDoc, aPath);
375 } catch (Standard_Failure const& anException) {
376 Events_InfoMessage("Model_Document",
377 "Exception in saving of document: %1").arg(anException.GetMessageString()).send();
378 if (aWasCurrent.get()) { // return the current feature to the initial position
379 setCurrentFeature(aWasCurrent, false);
380 aSession->setCheckTransactions(true);
384 bool isDone = aStatus == PCDM_SS_OK || aStatus == PCDM_SS_No_Obj;
387 case PCDM_SS_DriverFailure:
388 Events_InfoMessage("Model_Document",
389 "Can not save document: save driver-library failure").send();
391 case PCDM_SS_WriteFailure:
392 Events_InfoMessage("Model_Document", "Can not save document: file writing failure").send();
394 case PCDM_SS_Failure:
396 Events_InfoMessage("Model_Document", "Can not save document").send();
401 if (aWasCurrent.get()) { // return the current feature to the initial position
402 setCurrentFeature(aWasCurrent, false);
403 aSession->setCheckTransactions(true);
406 myTransactionSave = int(myTransactions.size());
407 if (isDone) { // save also sub-documents if any
408 theResults.push_back(TCollection_AsciiString(aPath).ToCString());
409 // iterate all result parts to find all loaded or not yet loaded documents
410 std::list<ResultPtr> aPartResults;
411 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
412 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
413 for(; aPartRes != aPartResults.end(); aPartRes++) {
414 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
415 if (!aPart->isActivated()) {
416 // copy not-activated document that is not in the memory
417 std::string aDocName = aPart->data()->name();
418 if (!aDocName.empty()) {
420 TCollection_AsciiString aSubPath(DocFileName(anApp->loadPath().c_str(), aDocName));
421 OSD_Path aPath(aSubPath);
422 OSD_File aFile(aPath);
423 if (aFile.Exists()) {
424 TCollection_AsciiString aDestinationDir(DocFileName(theDirName, aDocName));
425 OSD_Path aDestination(aDestinationDir);
426 aFile.Copy(aDestination);
427 theResults.push_back(aDestinationDir.ToCString());
429 Events_InfoMessage("Model_Document",
430 "Can not open file %1 for saving").arg(aSubPath.ToCString()).send();
433 } else { // simply save opened document
434 isDone = std::dynamic_pointer_cast<Model_Document>(aPart->partDoc())->
435 save(theDirName, aPart->data()->name().c_str(), theResults);
442 void Model_Document::close(const bool theForever)
444 std::shared_ptr<ModelAPI_Session> aPM = Model_Session::get();
445 if (!isRoot() && this == aPM->activeDocument().get()) {
446 aPM->setActiveDocument(aPM->moduleDocument());
447 } else if (isRoot()) {
448 // erase the active document if root is closed
449 aPM->setActiveDocument(DocumentPtr());
452 const std::set<int> aSubs = subDocuments();
453 std::set<int>::iterator aSubIter = aSubs.begin();
454 for (; aSubIter != aSubs.end(); aSubIter++) {
455 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
456 if (aSub->myObjs) // if it was not closed before
457 aSub->close(theForever);
460 // close for this document needs no transaction in this document
461 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(false);
463 // close all only if it is really asked, otherwise it can be undone/redone
465 // flush everything to avoid messages with bad objects
468 if (myDoc->CanClose() == CDM_CCS_OK)
470 mySelectionFeature.reset();
472 setCurrentFeature(FeaturePtr(), false); // disables all features
473 // update the OB: features are disabled (on remove of Part)
474 Events_Loop* aLoop = Events_Loop::loop();
475 static Events_ID aDeleteEvent = Events_Loop::eventByName(EVENT_OBJECT_DELETED);
476 aLoop->flush(aDeleteEvent);
479 std::static_pointer_cast<Model_Session>(Model_Session::get())->setCheckTransactions(true);
482 void Model_Document::startOperation()
484 incrementTransactionID(); // outside of transaction in order to avoid empty transactions keeping
485 if (myDoc->HasOpenCommand()) { // start of nested command
486 if (myDoc->CommitCommand()) {
487 // commit the current: it will contain all nested after compactification
488 myTransactions.rbegin()->myOCAFNum++; // if has open command, the list is not empty
490 myNestedNum.push_back(0); // start of nested operation with zero transactions inside yet
491 myDoc->OpenCommand();
492 } else { // start the simple command
495 // starts a new operation
496 myTransactions.push_back(Transaction());
497 if (!myNestedNum.empty())
498 (*myNestedNum.rbegin())++;
500 // new command for all subs
501 const std::set<int> aSubs = subDocuments();
502 std::set<int>::iterator aSubIter = aSubs.begin();
503 for (; aSubIter != aSubs.end(); aSubIter++)
504 subDoc(*aSubIter)->startOperation();
507 void Model_Document::compactNested()
509 if (!myNestedNum.empty()) {
510 int aNumToCompact = *(myNestedNum.rbegin());
511 int aSumOfTransaction = 0;
512 for(int a = 0; a < aNumToCompact; a++) {
513 aSumOfTransaction += myTransactions.rbegin()->myOCAFNum;
514 myTransactions.pop_back();
516 // the latest transaction is the start of lower-level operation which starts the nested
517 myTransactions.rbegin()->myOCAFNum += aSumOfTransaction;
518 myNestedNum.pop_back();
522 /// Compares the content of the given attributes, returns true if equal.
523 /// This method is used to avoid empty transactions when only "current" is changed
524 /// to some value and then comes back in this transaction, so, it compares only
525 /// references and Boolean and Integer Arrays for the current moment.
526 static bool isEqualContent(Handle(TDF_Attribute) theAttr1, Handle(TDF_Attribute) theAttr2)
528 if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_Reference::GetID())) { // reference
529 Handle(TDF_Reference) aRef1 = Handle(TDF_Reference)::DownCast(theAttr1);
530 Handle(TDF_Reference) aRef2 = Handle(TDF_Reference)::DownCast(theAttr2);
531 if (aRef1.IsNull() && aRef2.IsNull())
533 if (aRef1.IsNull() || aRef2.IsNull())
535 return aRef1->Get().IsEqual(aRef2->Get()) == Standard_True;
536 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_BooleanArray::GetID())) {
537 Handle(TDataStd_BooleanArray) anArr1 = Handle(TDataStd_BooleanArray)::DownCast(theAttr1);
538 Handle(TDataStd_BooleanArray) anArr2 = Handle(TDataStd_BooleanArray)::DownCast(theAttr2);
539 if (anArr1.IsNull() && anArr2.IsNull())
541 if (anArr1.IsNull() || anArr2.IsNull())
543 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
544 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++) {
545 if (a == 1 && // second is for display
546 anArr2->Label().Tag() == 1 && (anArr2->Label().Depth() == 4 ||
547 anArr2->Label().Depth() == 6))
549 if (anArr1->Value(a) != anArr2->Value(a))
554 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_IntegerArray::GetID())) {
555 Handle(TDataStd_IntegerArray) anArr1 = Handle(TDataStd_IntegerArray)::DownCast(theAttr1);
556 Handle(TDataStd_IntegerArray) anArr2 = Handle(TDataStd_IntegerArray)::DownCast(theAttr2);
557 if (anArr1.IsNull() && anArr2.IsNull())
559 if (anArr1.IsNull() || anArr2.IsNull())
561 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
562 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
563 if (anArr1->Value(a) != anArr2->Value(a)) {
564 // avoid the transaction ID checking
565 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
566 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
572 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceArray::GetID())) {
573 Handle(TDataStd_ReferenceArray) anArr1 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr1);
574 Handle(TDataStd_ReferenceArray) anArr2 = Handle(TDataStd_ReferenceArray)::DownCast(theAttr2);
575 if (anArr1.IsNull() && anArr2.IsNull())
577 if (anArr1.IsNull() || anArr2.IsNull())
579 if (anArr1->Lower() == anArr2->Lower() && anArr1->Upper() == anArr2->Upper()) {
580 for(int a = anArr1->Lower(); a <= anArr1->Upper(); a++)
581 if (anArr1->Value(a) != anArr2->Value(a)) {
582 // avoid the transaction ID checking
583 if (a == 2 && anArr1->Upper() == 2 && anArr2->Label().Tag() == 1 &&
584 (anArr2->Label().Depth() == 4 || anArr2->Label().Depth() == 6))
590 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDataStd_ReferenceList::GetID())) {
591 Handle(TDataStd_ReferenceList) aList1 = Handle(TDataStd_ReferenceList)::DownCast(theAttr1);
592 Handle(TDataStd_ReferenceList) aList2= Handle(TDataStd_ReferenceList)::DownCast(theAttr2);
593 if (aList1.IsNull() && aList2.IsNull())
595 if (aList1.IsNull() || aList2.IsNull())
597 const TDF_LabelList& aLList1 = aList1->List();
598 const TDF_LabelList& aLList2 = aList2->List();
599 TDF_ListIteratorOfLabelList aLIter1(aLList1);
600 TDF_ListIteratorOfLabelList aLIter2(aLList2);
601 for(; aLIter1.More() && aLIter2.More(); aLIter1.Next(), aLIter2.Next()) {
602 if (aLIter1.Value() != aLIter2.Value())
605 return !aLIter1.More() && !aLIter2.More(); // both lists are with the same size
606 } else if (Standard_GUID::IsEqual(theAttr1->ID(), TDF_TagSource::GetID())) {
607 return true; // it just for created and removed feature: nothing is changed
612 /// Returns true if the last transaction is actually empty: modification to the same values
613 /// were performed only
614 static bool isEmptyTransaction(const Handle(TDocStd_Document)& theDoc) {
615 Handle(TDF_Delta) aDelta;
616 aDelta = theDoc->GetUndos().Last();
617 TDF_LabelList aDeltaList;
618 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
619 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
622 // add also label of the modified attributes
623 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
624 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
625 Handle(TDF_AttributeDelta)& anADelta = anAttr.Value();
626 Handle(TDF_DeltaOnAddition) anAddition = Handle(TDF_DeltaOnAddition)::DownCast(anADelta);
627 if (anAddition.IsNull()) { // if the attribute was added, transaction is not empty
628 if (!anADelta->Label().IsNull() && !anADelta->Attribute().IsNull()) {
629 Handle(TDF_Attribute) aCurrentAttr;
630 if (anADelta->Label().FindAttribute(anADelta->Attribute()->ID(), aCurrentAttr)) {
631 if (isEqualContent(anADelta->Attribute(), aCurrentAttr)) {
632 continue; // attribute is not changed actually
635 if (Standard_GUID::IsEqual(anADelta->Attribute()->ID(), TDataStd_AsciiString::GetID())) {
636 continue; // error message is disappeared
645 bool Model_Document::finishOperation()
647 bool isNestedClosed = !myDoc->HasOpenCommand() && !myNestedNum.empty();
648 static std::shared_ptr<Model_Session> aSession =
649 std::static_pointer_cast<Model_Session>(Model_Session::get());
651 // open transaction if nested is closed to fit inside
652 // all synchronizeBackRefs and flushed consequences
653 if (isNestedClosed) {
654 myDoc->OpenCommand();
656 // do it before flashes to enable and recompute nesting features correctly
657 if (myNestedNum.empty() || (isNestedClosed && myNestedNum.size() == 1)) {
658 // if all nested operations are closed, make current the higher level objects (to perform
659 // it in the python scripts correctly): sketch become current after creation of sub-elements
660 FeaturePtr aCurrent = currentFeature(false);
661 CompositeFeaturePtr aMain, aNext = ModelAPI_Tools::compositeOwner(aCurrent);
664 aNext = ModelAPI_Tools::compositeOwner(aMain);
666 if (aMain.get() && aMain != aCurrent)
667 setCurrentFeature(aMain, false);
669 myObjs->synchronizeBackRefs();
670 Events_Loop* aLoop = Events_Loop::loop();
671 static const Events_ID kCreatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_CREATED);
672 static const Events_ID kUpdatedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_UPDATED);
673 static const Events_ID kRedispEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_TO_REDISPLAY);
674 static const Events_ID kDeletedEvent = Events_Loop::loop()->eventByName(EVENT_OBJECT_DELETED);
675 aLoop->flush(kCreatedEvent);
676 aLoop->flush(kUpdatedEvent);
677 aLoop->flush(kRedispEvent);
678 aLoop->flush(kDeletedEvent);
680 if (isNestedClosed) {
681 if (myDoc->CommitCommand())
682 myTransactions.rbegin()->myOCAFNum++;
685 // this must be here just after everything is finished but before real transaction stop
686 // to avoid messages about modifications outside of the transaction
687 // and to rebuild everything after all updates and creates
688 if (isRoot()) { // once for root document
689 static std::shared_ptr<Events_Message> aFinishMsg
690 (new Events_Message(Events_Loop::eventByName("FinishOperation")));
691 Events_Loop::loop()->send(aFinishMsg);
694 // for open of document with primitive box inside (finish transaction in initAttributes)
695 bool aWasActivatedFlushes = aLoop->activateFlushes(true);
696 while(aLoop->hasGrouppedEvent(kCreatedEvent) || aLoop->hasGrouppedEvent(kUpdatedEvent) ||
697 aLoop->hasGrouppedEvent(kRedispEvent) || aLoop->hasGrouppedEvent(kDeletedEvent)) {
698 aLoop->flush(kCreatedEvent);
699 aLoop->flush(kUpdatedEvent);
700 aLoop->flush(kRedispEvent);
701 aLoop->flush(kDeletedEvent);
703 aLoop->activateFlushes(aWasActivatedFlushes);
705 // to avoid "updated" message appearance by updater
706 //aLoop->clear(Events_Loop::eventByName(EVENT_OBJECT_UPDATED));
708 // finish for all subs first: to avoid nested finishing and "isOperation" calls problems inside
709 bool aResult = false;
710 const std::set<int> aSubs = subDocuments();
711 std::set<int>::iterator aSubIter = aSubs.begin();
712 for (; aSubIter != aSubs.end(); aSubIter++)
713 if (subDoc(*aSubIter)->finishOperation())
716 // transaction may be empty if this document was created during this transaction (create part)
717 if (!myTransactions.empty() && myDoc->CommitCommand()) {
718 // if commit is successful, just increment counters
719 if (isEmptyTransaction(myDoc)) { // erase this transaction
723 myTransactions.rbegin()->myOCAFNum++;
728 if (isNestedClosed) {
731 if (!aResult && !myTransactions.empty() /* it can be for just created part document */)
732 aResult = myTransactions.rbegin()->myOCAFNum != 0;
734 if (!aResult && isRoot()) {
735 // nothing inside in all documents, so remove this transaction from the transactions list
736 undoInternal(true, false);
738 // on finish clear redo in any case (issue 446) and for all subs (issue 408)
741 for (aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
742 subDoc(*aSubIter)->myDoc->ClearRedos();
743 subDoc(*aSubIter)->myRedos.clear();
749 /// Returns in theDelta labels that has been modified in the latest transaction of theDoc
750 static void modifiedLabels(const Handle(TDocStd_Document)& theDoc, TDF_LabelList& theDelta,
751 const bool isRedo = false) {
752 Handle(TDF_Delta) aDelta;
754 aDelta = theDoc->GetRedos().First();
756 aDelta = theDoc->GetUndos().Last();
757 TDF_LabelList aDeltaList;
758 aDelta->Labels(aDeltaList); // it clears list, so, use new one and then append to the result
759 for(TDF_ListIteratorOfLabelList aListIter(aDeltaList); aListIter.More(); aListIter.Next()) {
760 theDelta.Append(aListIter.Value());
762 // add also label of the modified attributes
763 const TDF_AttributeDeltaList& anAttrs = aDelta->AttributeDeltas();
764 /// named shape evolution also modifies integer on this label: exclude it
765 TDF_LabelMap anExcludedInt;
766 for (TDF_ListIteratorOfAttributeDeltaList anAttr(anAttrs); anAttr.More(); anAttr.Next()) {
767 if (anAttr.Value()->Attribute()->ID() == TDataStd_BooleanArray::GetID()) {
768 // Boolean array is used for feature auxiliary attributes only, feature args are not modified
771 if (anAttr.Value()->Attribute()->ID() == TNaming_NamedShape::GetID()) {
772 anExcludedInt.Add(anAttr.Value()->Label());
773 // named shape evolution is changed in history update => skip them,
774 // they are not the features arguments
777 if (anAttr.Value()->Attribute()->ID() == TDataStd_Integer::GetID()) {
778 if (anExcludedInt.Contains(anAttr.Value()->Label()))
781 theDelta.Append(anAttr.Value()->Label());
783 TDF_ListIteratorOfLabelList aDeltaIter(theDelta);
784 for(; aDeltaIter.More(); aDeltaIter.Next()) {
785 if (anExcludedInt.Contains(aDeltaIter.Value())) {
786 theDelta.Remove(aDeltaIter);
787 if (!aDeltaIter.More())
793 void Model_Document::abortOperation()
795 TDF_LabelList aDeltaLabels; // labels that are updated during "abort"
796 if (!myNestedNum.empty() && !myDoc->HasOpenCommand()) { // abort all what was done in nested
798 // store undo-delta here as undo actually does in the method later
799 int a, aNumTransactions = myTransactions.rbegin()->myOCAFNum;
800 for(a = 0; a < aNumTransactions; a++) {
801 modifiedLabels(myDoc, aDeltaLabels);
804 for(a = 0; a < aNumTransactions; a++) {
808 undoInternal(false, false);
811 } else { // abort the current
812 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
813 myTransactions.pop_back();
814 if (!myNestedNum.empty())
815 (*myNestedNum.rbegin())--;
816 // roll back the needed number of transactions
817 //myDoc->AbortCommand();
818 // instead of abort, do commit and undo: to get the delta of modifications
819 if (myDoc->CommitCommand()) {
820 modifiedLabels(myDoc, aDeltaLabels);
823 for(int a = 0; a < aNumTransactions; a++) {
824 modifiedLabels(myDoc, aDeltaLabels);
829 // abort for all subs, flushes will be later, in the end of root abort
830 const std::set<int> aSubs = subDocuments();
831 std::set<int>::iterator aSubIter = aSubs.begin();
832 for (; aSubIter != aSubs.end(); aSubIter++)
833 subDoc(*aSubIter)->abortOperation();
834 // references may be changed because they are set in attributes on the fly
835 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
838 bool Model_Document::isOperation() const
840 // operation is opened for all documents: no need to check subs
841 return myDoc->HasOpenCommand() == Standard_True ;
844 bool Model_Document::isModified()
846 // is modified if at least one operation was committed and not undone
847 return myTransactions.size() != myTransactionSave || isOperation();
850 bool Model_Document::canUndo()
852 // issue 406 : if transaction is opened, but nothing to undo behind, can not undo
853 int aCurrentNum = isOperation() ? 1 : 0;
854 if (myDoc->GetAvailableUndos() > 0 &&
855 // there is something to undo in nested
856 (myNestedNum.empty() || *myNestedNum.rbegin() - aCurrentNum > 0) &&
857 myTransactions.size() - aCurrentNum > 0 /* for omitting the first useless transaction */)
859 // check other subs contains operation that can be undone
860 const std::set<int> aSubs = subDocuments();
861 std::set<int>::iterator aSubIter = aSubs.begin();
862 for (; aSubIter != aSubs.end(); aSubIter++) {
863 std::shared_ptr<Model_Document> aSub = subDoc(*aSubIter);
864 if (aSub->myObjs) {// if it was not closed before
873 void Model_Document::undoInternal(const bool theWithSubs, const bool theSynchronize)
875 if (myTransactions.empty())
877 int aNumTransactions = myTransactions.rbegin()->myOCAFNum;
878 myRedos.push_back(*myTransactions.rbegin());
879 myTransactions.pop_back();
880 if (!myNestedNum.empty())
881 (*myNestedNum.rbegin())--;
882 // roll back the needed number of transactions
883 TDF_LabelList aDeltaLabels;
884 for(int a = 0; a < aNumTransactions; a++) {
886 modifiedLabels(myDoc, aDeltaLabels);
892 const std::set<int> aSubs = subDocuments();
893 std::set<int>::iterator aSubIter = aSubs.begin();
894 for (; aSubIter != aSubs.end(); aSubIter++) {
895 if (!subDoc(*aSubIter)->myObjs)
897 subDoc(*aSubIter)->undoInternal(theWithSubs, theSynchronize);
900 // after undo of all sub-documents to avoid updates on not-modified data (issue 370)
901 if (theSynchronize) {
902 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
903 // update the current features status
904 setCurrentFeature(currentFeature(false), false);
908 void Model_Document::undo()
910 undoInternal(true, true);
913 bool Model_Document::canRedo()
915 if (!myRedos.empty())
917 // check other subs contains operation that can be redone
918 const std::set<int> aSubs = subDocuments();
919 std::set<int>::iterator aSubIter = aSubs.begin();
920 for (; aSubIter != aSubs.end(); aSubIter++) {
921 if (!subDoc(*aSubIter)->myObjs)
923 if (subDoc(*aSubIter)->canRedo())
929 void Model_Document::redo()
931 if (!myNestedNum.empty())
932 (*myNestedNum.rbegin())++;
933 int aNumRedos = myRedos.rbegin()->myOCAFNum;
934 myTransactions.push_back(*myRedos.rbegin());
936 TDF_LabelList aDeltaLabels;
937 for(int a = 0; a < aNumRedos; a++) {
938 modifiedLabels(myDoc, aDeltaLabels, true);
943 const std::set<int> aSubs = subDocuments();
944 std::set<int>::iterator aSubIter = aSubs.begin();
945 for (; aSubIter != aSubs.end(); aSubIter++)
946 subDoc(*aSubIter)->redo();
948 // after redo of all sub-documents to avoid updates on not-modified data (issue 370)
949 myObjs->synchronizeFeatures(aDeltaLabels, true, false, false, isRoot());
950 // update the current features status
951 setCurrentFeature(currentFeature(false), false);
954 std::list<std::string> Model_Document::undoList() const
956 std::list<std::string> aResult;
957 // the number of skipped current operations (on undo they will be aborted)
958 int aSkipCurrent = isOperation() ? 1 : 0;
959 std::list<Transaction>::const_reverse_iterator aTrIter = myTransactions.crbegin();
960 int aNumUndo = int(myTransactions.size());
961 if (!myNestedNum.empty())
962 aNumUndo = *myNestedNum.rbegin();
963 for( ; aNumUndo > 0; aTrIter++, aNumUndo--) {
964 if (aSkipCurrent == 0) aResult.push_back(aTrIter->myId);
970 std::list<std::string> Model_Document::redoList() const
972 std::list<std::string> aResult;
973 std::list<Transaction>::const_reverse_iterator aTrIter = myRedos.crbegin();
974 for( ; aTrIter != myRedos.crend(); aTrIter++) {
975 aResult.push_back(aTrIter->myId);
980 void Model_Document::operationId(const std::string& theId)
982 myTransactions.rbegin()->myId = theId;
985 FeaturePtr Model_Document::addFeature(std::string theID, const bool theMakeCurrent)
987 std::shared_ptr<Model_Session> aSession =
988 std::dynamic_pointer_cast<Model_Session>(ModelAPI_Session::get());
989 FeaturePtr aFeature = aSession->createFeature(theID, this);
993 Model_Document* aDocToAdd;
994 if (!aFeature->documentToAdd().empty()) { // use the customized document to add
995 if (aFeature->documentToAdd() != kind()) { // the root document by default
996 aDocToAdd = std::dynamic_pointer_cast<Model_Document>(aSession->moduleDocument()).get();
1000 } else { // if customized is not presented, add to "this" document
1004 // searching for feature after which must be added the next feature: this is the current feature
1005 // but also all sub-features of this feature
1006 FeaturePtr aCurrent = aDocToAdd->currentFeature(false);
1007 bool isModified = true;
1008 for(CompositeFeaturePtr aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent);
1009 aComp.get() && isModified;
1010 aComp = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aCurrent)) {
1012 int aSubs = aComp->numberOfSubs(false);
1013 for(int a = 0; a < aSubs; a++) {
1014 FeaturePtr aSub = aComp->subFeature(a, false);
1015 if (aSub && myObjs->isLater(aSub, aCurrent)) {
1021 aDocToAdd->myObjs->addFeature(aFeature, aCurrent);
1022 if (!aFeature->isAction()) { // do not add action to the data model
1023 if (theMakeCurrent) // after all this feature stays in the document, so make it current
1024 aDocToAdd->setCurrentFeature(aFeature, false);
1025 } else { // feature must be executed
1026 // no creation event => updater not working, problem with remove part
1027 aFeature->execute();
1034 void Model_Document::refsToFeature(FeaturePtr theFeature,
1035 std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs, const bool isSendError)
1037 myObjs->refsToFeature(theFeature, theRefs, isSendError);
1040 void Model_Document::removeFeature(FeaturePtr theFeature)
1042 myObjs->removeFeature(theFeature);
1043 // fix for #2723: send signal that part is updated
1045 std::shared_ptr<Model_Document> aRoot =
1046 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument());
1047 std::list<ResultPtr> allParts;
1048 aRoot->objects()->allResults(ModelAPI_ResultPart::group(), allParts);
1049 std::list<ResultPtr>::iterator aParts = allParts.begin();
1050 for(; aParts != allParts.end(); aParts++) {
1051 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aParts);
1052 if (aPart->partDoc().get() == this) {
1053 static Events_ID anEvent = Events_Loop::eventByName(EVENT_OBJECT_UPDATED);
1054 ModelAPI_EventCreator::get()->sendUpdated(aRoot->feature(aPart), anEvent);
1061 // recursive function to check if theSub is a child of theMain composite feature
1062 // through all the hierarchy of parents
1063 static bool isSub(const CompositeFeaturePtr theMain, const FeaturePtr theSub) {
1064 CompositeFeaturePtr aParent = ModelAPI_Tools::compositeOwner(theSub);
1067 if (aParent == theMain)
1069 return isSub(theMain, aParent);
1073 void Model_Document::moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis)
1075 bool aCurrentUp = theMoved == currentFeature(false);
1077 setCurrentFeatureUp();
1079 // if user adds after high-level feature with nested,
1080 // add it after all nested (otherwise the nested will be disabled)
1081 CompositeFeaturePtr aCompositeAfter =
1082 std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theAfterThis);
1083 FeaturePtr anAfterThisSub = theAfterThis;
1084 if (aCompositeAfter.get()) {
1085 FeaturePtr aSub = aCompositeAfter;
1087 FeaturePtr aNext = myObjs->nextFeature(aSub);
1088 if (!isSub(aCompositeAfter, aNext)) {
1089 anAfterThisSub = aSub;
1093 } while (aSub.get());
1096 myObjs->moveFeature(theMoved, anAfterThisSub);
1097 if (aCurrentUp) { // make the moved feature enabled or disabled due to the real status
1098 setCurrentFeature(currentFeature(false), false);
1099 } else if (theAfterThis == currentFeature(false) || anAfterThisSub == currentFeature(false)) {
1100 // must be after move to make enabled all features which are before theMoved
1101 setCurrentFeature(theMoved, true);
1105 void Model_Document::updateHistory(const std::shared_ptr<ModelAPI_Object> theObject)
1108 myObjs->updateHistory(theObject);
1111 void Model_Document::updateHistory(const std::string theGroup)
1114 myObjs->updateHistory(theGroup);
1117 const std::set<int> Model_Document::subDocuments() const
1119 std::set<int> aResult;
1120 std::list<ResultPtr> aPartResults;
1121 myObjs->allResults(ModelAPI_ResultPart::group(), aPartResults);
1122 std::list<ResultPtr>::iterator aPartRes = aPartResults.begin();
1123 for(; aPartRes != aPartResults.end(); aPartRes++) {
1124 ResultPartPtr aPart = std::dynamic_pointer_cast<ModelAPI_ResultPart>(*aPartRes);
1125 if (aPart && aPart->isActivated()) {
1126 aResult.insert(aPart->original()->partDoc()->id());
1132 std::shared_ptr<Model_Document> Model_Document::subDoc(int theDocID)
1134 // just store sub-document identifier here to manage it later
1135 return std::dynamic_pointer_cast<Model_Document>(
1136 Model_Application::getApplication()->document(theDocID));
1139 ObjectPtr Model_Document::object(const std::string& theGroupID,
1141 const bool theAllowFolder)
1143 return myObjs->object(theGroupID, theIndex, theAllowFolder);
1146 std::shared_ptr<ModelAPI_Object> Model_Document::objectByName(
1147 const std::string& theGroupID, const std::string& theName)
1149 return myObjs->objectByName(theGroupID, theName);
1152 const int Model_Document::index(std::shared_ptr<ModelAPI_Object> theObject,
1153 const bool theAllowFolder)
1155 return myObjs->index(theObject, theAllowFolder);
1158 int Model_Document::size(const std::string& theGroupID, const bool theAllowFolder)
1160 if (myObjs == 0) // may be on close
1162 return myObjs->size(theGroupID, theAllowFolder);
1165 std::shared_ptr<ModelAPI_Object> Model_Document::parent(
1166 const std::shared_ptr<ModelAPI_Object> theChild)
1168 if(myObjs == 0) // may be on close
1170 return myObjs->parent(theChild);
1173 std::shared_ptr<ModelAPI_Feature> Model_Document::currentFeature(const bool theVisible)
1175 if (!myObjs) // on close document feature destruction it may call this method
1176 return std::shared_ptr<ModelAPI_Feature>();
1177 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1178 Handle(TDF_Reference) aRef;
1179 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1180 TDF_Label aLab = aRef->Get();
1181 FeaturePtr aResult = myObjs->feature(aLab);
1182 if (theVisible) { // get nearest visible (in history) going up
1183 while(aResult.get() && !aResult->isInHistory()) {
1184 aResult = myObjs->nextFeature(aResult, true);
1189 return std::shared_ptr<ModelAPI_Feature>(); // null feature means the higher than first
1192 void Model_Document::setCurrentFeature(
1193 std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theVisible)
1195 if (myIsSetCurrentFeature)
1197 myIsSetCurrentFeature = true;
1198 // blocks the flush signals to avoid each objects visualization in the viewer
1199 // they should not be shown once after all modifications are performed
1200 Events_Loop* aLoop = Events_Loop::loop();
1201 bool isActive = aLoop->activateFlushes(false);
1203 TDF_Label aRefLab = generalLabel().FindChild(TAG_CURRENT_FEATURE);
1204 CompositeFeaturePtr aMain; // main feature that may nest the new current
1205 std::set<FeaturePtr> anOwners; // composites that contain theCurrent (with any level of nesting)
1206 if (theCurrent.get()) {
1207 aMain = std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(theCurrent);
1208 CompositeFeaturePtr anOwner = ModelAPI_Tools::compositeOwner(theCurrent);
1209 while(anOwner.get()) {
1213 anOwners.insert(anOwner);
1214 anOwner = ModelAPI_Tools::compositeOwner(anOwner);
1218 if (theVisible && !theCurrent.get()) {
1219 // needed to avoid disabling of PartSet initial constructions
1221 theCurrent.get() ? myObjs->nextFeature(theCurrent) : myObjs->firstFeature();
1222 for (; aNext.get(); aNext = myObjs->nextFeature(theCurrent)) {
1223 if (aNext->isInHistory()) {
1224 break; // next in history is not needed
1225 } else { // next not in history is good for making current
1230 if (theCurrent.get()) {
1231 std::shared_ptr<Model_Data> aData = std::static_pointer_cast<Model_Data>(theCurrent->data());
1232 if (!aData.get() || !aData->isValid()) {
1233 aLoop->activateFlushes(isActive);
1234 myIsSetCurrentFeature = false;
1237 TDF_Label aFeatureLabel = aData->label().Father();
1239 Handle(TDF_Reference) aRef;
1240 if (aRefLab.FindAttribute(TDF_Reference::GetID(), aRef)) {
1241 aRef->Set(aFeatureLabel);
1243 aRef = TDF_Reference::Set(aRefLab, aFeatureLabel);
1245 } else { // remove reference for the null feature
1246 aRefLab.ForgetAttribute(TDF_Reference::GetID());
1248 // make all features after this feature disabled in reversed order
1249 // (to remove results without dependencies)
1250 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1252 bool aPassed = false; // flag that the current object is already passed in cycle
1253 FeaturePtr anIter = myObjs->lastFeature();
1254 bool aWasChanged = false;
1255 bool isCurrentParameter = theCurrent.get() && theCurrent->getKind() == "Parameter";
1256 for(; anIter.get(); anIter = myObjs->nextFeature(anIter, true)) {
1257 // check this before passed become enabled: the current feature is enabled!
1258 if (anIter == theCurrent) aPassed = true;
1260 bool aDisabledFlag = !aPassed;
1262 if (isSub(aMain, anIter)) // sub-elements of not-disabled feature are not disabled
1263 aDisabledFlag = false;
1264 else if (anOwners.find(anIter) != anOwners.end())
1265 // disable the higher-level feature if the nested is the current
1266 if (aMain->getKind() != "Import") // exception for the import XAO feature with Group (2430)
1267 aDisabledFlag = true;
1270 if (anIter->getKind() == "Parameter") {
1271 // parameters are always out of the history of features, but not parameters
1272 // due to the issue 1491 all parameters are kept enabled any time
1273 //if (!isCurrentParameter)
1274 aDisabledFlag = false;
1275 } else if (isCurrentParameter) {
1276 // if parameter is active, all other features become enabled (issue 1307)
1277 aDisabledFlag = false;
1280 if (anIter->setDisabled(aDisabledFlag)) {
1281 static Events_ID anUpdateEvent = aLoop->eventByName(EVENT_OBJECT_UPDATED);
1282 // state of feature is changed => so inform that it must be updated if it has such state
1283 if (!aDisabledFlag &&
1284 (anIter->data()->execState() == ModelAPI_StateMustBeUpdated ||
1285 anIter->data()->execState() == ModelAPI_StateInvalidArgument))
1286 ModelAPI_EventCreator::get()->sendUpdated(anIter, anUpdateEvent);
1287 // flush is in the end of this method
1288 ModelAPI_EventCreator::get()->sendUpdated(anIter, aRedispEvent /*, false*/);
1291 // update for everyone concealment flag immediately: on edit feature in the middle of history
1293 std::list<ResultPtr> aResults;
1294 ModelAPI_Tools::allResults(anIter, aResults);
1295 std::list<ResultPtr>::const_iterator aRes = aResults.begin();
1296 for(; aRes != aResults.end(); aRes++) {
1297 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1298 std::dynamic_pointer_cast<Model_Data>((*aRes)->data())->updateConcealmentFlag();
1300 // update the concealment status for display in isConcealed of ResultBody
1301 for(aRes = aResults.begin(); aRes != aResults.end(); aRes++) {
1302 if ((*aRes).get() && (*aRes)->data()->isValid() && !(*aRes)->isDisabled())
1303 (*aRes)->isConcealed();
1307 myIsSetCurrentFeature = false;
1308 // unblock the flush signals and up them after this
1309 aLoop->activateFlushes(isActive);
1312 void Model_Document::setCurrentFeatureUp()
1314 // on remove just go up for minimum step: highlight external objects in sketch causes
1315 // problems if it is true: here and in "setCurrentFeature"
1316 FeaturePtr aCurrent = currentFeature(false);
1317 if (aCurrent.get()) { // if not, do nothing because null is the upper
1318 FeaturePtr aPrev = myObjs->nextFeature(aCurrent, true);
1319 // make the higher level composite as current (sketch becomes disabled if line is enabled)
1321 FeaturePtr aComp = ModelAPI_Tools::compositeOwner(aPrev);
1322 // without cycle (issue 1555): otherwise extrusion fuse
1323 // will be enabled and displayed when inside sketch
1327 // do not flush: it is called only on remove, it will be flushed in the end of transaction
1328 setCurrentFeature(aPrev, false);
1332 TDF_Label Model_Document::generalLabel() const
1334 return myDoc->Main().FindChild(TAG_GENERAL);
1337 std::shared_ptr<ModelAPI_ResultConstruction> Model_Document::createConstruction(
1338 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1340 return myObjs->createConstruction(theFeatureData, theIndex);
1343 std::shared_ptr<ModelAPI_ResultBody> Model_Document::createBody(
1344 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1346 return myObjs->createBody(theFeatureData, theIndex);
1349 std::shared_ptr<ModelAPI_ResultPart> Model_Document::createPart(
1350 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1352 return myObjs->createPart(theFeatureData, theIndex);
1355 std::shared_ptr<ModelAPI_ResultPart> Model_Document::copyPart(
1356 const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
1357 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1359 return myObjs->copyPart(theOrigin, theFeatureData, theIndex);
1362 std::shared_ptr<ModelAPI_ResultGroup> Model_Document::createGroup(
1363 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1365 return myObjs->createGroup(theFeatureData, theIndex);
1368 std::shared_ptr<ModelAPI_ResultField> Model_Document::createField(
1369 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1371 return myObjs->createField(theFeatureData, theIndex);
1374 std::shared_ptr<ModelAPI_ResultParameter> Model_Document::createParameter(
1375 const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex)
1377 return myObjs->createParameter(theFeatureData, theIndex);
1380 std::shared_ptr<ModelAPI_Folder> Model_Document::addFolder(
1381 std::shared_ptr<ModelAPI_Feature> theAddBefore)
1383 return myObjs->createFolder(theAddBefore);
1386 void Model_Document::removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder)
1389 myObjs->removeFolder(theFolder);
1392 std::shared_ptr<ModelAPI_Folder> Model_Document::findFolderAbove(
1393 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures)
1395 return myObjs->findFolder(theFeatures, false);
1398 std::shared_ptr<ModelAPI_Folder> Model_Document::findFolderBelow(
1399 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures)
1401 return myObjs->findFolder(theFeatures, true);
1404 std::shared_ptr<ModelAPI_Folder> Model_Document::findContainingFolder(
1405 const std::shared_ptr<ModelAPI_Feature>& theFeature,
1406 int& theIndexInFolder)
1408 return myObjs->findContainingFolder(theFeature, theIndexInFolder);
1411 bool Model_Document::moveToFolder(
1412 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
1413 const std::shared_ptr<ModelAPI_Folder>& theFolder)
1415 return myObjs->moveToFolder(theFeatures, theFolder);
1418 bool Model_Document::removeFromFolder(
1419 const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
1420 const bool theBefore)
1422 return myObjs->removeFromFolder(theFeatures, theBefore);
1425 std::shared_ptr<ModelAPI_Feature> Model_Document::feature(
1426 const std::shared_ptr<ModelAPI_Result>& theResult)
1428 if (myObjs == 0) // may be on close
1429 return std::shared_ptr<ModelAPI_Feature>();
1430 return myObjs->feature(theResult);
1433 Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper)
1435 return TDF_LabelMapHasher::HashCode(theLab, theUpper);
1438 Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2)
1440 return TDF_LabelMapHasher::IsEqual(theLab1, theLab2);
1443 FeaturePtr Model_Document::featureByLab(const TDF_Label& theLab) {
1444 TDF_Label aCurrentLab = theLab;
1445 while(aCurrentLab.Depth() > 3)
1446 aCurrentLab = aCurrentLab.Father();
1447 return myObjs->feature(aCurrentLab);
1450 ResultPtr Model_Document::resultByLab(const TDF_Label& theLab)
1452 TDF_Label aCurrentLab = theLab;
1453 while(aCurrentLab.Depth() > 3) {
1454 ObjectPtr aResultObj = myObjs->object(aCurrentLab);
1455 if (aResultObj.get()) {
1456 return std::dynamic_pointer_cast<ModelAPI_Result>(aResultObj); // this may be null if feature
1458 aCurrentLab = aCurrentLab.Father();
1460 return ResultPtr(); // not found
1464 void Model_Document::addNamingName(const TDF_Label theLabel, std::string theName)
1466 std::map<std::string, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(theName);
1468 if (aFind != myNamingNames.end()) { // to avoid duplicate-labels
1469 // to keep correct order in spite of history line management
1470 std::list<TDF_Label>::iterator anAddAfterThis = aFind->second.end();
1471 FeaturePtr anAddedFeature = featureByLab(theLabel);
1472 std::list<TDF_Label>::iterator aLabIter = aFind->second.begin();
1473 while(aLabIter != aFind->second.end()) {
1474 if (theLabel.IsEqual(*aLabIter)) {
1475 std::list<TDF_Label>::iterator aTmpIter = aLabIter;
1477 aFind->second.erase(aTmpIter);
1479 FeaturePtr aCurFeature = featureByLab(*aLabIter);
1480 if (aCurFeature.get() && anAddedFeature.get() &&
1481 myObjs->isLater(anAddedFeature, aCurFeature))
1482 anAddAfterThis = aLabIter;
1487 if (anAddAfterThis != aFind->second.end()) {
1489 if (anAddAfterThis != aFind->second.end()) {
1490 myNamingNames[theName].insert(anAddAfterThis, theLabel); // inserts before anAddAfterThis
1495 myNamingNames[theName].push_back(theLabel);
1498 void Model_Document::changeNamingName(const std::string theOldName,
1499 const std::string theNewName,
1500 const TDF_Label& theLabel)
1502 std::map<std::string, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(theOldName);
1503 if (aFind != myNamingNames.end()) {
1504 std::list<TDF_Label>::iterator aLabIter = aFind->second.begin();
1505 for(; aLabIter != aFind->second.end(); aLabIter++) {
1506 if (theLabel.IsEqual(*aLabIter)) { // found the label
1507 myNamingNames[theNewName].push_back(theLabel);
1508 if (aFind->second.size() == 1) { // only one element, so, just change the name
1509 myNamingNames.erase(theOldName);
1510 } else { // remove from the list
1511 aFind->second.erase(aLabIter);
1513 // check the sketch vertex name located under renamed sketch line
1514 TDF_ChildIDIterator aChild(theLabel, TDataStd_Name::GetID());
1515 for(; aChild.More(); aChild.Next()) {
1516 Handle(TDataStd_Name) aSubName = Handle(TDataStd_Name)::DownCast(aChild.Value());
1517 std::string aName = TCollection_AsciiString(aSubName->Get()).ToCString();
1518 if (aName.find(theOldName) == 0) { // started from parent name
1519 std::string aNewSubName = theNewName + aName.substr(theNewName.size());
1520 changeNamingName(aName, aNewSubName, aSubName->Label());
1521 aSubName->Set(aNewSubName.c_str());
1530 TDF_Label Model_Document::findNamingName(std::string theName, ResultPtr theContext)
1532 std::map<std::string, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(theName);
1533 if (aFind != myNamingNames.end()) {
1534 std::list<TDF_Label>::reverse_iterator aLabIter = aFind->second.rbegin();
1535 for(; aLabIter != aFind->second.rend(); aLabIter++) {
1536 if (theContext.get()) {
1537 // context is defined and not like this, so, skip
1538 if (theContext == myObjs->object(aLabIter->Father()))
1542 return *(aFind->second.rbegin()); // no more variants, so, return the last
1544 // not found exact name, try to find by sub-components
1545 std::string::size_type aSlash = theName.rfind('/');
1546 if (aSlash != std::string::npos) {
1547 std::string anObjName = theName.substr(0, aSlash);
1548 aFind = myNamingNames.find(anObjName);
1549 if (aFind != myNamingNames.end()) {
1550 TCollection_ExtendedString aSubName(theName.substr(aSlash + 1).c_str());
1551 // iterate all possible same-named labels starting from the last one (the recent)
1552 std::list<TDF_Label>::reverse_iterator aLabIter = aFind->second.rbegin();
1553 for(; aLabIter != aFind->second.rend(); aLabIter++) {
1554 if (theContext.get()) {
1555 // context is defined and not like this, so, skip
1556 if (theContext != myObjs->object(aLabIter->Father()))
1559 // copy aSubName to avoid incorrect further processing after its suffix cutting
1560 TCollection_ExtendedString aSubNameCopy(aSubName);
1561 // searching sub-labels with this name
1562 TDF_ChildIDIterator aNamesIter(*aLabIter, TDataStd_Name::GetID(), Standard_True);
1563 for(; aNamesIter.More(); aNamesIter.Next()) {
1564 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1565 if (aName->Get() == aSubNameCopy)
1566 return aName->Label();
1568 // If not found child label with the exact sub-name, then try to find compound with
1569 // such sub-name without suffix.
1570 Standard_Integer aSuffixPos = aSubNameCopy.SearchFromEnd('_');
1571 if (aSuffixPos != -1 && aSuffixPos != aSubNameCopy.Length()) {
1572 TCollection_ExtendedString anIndexStr = aSubNameCopy.Split(aSuffixPos);
1573 aSubNameCopy.Remove(aSuffixPos);
1574 aNamesIter.Initialize(*aLabIter, TDataStd_Name::GetID(), Standard_True);
1575 for(; aNamesIter.More(); aNamesIter.Next()) {
1576 Handle(TDataStd_Name) aName = Handle(TDataStd_Name)::DownCast(aNamesIter.Value());
1577 if (aName->Get() == aSubNameCopy) {
1578 return aName->Label();
1581 // check also "this" label
1582 Handle(TDataStd_Name) aName;
1583 if (aLabIter->FindAttribute(TDataStd_Name::GetID(), aName)) {
1584 if (aName->Get() == aSubNameCopy) {
1585 return aName->Label();
1590 // verify context's name is same as sub-component's and use context's label
1591 if (aSubName.IsEqual(anObjName.c_str()))
1592 return *(aFind->second.rbegin());
1595 return TDF_Label(); // not found
1598 bool Model_Document::isLaterByDep(FeaturePtr theThis, FeaturePtr theOther) {
1599 // check dependencies first: if theOther depends on theThis, theThis is not later
1600 std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > > aRefs;
1601 theOther->data()->referencesToObjects(aRefs);
1602 std::list<std::pair<std::string, std::list<std::shared_ptr<ModelAPI_Object> > > >::iterator
1603 aRefIt = aRefs.begin();
1604 for(; aRefIt != aRefs.end(); aRefIt++) {
1605 std::list<ObjectPtr>::iterator aRefObjIt = aRefIt->second.begin();
1606 for(; aRefObjIt != aRefIt->second.end(); aRefObjIt++) {
1607 ObjectPtr aRefObj = *aRefObjIt;
1608 if (aRefObj.get()) {
1609 FeaturePtr aRefFeat = std::dynamic_pointer_cast<ModelAPI_Feature>(aRefObj);
1610 if (!aRefFeat.get()) { // take feature of the result
1611 aRefFeat = feature(std::dynamic_pointer_cast<ModelAPI_Result>(aRefObj));
1613 if (aRefFeat.get()) {
1614 if (aRefFeat == theThis)
1615 return false; // other references to this, so other later than this
1616 if (std::dynamic_pointer_cast<ModelAPI_CompositeFeature>(aRefFeat)) {
1617 if (!isLaterByDep(theThis, aRefFeat)) // nested composites: recursion
1624 return myObjs->isLater(theThis, theOther);
1627 int Model_Document::numberOfNameInHistory(
1628 const ObjectPtr& theNameObject, const TDF_Label& theStartFrom)
1630 std::map<std::string, std::list<TDF_Label> >::iterator aFind =
1631 myNamingNames.find(theNameObject->data()->name());
1632 if (aFind == myNamingNames.end() || aFind->second.size() < 2) {
1633 return 1; // no need to specify the name by additional identifiers
1635 // get the feature of the object for relative compare
1636 FeaturePtr aStart = myObjs->feature(theStartFrom);
1637 if (!aStart.get()) // strange, but can not find feature by the label
1639 // feature that contain result with this name
1640 FeaturePtr aNameFeature;
1641 ResultPtr aNameResult = std::dynamic_pointer_cast<ModelAPI_Result>(theNameObject);
1643 aNameFeature = myObjs->feature(aNameResult);
1645 aNameFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(theNameObject);
1646 // iterate all labels with this name to find the nearest just before or equal relative
1647 std::list<TDF_Label>::reverse_iterator aLabIter = aFind->second.rbegin();
1648 for(; aLabIter != aFind->second.rend(); aLabIter++) {
1649 FeaturePtr aLabFeat = featureByLab(*aLabIter);
1650 if (!aLabFeat.get())
1652 if (isLaterByDep(aStart, aLabFeat)) // skip also start: its result don't used
1656 for(; aLabIter != aFind->second.rend(); aLabIter++) {
1657 FeaturePtr aLabFeat = featureByLab(*aLabIter);
1658 if (!aLabFeat.get())
1660 if (aLabFeat == aNameFeature || isLaterByDep(aNameFeature, aLabFeat))
1664 return aResIndex; // strange
1667 ResultPtr Model_Document::findByName(
1668 std::string& theName, std::string& theSubShapeName, bool& theUniqueContext)
1670 int aNumInHistory = 0;
1671 std::string aName = theName;
1672 ResultPtr aRes = myObjs->findByName(aName);
1673 theUniqueContext = !(aRes.get() && myNamingNames.find(aName) != myNamingNames.end());
1674 while(!aRes.get() && aName[0] == '_') { // this may be theContext with the history index
1676 aName = aName.substr(1);
1677 aRes = myObjs->findByName(aName);
1679 if (aNumInHistory) {
1680 std::map<std::string, std::list<TDF_Label> >::iterator aFind = myNamingNames.find(aName);
1681 if (aFind != myNamingNames.end() && aFind->second.size() > aNumInHistory) {
1682 std::list<TDF_Label>::reverse_iterator aLibIt = aFind->second.rbegin();
1683 for(; aNumInHistory != 0; aNumInHistory--)
1685 const TDF_Label& aResultLab = *aLibIt;
1686 aRes = std::dynamic_pointer_cast<ModelAPI_Result>(myObjs->object(aResultLab.Father()));
1687 if (aRes) { // modify the incoming names
1688 if (!theSubShapeName.empty())
1689 theSubShapeName = theSubShapeName.substr(theName.size() - aName.size());
1697 std::list<std::shared_ptr<ModelAPI_Feature> > Model_Document::allFeatures()
1699 return myObjs->allFeatures();
1702 std::list<std::shared_ptr<ModelAPI_Object> > Model_Document::allObjects()
1704 return myObjs->allObjects();
1707 void Model_Document::setActive(const bool theFlag)
1709 if (theFlag != myIsActive) {
1710 myIsActive = theFlag;
1711 // redisplay all the objects of this part
1712 static Events_Loop* aLoop = Events_Loop::loop();
1713 static Events_ID aRedispEvent = aLoop->eventByName(EVENT_OBJECT_TO_REDISPLAY);
1715 for(int a = size(ModelAPI_Feature::group()) - 1; a >= 0; a--) {
1716 FeaturePtr aFeature = std::dynamic_pointer_cast<ModelAPI_Feature>(
1717 object(ModelAPI_Feature::group(), a));
1718 if (aFeature.get() && aFeature->data()->isValid()) {
1719 std::list<ResultPtr> aResults;
1720 ModelAPI_Tools::allResults(aFeature, aResults);
1721 for (std::list<ResultPtr>::iterator aRes = aResults.begin();
1722 aRes != aResults.end(); aRes++) {
1723 ModelAPI_EventCreator::get()->sendUpdated(*aRes, aRedispEvent);
1730 bool Model_Document::isActive() const
1735 int Model_Document::transactionID()
1737 Handle(TDataStd_Integer) anIndex;
1738 if (!generalLabel().FindChild(TAG_CURRENT_TRANSACTION).
1739 FindAttribute(TDataStd_Integer::GetID(), anIndex)) {
1740 anIndex = TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), 1);
1742 return anIndex->Get();
1745 void Model_Document::incrementTransactionID()
1747 int aNewVal = transactionID() + 1;
1748 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1750 void Model_Document::decrementTransactionID()
1752 int aNewVal = transactionID() - 1;
1753 TDataStd_Integer::Set(generalLabel().FindChild(TAG_CURRENT_TRANSACTION), aNewVal);
1756 TDF_Label Model_Document::extConstructionsLabel() const
1758 return myDoc->Main().FindChild(TAG_EXTERNAL_CONSTRUCTIONS);
1761 bool Model_Document::isOpened()
1763 return myObjs && !myDoc.IsNull();
1766 int Model_Document::numInternalFeatures()
1768 return myObjs->numInternalFeatures();
1771 std::shared_ptr<ModelAPI_Feature> Model_Document::internalFeature(const int theIndex)
1773 return myObjs->internalFeature(theIndex);
1776 std::shared_ptr<ModelAPI_Feature> Model_Document::featureById(const int theId)
1778 return myObjs->featureById(theId);
1781 void Model_Document::synchronizeTransactions()
1783 Model_Document* aRoot =
1784 std::dynamic_pointer_cast<Model_Document>(ModelAPI_Session::get()->moduleDocument()).get();
1786 return; // don't need to synchronize root with root
1788 std::shared_ptr<Model_Session> aSession =
1789 std::dynamic_pointer_cast<Model_Session>(Model_Session::get());
1790 while(myRedos.size() > aRoot->myRedos.size()) { // remove redo in this
1791 aSession->setCheckTransactions(false);
1793 aSession->setCheckTransactions(true);
1795 /* this case can not be reproduced in any known case for the current moment, so, just comment
1796 while(myRedos.size() < aRoot->myRedos.size()) { // add more redo in this
1797 undoInternal(false, true);
1801 /// Feature that is used for selection in the Part document by the external request
1802 class Model_SelectionInPartFeature : public ModelAPI_Feature {
1804 /// Nothing to do in constructor
1805 Model_SelectionInPartFeature() : ModelAPI_Feature() {}
1807 /// Returns the unique kind of a feature
1808 virtual const std::string& getKind() {
1809 static std::string MY_KIND("InternalSelectionInPartFeature");
1812 /// Request for initialization of data model of the object: adding all attributes
1813 virtual void initAttributes() {
1814 data()->addAttribute("selection", ModelAPI_AttributeSelectionList::typeId());
1816 /// Nothing to do in the execution function
1817 virtual void execute() {}
1821 //! Returns the feature that is used for calculation of selection externally from the document
1822 AttributeSelectionListPtr Model_Document::selectionInPartFeature()
1824 // return already created, otherwise create
1825 if (!mySelectionFeature.get() || !mySelectionFeature->data()->isValid()) {
1827 mySelectionFeature = FeaturePtr(new Model_SelectionInPartFeature);
1829 TDF_Label aFeatureLab = generalLabel().FindChild(TAG_SELECTION_FEATURE);
1830 std::shared_ptr<Model_Data> aData(new Model_Data);
1831 aData->setLabel(aFeatureLab.FindChild(1));
1832 aData->setObject(mySelectionFeature);
1833 mySelectionFeature->setDoc(myObjs->owner());
1834 mySelectionFeature->setData(aData);
1835 std::string aName = id() + "_Part";
1836 mySelectionFeature->data()->setName(aName);
1837 mySelectionFeature->setDoc(myObjs->owner());
1838 mySelectionFeature->initAttributes();
1839 mySelectionFeature->init(); // to make it enabled and Update correctly
1840 // this update may cause recomputation of the part after selection on it, that is not needed
1841 mySelectionFeature->data()->blockSendAttributeUpdated(true);
1843 return mySelectionFeature->selectionList("selection");
1846 FeaturePtr Model_Document::lastFeature()
1849 return myObjs->lastFeature();
1850 return FeaturePtr();
1853 static Handle(TNaming_NamedShape) searchForOriginalShape(TopoDS_Shape theShape, TDF_Label aMain) {
1854 Handle(TNaming_NamedShape) aResult;
1855 while(!theShape.IsNull()) { // searching for the very initial shape that produces this one
1856 TopoDS_Shape aShape = theShape;
1858 // to avoid crash of TNaming_SameShapeIterator if pure shape does not exists
1859 if (!TNaming_Tool::HasLabel(aMain, aShape))
1861 for(TNaming_SameShapeIterator anIter(aShape, aMain); anIter.More(); anIter.Next()) {
1862 TDF_Label aNSLab = anIter.Label();
1863 Handle(TNaming_NamedShape) aNS;
1864 if (aNSLab.FindAttribute(TNaming_NamedShape::GetID(), aNS)) {
1865 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1866 if (aShapesIter.Evolution() == TNaming_SELECTED ||
1867 aShapesIter.Evolution() == TNaming_DELETE)
1868 continue; // don't use the selection evolution
1869 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1871 if (aResult->Evolution() == TNaming_MODIFY)
1872 theShape = aShapesIter.OldShape();
1873 // otherwise may me searching for another item of this shape with longer history
1874 if (!theShape.IsNull())
1884 std::shared_ptr<ModelAPI_Feature> Model_Document::producedByFeature(
1885 std::shared_ptr<ModelAPI_Result> theResult,
1886 const std::shared_ptr<GeomAPI_Shape>& theShape)
1888 ResultBodyPtr aBody = std::dynamic_pointer_cast<ModelAPI_ResultBody>(theResult);
1890 return feature(theResult); // for not-body just returns the feature that produced this result
1892 // otherwise get the shape and search the very initial label for it
1893 TopoDS_Shape aShape = theShape->impl<TopoDS_Shape>();
1894 if (aShape.IsNull())
1895 return FeaturePtr();
1897 // for compsolids and compounds all the naming is located in the main object, so, try to use
1899 ResultBodyPtr aMain = ModelAPI_Tools::bodyOwner(theResult);
1900 while (aMain.get()) { // get the top-most main
1901 ResultBodyPtr aNextMain = ModelAPI_Tools::bodyOwner(aMain);
1902 if (aNextMain.get())
1907 FeaturePtr aMainRes = producedByFeature(aMain, theShape);
1912 std::shared_ptr<Model_Data> aBodyData = std::dynamic_pointer_cast<Model_Data>(theResult->data());
1913 if (!aBodyData.get() || !aBodyData->isValid())
1914 return FeaturePtr();
1916 TopoDS_Shape anOldShape; // old shape in the pair old shape->theShape in the named shape
1917 TopoDS_Shape aShapeContainer; // old shape of the shape that contains aShape as sub-element
1918 Handle(TNaming_NamedShape) aCandidatInThis, aCandidatContainer;
1919 TDF_Label aBodyLab = aBodyData->shapeLab();
1920 // use child and this label (the lowest priority)
1921 TDF_ChildIDIterator aNSIter(aBodyLab, TNaming_NamedShape::GetID(), Standard_True);
1922 bool aUseThis = !aNSIter.More();
1923 while(anOldShape.IsNull() && (aNSIter.More() || aUseThis)) {
1924 Handle(TNaming_NamedShape) aNS;
1926 if (!aBodyLab.FindAttribute(TNaming_NamedShape::GetID(), aNS))
1929 aNS = Handle(TNaming_NamedShape)::DownCast(aNSIter.Value());
1931 for(TNaming_Iterator aShapesIter(aNS); aShapesIter.More(); aShapesIter.Next()) {
1932 if (aShapesIter.Evolution() == TNaming_SELECTED || aShapesIter.Evolution() == TNaming_DELETE)
1933 continue; // don't use the selection evolution
1934 if (aShapesIter.NewShape().IsSame(aShape)) { // found the original shape
1935 aCandidatInThis = aNS;
1936 if (aCandidatInThis->Evolution() == TNaming_MODIFY)
1937 anOldShape = aShapesIter.OldShape();
1938 // otherwise may me searching for another item of this shape with longer history
1939 if (!anOldShape.IsNull())
1942 // check that the shape contains aShape as sub-shape to fill container
1943 if (aShapesIter.NewShape().ShapeType() < aShape.ShapeType() && aCandidatContainer.IsNull()) {
1944 TopExp_Explorer anExp(aShapesIter.NewShape(), aShape.ShapeType());
1945 for(; anExp.More(); anExp.Next()) {
1946 if (aShape.IsSame(anExp.Current())) {
1947 aCandidatContainer = aNS;
1948 aShapeContainer = aShapesIter.NewShape();
1953 // iterate to the next label or to the body label in the end
1956 if (!aNSIter.More()) {
1962 if (aCandidatInThis.IsNull()) {
1963 // to fix 1512: searching for original shape of this shape
1964 // if modification of it is not in this result
1965 aCandidatInThis = searchForOriginalShape(aShape, myDoc->Main());
1966 if (aCandidatInThis.IsNull()) {
1967 if (aCandidatContainer.IsNull())
1968 return FeaturePtr();
1969 // with the lower priority use the higher level shape that contains aShape
1970 aCandidatInThis = aCandidatContainer;
1971 anOldShape = aShapeContainer;
1973 // to stop the searching by the following searchForOriginalShape
1974 anOldShape.Nullify();
1978 Handle(TNaming_NamedShape) aNS = searchForOriginalShape(anOldShape, myDoc->Main());
1980 aCandidatInThis = aNS;
1983 TDF_Label aResultLab = aCandidatInThis->Label();
1984 while(aResultLab.Depth() > 3)
1985 aResultLab = aResultLab.Father();
1986 FeaturePtr aFeature = myObjs->feature(aResultLab);
1987 if (aFeature.get()) {
1988 if (!aResult.get() || myObjs->isLater(aResult, aFeature)) {
1995 bool Model_Document::isLater(FeaturePtr theLater, FeaturePtr theCurrent) const
1997 return myObjs->isLater(theLater, theCurrent);
2000 void Model_Document::storeNodesState(const std::list<bool>& theStates)
2002 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
2003 aLab.ForgetAllAttributes();
2004 if (!theStates.empty()) {
2005 Handle(TDataStd_BooleanArray) anArray =
2006 TDataStd_BooleanArray::Set(aLab, 0, int(theStates.size()) - 1);
2007 std::list<bool>::const_iterator aState = theStates.begin();
2008 for(int anIndex = 0; aState != theStates.end(); aState++, anIndex++) {
2009 anArray->SetValue(anIndex, *aState);
2014 void Model_Document::restoreNodesState(std::list<bool>& theStates) const
2016 TDF_Label aLab = generalLabel().FindChild(TAG_NODES_STATE);
2017 Handle(TDataStd_BooleanArray) anArray;
2018 if (aLab.FindAttribute(TDataStd_BooleanArray::GetID(), anArray)) {
2019 int anUpper = anArray->Upper();
2020 for(int anIndex = 0; anIndex <= anUpper; anIndex++) {
2021 theStates.push_back(anArray->Value(anIndex) == Standard_True);
2026 void Model_Document::eraseAllFeatures()
2029 myObjs->eraseAllFeatures();
2032 void Model_Document::setExecuteFeatures(const bool theFlag)
2034 myExecuteFeatures = theFlag;
2035 const std::set<int> aSubs = subDocuments();
2036 std::set<int>::iterator aSubIter = aSubs.begin();
2037 for (; aSubIter != aSubs.end(); aSubIter++) {
2038 if (!subDoc(*aSubIter)->myObjs)
2040 subDoc(*aSubIter)->setExecuteFeatures(theFlag);
2044 void Model_Document::appendTransactionToPrevious()
2046 Transaction anAppended = myTransactions.back();
2047 myTransactions.pop_back();
2048 if (!myTransactions.empty()) { // if it is empty, just forget the appended
2049 myTransactions.back().myOCAFNum += anAppended.myOCAFNum;
2051 // propagate the same action to sub-documents
2052 const std::set<int> aSubs = subDocuments();
2053 for (std::set<int>::iterator aSubIter = aSubs.begin(); aSubIter != aSubs.end(); aSubIter++) {
2054 subDoc(*aSubIter)->appendTransactionToPrevious();
2058 /// GUID for keeping information about the auto-recomputation state
2059 static const Standard_GUID kAutoRecomputationID("8493fb74-0674-4912-a100-1cf46c7cfab3");
2061 void Model_Document::setAutoRecomutationState(const bool theState)
2064 generalLabel().FindChild(TAG_CURRENT_TRANSACTION).ForgetAttribute(kAutoRecomputationID);
2066 TDataStd_UAttribute::Set(
2067 generalLabel().FindChild(TAG_CURRENT_TRANSACTION), kAutoRecomputationID);
2070 bool Model_Document::autoRecomutationState() const
2072 return !generalLabel().FindChild(TAG_CURRENT_TRANSACTION).IsAttribute(kAutoRecomputationID);