1 // Created on: 2000-08-03
2 // Created by: data exchange team
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <XCAFDoc_ShapeTool.hxx>
18 #include <BRep_Builder.hxx>
20 #include <gp_Trsf.hxx>
21 #include <Standard_GUID.hxx>
22 #include <Standard_Type.hxx>
23 #include <TCollection_AsciiString.hxx>
24 #include <TCollection_ExtendedString.hxx>
25 #include <TCollection_HAsciiString.hxx>
26 #include <TColStd_SequenceOfHAsciiString.hxx>
27 #include <TDataStd_ChildNodeIterator.hxx>
28 #include <TDataStd_Name.hxx>
29 #include <TDataStd_TreeNode.hxx>
30 #include <TDataStd_UAttribute.hxx>
31 #include <TDF_Attribute.hxx>
32 #include <TDF_ChildIDIterator.hxx>
33 #include <TDF_ChildIterator.hxx>
34 #include <TDF_Label.hxx>
35 #include <TDF_LabelMap.hxx>
36 #include <TDF_LabelSequence.hxx>
37 #include <TDF_MapIteratorOfLabelMap.hxx>
38 #include <TDF_RelocationTable.hxx>
39 #include <TDF_Tool.hxx>
40 #include <TDocStd_Document.hxx>
41 #include <TNaming_Builder.hxx>
42 #include <TNaming_NamedShape.hxx>
43 #include <TNaming_Tool.hxx>
44 #include <TopLoc_IndexedMapOfLocation.hxx>
45 #include <TopLoc_Location.hxx>
46 #include <TopoDS_Compound.hxx>
47 #include <TopoDS_Iterator.hxx>
48 #include <TopoDS_Shape.hxx>
49 #include <TopTools_ListOfShape.hxx>
50 #include <TopTools_MapOfOrientedShape.hxx>
51 #include <XCAFDoc.hxx>
52 #include <XCAFDoc_GraphNode.hxx>
53 #include <XCAFDoc_Location.hxx>
54 #include <XCAFDoc_ShapeMapTool.hxx>
56 IMPLEMENT_STANDARD_RTTIEXT(XCAFDoc_ShapeTool,TDF_Attribute)
58 static Standard_Boolean theAutoNaming = Standard_True;
60 // attribute methods //////////////////////////////////////////////////
62 //=======================================================================
65 //=======================================================================
67 const Standard_GUID& XCAFDoc_ShapeTool::GetID()
69 static Standard_GUID ShapeToolID ("efd212ee-6dfd-11d4-b9c8-0060b0ee281b");
74 //=======================================================================
77 //=======================================================================
79 Handle(XCAFDoc_ShapeTool) XCAFDoc_ShapeTool::Set(const TDF_Label& L)
81 Handle(XCAFDoc_ShapeTool) A;
82 if (!L.FindAttribute (XCAFDoc_ShapeTool::GetID(), A)) {
83 A = new XCAFDoc_ShapeTool ();
91 //=======================================================================
92 //function : Constructor
94 //=======================================================================
96 XCAFDoc_ShapeTool::XCAFDoc_ShapeTool()
98 hasSimpleShapes = Standard_False;
102 //=======================================================================
105 //=======================================================================
107 const Standard_GUID& XCAFDoc_ShapeTool::ID() const
112 //=======================================================================
115 //=======================================================================
117 void XCAFDoc_ShapeTool::Restore(const Handle(TDF_Attribute)& /*with*/)
121 //=======================================================================
122 //function : NewEmpty
124 //=======================================================================
126 Handle(TDF_Attribute) XCAFDoc_ShapeTool::NewEmpty() const
128 return new XCAFDoc_ShapeTool;
131 //=======================================================================
134 //=======================================================================
136 void XCAFDoc_ShapeTool::Paste (const Handle(TDF_Attribute)& /*into*/,
137 const Handle(TDF_RelocationTable)& /*RT*/) const
141 // Auxiliary methods //////////////////////////////////////////////////
143 //=======================================================================
144 //function : SetLabelNameByLink
146 //=======================================================================
147 static void SetLabelNameByLink(const TDF_Label L)
149 Handle(TDataStd_TreeNode) Node;
150 if (! L.FindAttribute(XCAFDoc::ShapeRefGUID(), Node) ||
151 ! Node->HasFather()) {
153 std::cout<<"Error: XCAFDoc_ShapeTool, SetLabelNameByLink(): NO NODE"<<std::endl;
157 TCollection_AsciiString Entry;
158 TDF_Tool::Entry ( Node->Father()->Label(), Entry );
159 Entry.Insert(1, "=>[");
162 TDataStd_Name::Set(L, TCollection_ExtendedString( Entry ));
166 //=======================================================================
167 //function : SetLabelNameByShape
169 //=======================================================================
170 static void SetLabelNameByShape(const TDF_Label L)
173 if (XCAFDoc_ShapeTool::GetShape(L, S) &&
174 ! L.IsAttribute(TDataStd_Name::GetID()) ) {
175 Standard_SStream Stream;
176 // TopAbs_ShapeEnum Type = S.ShapeType();
177 // if (Type == TopAbs_COMPOUND) Stream<<"ASSEMBLY";
179 TopAbs::Print(S.ShapeType(), Stream);
180 TCollection_AsciiString aName (Stream.str().c_str());
181 TDataStd_Name::Set(L, TCollection_ExtendedString(aName));
186 //=======================================================================
187 //function : SearchUsingMap
189 //=======================================================================
191 Standard_Boolean XCAFDoc_ShapeTool::SearchUsingMap(const TopoDS_Shape &S, TDF_Label &L,
192 const Standard_Boolean findWithoutLoc,
193 const Standard_Boolean findSubShape) const
196 if(myShapeLabels.IsBound(S)) {
197 L = myShapeLabels.Find(S);
198 return Standard_True;
203 if(myShapeLabels.IsBound(S0)) {
204 TDF_Label L1 = myShapeLabels.Find(S0);
205 TDF_LabelSequence Labels;
206 if(GetUsers(L1, Labels, Standard_True)) {
207 for(Standard_Integer i=1; i<=Labels.Length(); i++) {
208 TopoDS_Shape c = GetShape(Labels.Value(i));
211 return Standard_True;
217 return Standard_True;
221 if(hasSimpleShapes) {
222 if(mySimpleShapes.IsBound(S)) {
223 L = mySimpleShapes.Find(S);
224 return Standard_True;
226 if(mySimpleShapes.IsBound(S0)) {
227 L = mySimpleShapes.Find(S0);
228 return Standard_True;
232 if(!findSubShape) return Standard_False;
233 TDF_Label mainL = FindMainShapeUsingMap(S);
234 if(mainL.IsNull()) return Standard_False;
235 L = AddSubShape(mainL,S);
236 return !L.IsNull();//Standard_True;
240 //=======================================================================
243 //=======================================================================
245 Standard_Boolean XCAFDoc_ShapeTool::Search (const TopoDS_Shape &S,
247 const Standard_Boolean findInstance,
248 const Standard_Boolean findComponent,
249 const Standard_Boolean findSubShape) const
251 // search among shapes
252 Standard_Boolean isLocated = ! S.Location().IsIdentity();
255 // try to find top-level instance
256 if ( findInstance && FindShape ( S, L, Standard_True ) )
257 return Standard_True;
258 // try to find component of assembly
259 if ( findComponent ) {
260 TDF_LabelSequence labels;
261 GetShapes ( labels );
262 for ( Standard_Integer i=1; i <= labels.Length(); i++ ) {
263 if ( ! IsAssembly ( labels.Value(i) ) ) continue;
264 TDF_LabelSequence comp;
265 GetComponents ( labels.Value(i), comp );
266 for ( Standard_Integer j=1; j <= comp.Length(); j++ ) {
267 TopoDS_Shape c = GetShape ( comp.Value(j) );
268 if ( c.IsSame ( S ) ) {
270 return Standard_True;
276 // try to find top-level simple shape
277 if ( FindShape ( S, L, Standard_False ) ) return Standard_True;
280 if ( ! findSubShape ) return Standard_False;
281 TDF_Label mainL = FindMainShape ( S );
282 if ( mainL.IsNull() ) return Standard_False;
283 L = AddSubShape ( mainL, S );
284 return !L.IsNull();//Standard_True;
287 //=======================================================================
288 //function : FindShape
290 //=======================================================================
292 Standard_Boolean XCAFDoc_ShapeTool::FindShape (const TopoDS_Shape& S,
294 const Standard_Boolean findInstance) const
296 // search for null-located shape
298 if ( ! findInstance ) {
303 // this code is used instead of the following for performance reasons
304 if (TNaming_Tool::HasLabel(Label(), S0)) {
306 L = TNaming_Tool::Label(Label(), S0, TransDef);
309 return Standard_False;
312 return Standard_True;
314 // Try to find shape manually
315 TDF_ChildIDIterator it(Label(), TNaming_NamedShape::GetID());
316 for (; it.More(); it.Next()) {
317 TDF_Label aLabel = it.Value()->Label();
318 Handle(TNaming_NamedShape) NS;
319 if ( aLabel.FindAttribute(TNaming_NamedShape::GetID(), NS) &&
320 S0.IsSame ( TNaming_Tool::GetShape(NS) ) ) {
322 return Standard_True;
327 return Standard_False;
330 //=======================================================================
331 //function : FindShape
333 //=======================================================================
335 TDF_Label XCAFDoc_ShapeTool::FindShape (const TopoDS_Shape& S,
336 const Standard_Boolean findInstance) const
339 if (FindShape(S, L, findInstance))
344 //=======================================================================
345 //function : GetShape
347 //=======================================================================
349 Standard_Boolean XCAFDoc_ShapeTool::GetShape (const TDF_Label& L, TopoDS_Shape& S)
351 Handle(XCAFDoc_Location) LocationAttribute;
354 TopoDS_Compound EmptyComp;
356 B.MakeCompound(EmptyComp);
360 // for instance, get referred shape
361 Handle(TDataStd_TreeNode) Node;
362 if ( L.FindAttribute(XCAFDoc::ShapeRefGUID(), Node) && Node->HasFather() &&
363 L.FindAttribute(XCAFDoc_Location::GetID(), LocationAttribute)) {
364 if ( ! GetShape(Node->Father()->Label(), S) ) return Standard_False;
365 S.Move ( LocationAttribute->Get() );
366 return Standard_True;
369 // else just return shape on this label
370 Handle(TNaming_NamedShape) NS;
371 if ( ! L.FindAttribute(TNaming_NamedShape::GetID(), NS) ) return Standard_False;
372 S = TNaming_Tool::GetShape(NS);
373 return Standard_True;
376 //=======================================================================
377 //function : GetShape
379 //=======================================================================
381 TopoDS_Shape XCAFDoc_ShapeTool::GetShape(const TDF_Label& L)
388 //=======================================================================
389 //function : NewShape
391 //=======================================================================
393 TDF_Label XCAFDoc_ShapeTool::NewShape() const
395 TopoDS_Compound aShape;
397 tdsB.MakeCompound ( aShape );
400 TDF_Label aLabel = aTag.NewChild(Label());
402 TNaming_Builder tnBuild(aLabel);
403 tnBuild.Generated(aShape);
408 //=======================================================================
409 //function : SetShape
411 //=======================================================================
413 void XCAFDoc_ShapeTool::SetShape (const TDF_Label& L, const TopoDS_Shape& S)
415 TNaming_Builder tnBuild(L);
416 tnBuild.Generated(S);
417 Handle(XCAFDoc_ShapeMapTool) A = XCAFDoc_ShapeMapTool::Set(L);
418 // if ( ! L.FindAttribute(XCAFDoc_ShapeMapTool::GetID(), A) ) {
419 // A = XCAFDoc_ShapeMapTool::Set(L);
420 // L.AddAttribute(A);
424 if(!myShapeLabels.IsBound(S)) {
425 myShapeLabels.Bind(S,L);
429 //=======================================================================
430 //function : MakeReference
432 //=======================================================================
434 void XCAFDoc_ShapeTool::MakeReference (const TDF_Label &L,
435 const TDF_Label &refL,
436 const TopLoc_Location &loc)
439 XCAFDoc_Location::Set(L, loc);
442 Handle(TDataStd_TreeNode) refNode, mainNode;
443 mainNode = TDataStd_TreeNode::Set ( refL, XCAFDoc::ShapeRefGUID() );
444 refNode = TDataStd_TreeNode::Set ( L, XCAFDoc::ShapeRefGUID() );
445 refNode->Remove(); // abv: fix against bug in TreeNode::Append()
446 mainNode->Append(refNode);
449 SetLabelNameByLink(L);
452 //=======================================================================
453 //function : addShape
455 //=======================================================================
457 TDF_Label XCAFDoc_ShapeTool::addShape (const TopoDS_Shape& S, const Standard_Boolean makeAssembly)
459 TDF_Label ShapeLabel;
462 // search if the shape already exists (with the same location)
463 if ( S.IsNull() || FindShape ( S, ShapeLabel, Standard_True ) ) return ShapeLabel;
465 // else add a new label
466 ShapeLabel = aTag.NewChild(Label());
468 // if shape has location, make a reference to the same shape without location
469 if ( ! S.Location().IsIdentity() /*&& FindShape ( S, L )*/ ) {
473 TDF_Label L = addShape ( S0, makeAssembly );
474 MakeReference ( ShapeLabel, L, S.Location() );
478 // else add a shape to a label
479 TNaming_Builder tnBuild(ShapeLabel);
480 tnBuild.Generated(S);
482 Handle(XCAFDoc_ShapeMapTool) A = XCAFDoc_ShapeMapTool::Set(ShapeLabel);
483 // if ( ! ShapeLabel.FindAttribute(XCAFDoc_ShapeMapTool::GetID(), A) ) {
484 // A = XCAFDoc_ShapeMapTool::Set(ShapeLabel);
485 // ShapeLabel.AddAttribute(A);
490 SetLabelNameByShape(ShapeLabel);
492 // if shape is Compound and flag is set, create assembly
493 if ( makeAssembly && S.ShapeType() == TopAbs_COMPOUND ) {
494 // mark assembly by assigning UAttribute
495 Handle(TDataStd_UAttribute) Uattr;
496 Uattr = TDataStd_UAttribute::Set ( ShapeLabel, XCAFDoc::AssemblyGUID() );
498 TDataStd_Name::Set(ShapeLabel, TCollection_ExtendedString("ASSEMBLY"));
500 // iterate on components
501 TopoDS_Iterator Iterator(S);
502 for (; Iterator.More(); Iterator.Next()) {
503 // get label for component`s shape
504 TopoDS_Shape Scomp = Iterator.Value(), S0 = Scomp;
507 TDF_Label compL = addShape ( S0, makeAssembly );
509 // add a component as reference
510 TDF_Label RefLabel = aTag.NewChild(ShapeLabel);
511 MakeReference ( RefLabel, compL, Scomp.Location() );
515 if(!IsAssembly(ShapeLabel)) {
516 //const TopTools_IndexedMapOfShape tmpMap = A->GetMap();
517 //for(Standard_Integer i=1; i<=tmpMap.Extent(); i++)
518 //mySubShapes.Bind(tmpMap.FindKey(i),ShapeLabel);
519 for(Standard_Integer i=1; i<=A->GetMap().Extent(); i++)
521 TopoDS_Shape aSh = A->GetMap().FindKey(i);
522 mySubShapes.Bind(aSh,ShapeLabel);
524 //mySubShapes.Bind(ShapeLabel,A->GetMap());
531 //=======================================================================
532 //function : prepareAssembly
534 //=======================================================================
535 static Standard_Boolean prepareAssembly (const TopoDS_Shape& theShape,
536 TopoDS_Shape& theOUTShape)
538 // iterate on components
539 theOUTShape = theShape;
540 if (theShape.ShapeType() == TopAbs_COMPOUND) {
542 // check if shape if frosen
543 if (!theOUTShape.Free())
544 theOUTShape.Free(Standard_True);
546 TopTools_SequenceOfShape aSubShapeSeq;
547 TopoDS_Iterator Iterator(theShape);
548 for (; Iterator.More(); Iterator.Next())
549 aSubShapeSeq.Append(Iterator.Value());
550 for (Standard_Integer i = 1; i <= aSubShapeSeq.Length(); i++) {
551 TopoDS_Shape Scomp = aSubShapeSeq.Value(i);
552 TopoDS_Shape aNewScomp;
553 B.Remove(theOUTShape, Scomp);
554 prepareAssembly( Scomp, aNewScomp );
555 TopLoc_Location aLoc;
556 aLoc = aNewScomp.Location();
557 if ( aLoc.IsIdentity() ) {
558 // create an "empty" location
560 aTrsf.SetScale(gp_Pnt(0,0,0), 1);
561 aLoc = TopLoc_Location( aTrsf );
562 aNewScomp.Location( aLoc );
564 B.Add(theOUTShape, aNewScomp);
567 return Standard_True;
571 //=======================================================================
572 //function : AddShape
574 //=======================================================================
576 TDF_Label XCAFDoc_ShapeTool::AddShape (const TopoDS_Shape& theShape,
577 const Standard_Boolean makeAssembly,
578 const Standard_Boolean makePrepare)
580 // PTV 17.02.2003 to avoid components without location.
581 TopoDS_Shape S = theShape;
582 if ( makePrepare && makeAssembly && S.ShapeType() == TopAbs_COMPOUND )
583 prepareAssembly( theShape, S ); // OCC1669
585 TDF_Label L = addShape(S,makeAssembly);
587 if(!myShapeLabels.IsBound(S)) {
588 myShapeLabels.Bind(S,L);
593 //return addShape( S, makeAssembly );
596 //=======================================================================
597 //function : RemoveShape
599 //=======================================================================
601 Standard_Boolean XCAFDoc_ShapeTool::RemoveShape (const TDF_Label& L,
602 const Standard_Boolean removeCompletely) const
604 if ( ! IsTopLevel ( L ) || ! IsFree ( L ) ) return Standard_False;
606 Handle(TDataStd_TreeNode) aNode;
608 if (removeCompletely &&
609 L.FindAttribute (XCAFDoc::ShapeRefGUID(), aNode) &&
610 aNode->HasFather() &&
611 L.IsAttribute (XCAFDoc_Location::GetID()))
613 aLabel = aNode->Father()->Label();
616 L.ForgetAllAttributes (Standard_True);
618 if (removeCompletely && !aLabel.IsNull())
620 return RemoveShape(aLabel);
622 return Standard_True;
626 //=======================================================================
629 //=======================================================================
631 void XCAFDoc_ShapeTool::Init()
633 hasSimpleShapes = Standard_False;
637 //=======================================================================
638 //function : SetAutoNaming
640 //=======================================================================
642 void XCAFDoc_ShapeTool::SetAutoNaming (const Standard_Boolean V)
648 //=======================================================================
649 //function : AutoNaming
651 //=======================================================================
653 Standard_Boolean XCAFDoc_ShapeTool::AutoNaming()
655 return theAutoNaming;
659 //=======================================================================
660 //function : ComputeShapes
662 //=======================================================================
664 void XCAFDoc_ShapeTool::ComputeShapes(const TDF_Label& L)
666 TDF_ChildIterator it(L);
667 for(; it.More(); it.Next()) {
668 TDF_Label L1 = it.Value();
671 if(!myShapeLabels.IsBound(S)) {
672 mySimpleShapes.Bind(S,L1);
680 //=======================================================================
681 //function : ComputeSimpleShapes
683 //=======================================================================
685 void XCAFDoc_ShapeTool::ComputeSimpleShapes()
687 ComputeShapes(Label());
688 hasSimpleShapes = Standard_True;
692 //=======================================================================
693 //function : GetShapes
695 //=======================================================================
697 void XCAFDoc_ShapeTool::GetShapes(TDF_LabelSequence& Labels) const
701 TDF_ChildIterator it(Label());
702 for (; it.More(); it.Next()) {
703 TDF_Label L = it.Value();
705 if ( GetShape ( L, S ) ) Labels.Append ( L );
710 //=======================================================================
711 //function : GetFreeShapes
713 //=======================================================================
715 void XCAFDoc_ShapeTool::GetFreeShapes (TDF_LabelSequence& FreeLabels) const
719 TDF_ChildIterator it(Label());
720 for (; it.More(); it.Next()) {
721 TDF_Label L = it.Value();
723 if ( GetShape ( L, S ) && IsFree ( L ) ) FreeLabels.Append ( L );
727 //=======================================================================
728 //function : IsTopLevel
730 //=======================================================================
732 Standard_Boolean XCAFDoc_ShapeTool::IsTopLevel (const TDF_Label& L) const
734 return L.Father() == Label();
737 //=======================================================================
740 //=======================================================================
742 Standard_Boolean XCAFDoc_ShapeTool::IsShape (const TDF_Label& L)
744 return IsSimpleShape ( L ) || IsAssembly ( L ) || IsReference ( L );
747 //=======================================================================
748 //function : IsSimpleShape
750 //=======================================================================
752 Standard_Boolean XCAFDoc_ShapeTool::IsSimpleShape (const TDF_Label& L)
754 Handle(TNaming_NamedShape) NS;
755 return L.FindAttribute ( TNaming_NamedShape::GetID(), NS ) &&
756 ! IsAssembly ( L ) && ! IsReference ( L );
759 //=======================================================================
760 //function : IsReference
762 //=======================================================================
764 Standard_Boolean XCAFDoc_ShapeTool::IsReference (const TDF_Label& L)
766 Handle(TDataStd_TreeNode) Node;
767 return L.FindAttribute(XCAFDoc::ShapeRefGUID(), Node) && Node->HasFather();
770 //=======================================================================
771 //function : IsAssembly
773 //=======================================================================
775 Standard_Boolean XCAFDoc_ShapeTool::IsAssembly (const TDF_Label& L)
777 Handle(TDataStd_UAttribute) Uattr;
778 return L.FindAttribute(XCAFDoc::AssemblyGUID(), Uattr);
781 //=======================================================================
782 //function : IsComponent
784 //=======================================================================
786 Standard_Boolean XCAFDoc_ShapeTool::IsComponent (const TDF_Label& L)
788 return IsReference ( L ) && IsAssembly ( L.Father() );
791 //=======================================================================
792 //function : IsCompound
794 //=======================================================================
796 Standard_Boolean XCAFDoc_ShapeTool::IsCompound (const TDF_Label& L)
798 Handle(TDataStd_Name) Name;
799 if (L.FindAttribute(TDataStd_Name::GetID(),Name)) {
800 TCollection_ExtendedString estr1 = Name->Get();
801 TCollection_ExtendedString estr2("COMPOUND");
803 return Standard_True;
806 return Standard_False;
809 //=======================================================================
810 //function : IsSubShape
812 //=======================================================================
814 Standard_Boolean XCAFDoc_ShapeTool::IsSubShape (const TDF_Label& L)
816 return IsSimpleShape ( L ) && IsShape ( L.Father() );
819 //=======================================================================
822 //=======================================================================
824 Standard_Boolean XCAFDoc_ShapeTool::IsFree (const TDF_Label& L)
826 Handle(TDataStd_TreeNode) Node;
827 if ( ! L.FindAttribute(XCAFDoc::ShapeRefGUID(), Node) ||
828 ! Node->HasFirst() ) return Standard_True;
830 return Standard_False;
833 //=======================================================================
834 //function : GetUsers
835 //purpose : Returns number of users (0 if shape is free)
836 //=======================================================================
838 Standard_Integer XCAFDoc_ShapeTool::GetUsers (const TDF_Label& L,
839 TDF_LabelSequence& Labels,
840 const Standard_Boolean getsubchilds)
842 Standard_Integer NbUsers=0;
843 Handle(TDataStd_TreeNode) Node ;
845 if ( ! L.FindAttribute(XCAFDoc::ShapeRefGUID(), Node) ) return NbUsers;
847 Node = Node->First();
848 while ( ! Node.IsNull() ) {
850 if ( getsubchilds ) {
851 TDF_Label underL = Node->Label().Father();
852 NbUsers += GetUsers ( underL, Labels, getsubchilds );
855 Labels.Append(Node->Label());
862 //=======================================================================
863 //function : NbComponents
865 //=======================================================================
867 Standard_Integer XCAFDoc_ShapeTool::NbComponents (const TDF_Label& L,
868 const Standard_Boolean getsubchilds)
870 TDF_LabelSequence subLabels;
871 GetComponents (L, subLabels, getsubchilds);
872 return subLabels.Length();
875 //=======================================================================
876 //function : GetComponents
878 //=======================================================================
880 Standard_Boolean XCAFDoc_ShapeTool::GetComponents (const TDF_Label& L, TDF_LabelSequence& Labels,
881 const Standard_Boolean getsubchilds)
883 if ( ! IsAssembly(L) ) return Standard_False;
885 TDF_ChildIterator It(L);
886 for (; It.More(); It.Next() ) {
887 TDF_Label comp = It.Value();
888 if ( IsComponent ( comp ) ) {
889 if ( getsubchilds ) {
891 if ( GetReferredShape ( comp, underL ) )
892 GetComponents ( underL, Labels, getsubchilds);
894 Labels.Append ( comp );
897 return Standard_True;
900 //=======================================================================
901 //function : GetLocation
903 //=======================================================================
905 TopLoc_Location XCAFDoc_ShapeTool::GetLocation (const TDF_Label& L)
907 Handle(XCAFDoc_Location) LocationAttribute;
908 if (L.FindAttribute(XCAFDoc_Location::GetID(), LocationAttribute))
909 return LocationAttribute->Get();
911 Handle(TNaming_NamedShape) NS;
913 if ( L.FindAttribute ( TNaming_NamedShape::GetID(), NS ) ) {
914 S = TNaming_Tool::GetShape(NS);
919 //=======================================================================
920 //function : GetReferredShape
922 //=======================================================================
924 Standard_Boolean XCAFDoc_ShapeTool::GetReferredShape (const TDF_Label& L,
927 if ( ! IsReference(L) ) return Standard_False;
929 Handle (TDataStd_TreeNode) Node;
930 L.FindAttribute(XCAFDoc::ShapeRefGUID(), Node);
931 Label = Node->Father()->Label();
932 return Standard_True;
935 //=======================================================================
936 //function : AddComponent
938 //=======================================================================
940 TDF_Label XCAFDoc_ShapeTool::AddComponent (const TDF_Label& assembly,
941 const TDF_Label& compL,
942 const TopLoc_Location &Loc)
946 // check that shape is assembly
947 if ( ! IsAssembly(assembly) ) {
948 // if it is simple shape, make it assembly
949 if ( IsSimpleShape(assembly) )
950 TDataStd_UAttribute::Set ( assembly, XCAFDoc::AssemblyGUID() );
954 // add a component as reference
956 L = aTag.NewChild(assembly);
957 MakeReference ( L, compL, Loc );
959 // map shape to label
961 if (GetShape(L, aShape))
963 if (!myShapeLabels.IsBound(aShape))
964 myShapeLabels.Bind(aShape, L);
970 //=======================================================================
971 //function : AddComponent
973 //=======================================================================
975 TDF_Label XCAFDoc_ShapeTool::AddComponent (const TDF_Label& assembly,
976 const TopoDS_Shape& comp,
977 const Standard_Boolean expand)
979 // get label for component`s shape
980 TopoDS_Shape S0 = comp;
984 compL = AddShape ( S0, expand );
986 // add component by its label
987 return AddComponent ( assembly, compL, comp.Location() );
990 //=======================================================================
991 //function : RemoveComponent
993 //=======================================================================
995 void XCAFDoc_ShapeTool::RemoveComponent (const TDF_Label& comp) const
997 if ( IsComponent(comp) )
999 comp.ForgetAllAttributes();
1003 //=======================================================================
1004 //function : UpdateAssemblies
1006 //=======================================================================
1008 void XCAFDoc_ShapeTool::UpdateAssemblies()
1010 // We start from the free shapes (roots in the assembly structure)
1011 TDF_LabelSequence aRootLabels;
1012 GetFreeShapes(aRootLabels);
1014 // Iterate over the free shapes
1015 TDF_LabelMap anUpdated;
1016 for ( TDF_LabelSequence::Iterator anIt(aRootLabels); anIt.More(); anIt.Next() )
1018 TDF_Label aRefLabel = anIt.Value();
1019 if (IsReference(aRefLabel))
1021 GetReferredShape(aRefLabel, aRefLabel);
1023 const TDF_Label& aRootLab = aRefLabel;
1024 TopoDS_Shape anAssemblyShape;
1025 updateComponent(aRootLab, anAssemblyShape, anUpdated);
1029 //=======================================================================
1030 //function : IsSubShape
1032 //=======================================================================
1034 //static Standard_Boolean CheckSubShape (const TopoDS_Shape &S, const TopoDS_Shape &sub)
1036 // if ( S.IsSame ( sub ) ) return Standard_True;
1038 // if ( S.ShapeType() >= sub.ShapeType() ) return Standard_False;
1040 // for ( TopoDS_Iterator it(S); it.More(); it.Next() ) {
1041 // if ( CheckSubShape ( it.Value(), sub ) ) return Standard_True;
1043 // return Standard_False;
1046 //=======================================================================
1047 //function : IsSubShape
1049 //=======================================================================
1051 Standard_Boolean XCAFDoc_ShapeTool::IsSubShape (const TDF_Label &shapeL,
1052 const TopoDS_Shape &sub) const
1054 Handle(XCAFDoc_ShapeMapTool) A;
1055 if (!shapeL.FindAttribute(XCAFDoc_ShapeMapTool::GetID(), A))
1057 TopoDS_Shape aShape = GetShape(shapeL);
1058 if (aShape.IsNull())
1059 return Standard_False;
1060 A = XCAFDoc_ShapeMapTool::Set(shapeL);
1061 A->SetShape(aShape);
1064 return A->IsSubShape(sub);
1067 //=======================================================================
1068 //function : FindSubShape
1070 //=======================================================================
1072 Standard_Boolean XCAFDoc_ShapeTool::FindSubShape (const TDF_Label &shapeL,
1073 const TopoDS_Shape &sub,
1077 return Standard_False;
1079 if (TNaming_Tool::HasLabel(Label(), sub)) {
1081 L = TNaming_Tool::Label(Label(), sub, TransDef);
1083 return Standard_False;
1084 if (L.Father() == shapeL)
1085 return Standard_True;
1089 return Standard_False;
1092 // if subshape was found wrong, try to do it manually
1093 // it can be possible if several part shapes has the same subshapes
1095 TDF_ChildIterator aChldLabIt(shapeL);
1096 for (; aChldLabIt.More(); aChldLabIt.Next() ) {
1097 TDF_Label aSubLabel = aChldLabIt.Value();
1098 Handle(TNaming_NamedShape) NS;
1099 if (!aSubLabel.FindAttribute(TNaming_NamedShape::GetID(), NS))
1101 TopoDS_Shape aSubShape = TNaming_Tool::GetShape(NS);
1102 if (!aSubShape.IsNull() && aSubShape.IsSame(sub)) {
1104 return Standard_True;
1108 return Standard_False;
1111 //=======================================================================
1112 //function : AddSubShape
1114 //=======================================================================
1116 TDF_Label XCAFDoc_ShapeTool::AddSubShape (const TDF_Label &shapeL,
1117 const TopoDS_Shape &sub) const
1120 if (!IsSimpleShape(shapeL) || !IsTopLevel(shapeL))
1123 if ( FindSubShape ( shapeL, sub, L ) ) return L;
1125 if (!IsSubShape(shapeL, sub))
1129 L = aTag.NewChild(shapeL);
1131 TNaming_Builder tnBuild(L);
1132 tnBuild.Generated(sub);
1137 //=======================================================================
1138 //function : AddSubShape
1140 //=======================================================================
1142 Standard_Boolean XCAFDoc_ShapeTool::AddSubShape(const TDF_Label &shapeL,
1143 const TopoDS_Shape &sub,
1144 TDF_Label &addedSubShapeL) const
1146 addedSubShapeL = TDF_Label();
1147 // Check if adding subshape is possible
1148 if (!IsSimpleShape(shapeL) || !IsTopLevel(shapeL))
1149 return Standard_False;
1151 // Try to find already existed subshape
1152 if (FindSubShape(shapeL, sub, addedSubShapeL))
1153 return Standard_False;
1155 if (!IsSubShape(shapeL, sub))
1156 return Standard_False;
1159 addedSubShapeL = aTag.NewChild(shapeL);
1160 TNaming_Builder tnBuild(addedSubShapeL);
1161 tnBuild.Generated(sub);
1163 return Standard_True;
1167 //=======================================================================
1168 //function : FindMainShapeUsingMap
1170 //=======================================================================
1172 TDF_Label XCAFDoc_ShapeTool::FindMainShapeUsingMap(const TopoDS_Shape &sub) const
1174 //for(Standard_Integer i=1; i<=myNotAssemblies.Length(); i++) {
1175 // TDF_Label L = myNotAssemblies.Value(i);
1176 // if(IsSubShape(L,sub)) return L;
1178 if(mySubShapes.IsBound(sub))
1179 return mySubShapes.Find(sub);
1185 //=======================================================================
1186 //function : FindMainShape
1188 //=======================================================================
1190 TDF_Label XCAFDoc_ShapeTool::FindMainShape (const TopoDS_Shape &sub) const
1192 TDF_ChildIterator it(Label());
1193 for (; it.More(); it.Next()) {
1194 TDF_Label L = it.Value();
1196 if ( IsSimpleShape( L ) && IsSubShape ( L, sub ) ) return L;
1203 //=======================================================================
1204 //function : GetSubShapes
1206 //=======================================================================
1208 Standard_Boolean XCAFDoc_ShapeTool::GetSubShapes (const TDF_Label &L,
1209 TDF_LabelSequence& Labels)
1211 TDF_ChildIterator It(L);
1212 for (; It.More(); It.Next() ) {
1213 TDF_Label sub = It.Value();
1214 if ( IsSubShape ( sub ) ) Labels.Append ( sub );
1216 return Labels.Length() >0;
1219 //=======================================================================
1220 //function : BaseLabel
1222 //=======================================================================
1224 TDF_Label XCAFDoc_ShapeTool::BaseLabel () const
1229 //=======================================================================
1230 //function : DumpAssembly
1231 //purpose : recursive part of Dump()
1232 //=======================================================================
1234 static void DumpAssembly(Standard_OStream& theDumpLog,
1236 const Standard_Integer level,
1237 const Standard_Boolean deep)
1240 XCAFDoc_ShapeTool::GetShape(L, S);
1243 for (Standard_Integer i=0; i<level; i++)
1246 TCollection_AsciiString Entry;
1247 TDF_Tool::Entry(L, Entry);
1249 if(XCAFDoc_ShapeTool::IsAssembly(L))
1251 theDumpLog<<"ASSEMBLY ";
1253 else if (XCAFDoc_ShapeTool::IsSimpleShape(L))
1255 if(L.Father().Father().Father().IsRoot())
1256 theDumpLog<<"PART ";
1260 theDumpLog<<"INSTANCE ";
1262 TopAbs::Print(S.ShapeType(), theDumpLog);
1264 theDumpLog<<" "<<Entry;
1265 if(XCAFDoc_ShapeTool::IsReference(L))
1267 Handle(TDataStd_TreeNode) aRef;
1268 L.FindAttribute(XCAFDoc::ShapeRefGUID(), aRef);
1269 TDF_Tool::Entry(aRef->Father()->Label(), Entry);
1270 theDumpLog<<" (refers to "<<Entry<<")";
1272 Handle(TDataStd_Name) Name;
1273 if (L.FindAttribute(TDataStd_Name::GetID(), Name))
1274 theDumpLog<<" \""<<Name->Get()<<"\" ";
1277 theDumpLog<<"("<<*(void**)&S.TShape();
1278 if (! S.Location().IsIdentity())
1279 theDumpLog<<", "<< *(void**)&S.Location();
1282 theDumpLog<<std::endl;
1284 Handle(TDataStd_TreeNode) Node;
1285 TDF_ChildIterator NodeIterator(L);
1286 for (; NodeIterator.More(); NodeIterator.Next()) {
1287 DumpAssembly(theDumpLog, NodeIterator.Value(), level+1, deep);
1290 theDumpLog<<std::endl;
1293 //=======================================================================
1296 //=======================================================================
1298 Standard_OStream& XCAFDoc_ShapeTool::Dump(Standard_OStream& theDumpLog, const Standard_Boolean deep) const
1300 Standard_Integer level = 0;
1301 // TopTools_SequenceOfShape SeqShapes;
1302 TDF_LabelSequence SeqLabels;
1303 GetShapes( SeqLabels);
1305 if (SeqLabels.Length()>0) theDumpLog<<std::endl;
1307 for (i=1; i<=SeqLabels.Length(); i++) {
1308 DumpAssembly(theDumpLog, SeqLabels.Value(i), level, deep);
1312 GetFreeShapes(SeqLabels);
1313 theDumpLog<<std::endl<<"Free Shapes: "<<SeqLabels.Length()<<std::endl;
1314 for (i = 1; i<=SeqLabels.Length(); i++) {
1315 DumpShape(theDumpLog, SeqLabels.Value(i), level, deep);
1316 theDumpLog<<std::endl;
1321 //=======================================================================
1323 //purpose : override
1324 //=======================================================================
1326 Standard_OStream& XCAFDoc_ShapeTool::Dump(Standard_OStream& theDumpLog) const
1328 TDF_Attribute::Dump (theDumpLog);
1329 Dump (theDumpLog, Standard_False);
1333 //=======================================================================
1334 //function : DumpShape
1336 //=======================================================================
1338 void XCAFDoc_ShapeTool::DumpShape(Standard_OStream& theDumpLog, const TDF_Label& L,const Standard_Integer level,const Standard_Boolean deep)
1341 if(! XCAFDoc_ShapeTool::GetShape(L, S) ) return;
1342 for (Standard_Integer i=0; i<level; i++)
1345 if(XCAFDoc_ShapeTool::IsAssembly(L))
1347 theDumpLog<<"ASSEMBLY ";
1349 else if (XCAFDoc_ShapeTool::IsSimpleShape(L))
1351 if(L.Father().Father().Father().IsRoot())
1352 theDumpLog<<"PART ";
1356 theDumpLog<<"INSTANCE ";
1358 TopAbs::Print(S.ShapeType(), theDumpLog);
1360 TCollection_AsciiString Entry;
1361 TDF_Tool::Entry(L, Entry);
1362 theDumpLog<<" "<<Entry;
1363 if(XCAFDoc_ShapeTool::IsReference(L))
1365 Handle(TDataStd_TreeNode) aRef;
1366 L.FindAttribute(XCAFDoc::ShapeRefGUID(), aRef);
1367 TDF_Tool::Entry(aRef->Father()->Label(), Entry);
1368 theDumpLog<<" (refers to "<<Entry<<")";
1370 //std::cout<<std::endl;
1371 Handle(TDataStd_Name) Name;
1372 if (L.FindAttribute(TDataStd_Name::GetID(),Name))
1373 theDumpLog<<" \""<<Name->Get()<<"\" ";
1376 theDumpLog<<"("<<*(void**)&S.TShape();
1377 if (! S.Location().IsIdentity())
1378 theDumpLog<<", "<< *(void**)&S.Location();
1383 //=======================================================================
1384 //function : IsExternRef
1386 //=======================================================================
1388 Standard_Boolean XCAFDoc_ShapeTool::IsExternRef(const TDF_Label& L)
1390 Handle(TDataStd_UAttribute) Uattr;
1391 return L.FindAttribute(XCAFDoc::ExternRefGUID(), Uattr);
1394 //=======================================================================
1395 //function : SetExternRefs
1397 //=======================================================================
1399 void XCAFDoc_ShapeTool::SetExternRefs(const TDF_Label& L,
1400 const TColStd_SequenceOfHAsciiString& SHAS) const
1402 TDF_Label ShapeLabel = L.NewChild();
1403 TDataStd_UAttribute::Set(ShapeLabel,XCAFDoc::ExternRefGUID());
1404 for(Standard_Integer i=1; i<=SHAS.Length(); i++) {
1405 TDF_Label tmplbl = ShapeLabel.FindChild(i,Standard_True);
1406 Handle(TCollection_HAsciiString) str = SHAS(i);
1407 TCollection_ExtendedString extstr(str->String());
1408 TDataStd_Name::Set(tmplbl,extstr);
1412 //=======================================================================
1413 //function : SetExternRefs
1415 //=======================================================================
1417 TDF_Label XCAFDoc_ShapeTool::SetExternRefs(const TColStd_SequenceOfHAsciiString& SHAS) const
1419 TDF_Label ShapeLabel;
1422 ShapeLabel = aTag.NewChild(Label());
1423 TDataStd_UAttribute::Set(ShapeLabel,XCAFDoc::ExternRefGUID());
1424 for(Standard_Integer i=1; i<=SHAS.Length(); i++) {
1425 TDF_Label tmplbl = ShapeLabel.FindChild(i,Standard_True);
1426 Handle(TCollection_HAsciiString) str = SHAS(i);
1427 TCollection_ExtendedString extstr(str->String());
1428 TDataStd_Name::Set(tmplbl,extstr);
1433 //=======================================================================
1434 //function : GetExternRefs
1436 //=======================================================================
1438 void XCAFDoc_ShapeTool::GetExternRefs(const TDF_Label& L,
1439 TColStd_SequenceOfHAsciiString& SHAS)
1441 Handle(TDataStd_Name) TDN;
1443 for(Standard_Integer i=1; i<=L.NbChildren(); i++) {
1444 tmplbl = L.FindChild(i);
1445 if(tmplbl.FindAttribute(TDataStd_Name::GetID(),TDN)) {
1446 TCollection_ExtendedString extstr = TDN->Get();
1447 Handle(TCollection_HAsciiString) str =
1448 new TCollection_HAsciiString(TCollection_AsciiString(extstr, '?'));
1454 // API: API work with SHUO (Specified Higher Usage Occurrance) structure
1456 //=======================================================================
1457 //function : GetSHUO
1459 //=======================================================================
1461 Standard_Boolean XCAFDoc_ShapeTool::GetSHUO (const TDF_Label& SHUOLabel,
1462 Handle(XCAFDoc_GraphNode)& aSHUOAttr)
1464 if ( !SHUOLabel.FindAttribute( XCAFDoc::SHUORefGUID(), aSHUOAttr ) )
1465 return Standard_False;
1466 return Standard_True;
1469 //=======================================================================
1470 //function : GetAllComponentSHUO
1472 //=======================================================================
1474 Standard_Boolean XCAFDoc_ShapeTool::GetAllComponentSHUO (const TDF_Label& theCompLabel,
1475 TDF_AttributeSequence& theSHUOAttrs)
1477 TDF_ChildIterator it(theCompLabel);
1478 for (; it.More(); it.Next()) {
1479 TDF_Label L = it.Value();
1480 Handle(XCAFDoc_GraphNode) aSHUOAttr;
1481 if ( GetSHUO( L, aSHUOAttr ) )
1482 theSHUOAttrs.Append( aSHUOAttr );
1484 return (theSHUOAttrs.Length() > 0);
1487 //=======================================================================
1488 //function : SetSHUO
1490 //=======================================================================
1492 Standard_Boolean XCAFDoc_ShapeTool::SetSHUO (const TDF_LabelSequence& labels,
1493 Handle(XCAFDoc_GraphNode)& MainSHUOAttr) const
1495 MainSHUOAttr.Nullify();
1496 // check number of labels
1497 if (labels.Length() < 2)
1498 return Standard_False;
1499 // check is all labels contains components of any assemblyies
1501 for (i = 1; i <= labels.Length(); i++)
1502 if ( !IsComponent(labels.Value(i)) )
1503 return Standard_False;
1506 TDF_Label UpperSubL = aTag.NewChild( labels( 1 ) );
1507 if (theAutoNaming) {
1508 TCollection_ExtendedString Entry("SHUO");
1509 TDataStd_Name::Set(UpperSubL, TCollection_ExtendedString( Entry ));
1511 Handle(XCAFDoc_GraphNode) aUpperSHUO;
1512 aUpperSHUO = XCAFDoc_GraphNode::Set( UpperSubL, XCAFDoc::SHUORefGUID() );
1513 // init out argument by main upper usage SHUO
1514 MainSHUOAttr = aUpperSHUO;
1515 // add other next_usage occurrences.
1516 for (i = 2; i <= labels.Length(); i++) {
1517 TDF_Label NextSubL = aTag.NewChild( labels( i ) );
1518 if (theAutoNaming) {
1519 TCollection_ExtendedString EntrySub("SHUO-");
1521 TDataStd_Name::Set(NextSubL, TCollection_ExtendedString( EntrySub ));
1523 Handle(XCAFDoc_GraphNode) aNextSHUO;
1524 aNextSHUO = XCAFDoc_GraphNode::Set( NextSubL, XCAFDoc::SHUORefGUID() );
1526 aUpperSHUO->SetChild( aNextSHUO );
1527 aNextSHUO->SetFather( aUpperSHUO );
1528 // now lets next_usage become upper_usage for next level of SHUO
1529 aUpperSHUO = aNextSHUO;
1530 UpperSubL = NextSubL;
1533 return Standard_True;
1536 //=======================================================================
1537 //function : GetSHUOUpperUsage
1539 //=======================================================================
1541 Standard_Boolean XCAFDoc_ShapeTool::GetSHUOUpperUsage (const TDF_Label& NextUsageL,
1542 TDF_LabelSequence& aLabels)
1544 Handle(XCAFDoc_GraphNode) aNextSHUO;
1545 if( !GetSHUO( NextUsageL, aNextSHUO ) || aNextSHUO->NbFathers()<1 )
1546 return Standard_False;
1548 // get upper_usage SHAO
1549 for (Standard_Integer i = 1; i <= aNextSHUO->NbFathers(); i++)
1550 aLabels.Append( aNextSHUO->GetFather(i)->Label() );
1551 return Standard_True;
1554 //=======================================================================
1555 //function : GetSHUONextUsage
1557 //=======================================================================
1559 Standard_Boolean XCAFDoc_ShapeTool::GetSHUONextUsage (const TDF_Label& UpperUsageL,
1560 TDF_LabelSequence& aLabels)
1562 Handle(XCAFDoc_GraphNode) aUpperSHUO;
1563 if ( !GetSHUO( UpperUsageL, aUpperSHUO ) || aUpperSHUO->NbChildren()<1 )
1564 return Standard_False;
1565 // get upper_usage SHAO
1566 for (Standard_Integer i = 1; i <= aUpperSHUO->NbChildren(); i++)
1567 aLabels.Append( aUpperSHUO->GetChild(i)->Label() );
1568 return Standard_True;
1571 //=======================================================================
1572 //function : RemoveSHUO
1574 //=======================================================================
1576 Standard_Boolean XCAFDoc_ShapeTool::RemoveSHUO (const TDF_Label& L) const
1578 L.ForgetAllAttributes (Standard_True);
1579 return Standard_True;
1582 //=======================================================================
1583 //function : checkForShape
1584 //purpose : auxilary
1585 //=======================================================================
1587 static Standard_Boolean checkForShape (const TopoDS_Shape& theShape,
1588 const TopoDS_Shape& theCurSh,
1589 const TDF_Label& theUserL,
1590 TDF_LabelSequence& theLabels)
1592 // the label of an assembly which contains this component
1593 TDF_Label aSuperUserL = theUserL.Father();
1594 TopLoc_Location aSupLoc, aCompLoc;
1595 aSupLoc = ::XCAFDoc_ShapeTool::GetLocation ( aSuperUserL );
1596 aCompLoc = ::XCAFDoc_ShapeTool::GetLocation ( theUserL );
1597 TopoDS_Shape aCopySh = theCurSh;
1598 aCompLoc = aCompLoc.Multiplied( theCurSh.Location() );
1599 aSupLoc = aSupLoc.Multiplied( aCompLoc );
1600 aCopySh.Location( aSupLoc );
1601 if ( aCopySh.IsSame( theShape ) ) {
1602 theLabels.Prepend( theUserL );
1603 return Standard_True;
1605 // try to search deeply (upper by assmebly structure)
1606 TDF_LabelSequence aNewLabels;
1607 for (Standard_Integer j = 1; j <= theLabels.Length(); j++)
1608 aNewLabels.Append( theLabels.Value( j ) );
1609 aNewLabels.Prepend( theUserL );
1610 TDF_LabelSequence aUsers;
1611 ::XCAFDoc_ShapeTool::GetUsers( aSuperUserL, aUsers );
1612 for (Standard_Integer i = 1; i <= aUsers.Length(); i++)
1613 if ( checkForShape( theShape, aCopySh, aUsers.Value( i ), aNewLabels ) ) {
1615 theLabels = aNewLabels;
1616 return Standard_True;
1618 return Standard_False;
1621 //=======================================================================
1622 //function : FindComponent
1624 //=======================================================================
1626 Standard_Boolean XCAFDoc_ShapeTool::FindComponent (const TopoDS_Shape& theShape,
1627 TDF_LabelSequence& theLabels) const
1630 // search for a top-level shape that corresponds to this component
1631 TopoDS_Shape S0 = theShape;
1632 TopLoc_Location loc;
1633 S0.Location ( loc );
1634 TDF_Label aRefL = FindShape( S0 );
1636 return Standard_False; // cannot find top-level shape.
1638 TDF_LabelSequence aUsers;
1639 ::XCAFDoc_ShapeTool::GetUsers( aRefL, aUsers );
1640 for (Standard_Integer i = 1; i <= aUsers.Length(); i++)
1641 if ( checkForShape( theShape, S0, aUsers.Value( i ), theLabels ) )
1644 return (theLabels.Length() > 0);
1647 //=======================================================================
1648 //function : getShapesOfSHUO
1649 //purpose : auxilary
1650 //=======================================================================
1652 static Standard_Boolean getShapesOfSHUO (TopLoc_IndexedMapOfLocation& theaPrevLocMap,
1653 const Handle(XCAFDoc_ShapeTool)& theSTool,
1654 const TDF_Label& theSHUOlab,
1655 TopoDS_Shape& theShape)
1657 Handle(XCAFDoc_GraphNode) SHUO;
1658 TDF_LabelSequence aLabSeq;
1659 theSTool->GetSHUONextUsage( theSHUOlab, aLabSeq );
1660 if (aLabSeq.Length() >= 1)
1661 for (Standard_Integer i = 1; i <= aLabSeq.Length(); i++) {
1662 TDF_Label aSubCompL = aLabSeq.Value( i );
1663 TopLoc_Location compLoc = XCAFDoc_ShapeTool::GetLocation ( aSubCompL.Father() );
1664 // create new map of laocation (to not merge locations from different shapes)
1665 TopLoc_IndexedMapOfLocation aNewPrevLocMap;
1666 for (Standard_Integer m = 1; m <= theaPrevLocMap.Extent(); m++)
1667 aNewPrevLocMap.Add( theaPrevLocMap.FindKey( m ) );
1668 aNewPrevLocMap.Add( compLoc );
1669 // got for the new sublocations and corresponding shape
1670 getShapesOfSHUO( aNewPrevLocMap, theSTool, aSubCompL, theShape );
1673 TopoDS_Shape aSHUO_NUSh = theSTool->GetShape ( theSHUOlab.Father() );
1674 if ( aSHUO_NUSh.IsNull() ) return Standard_False;
1675 // cause got shape with location already.
1676 TopLoc_Location nullLoc;
1677 aSHUO_NUSh.Location ( nullLoc );
1678 // multiply the locations
1679 Standard_Integer intMapLenght = theaPrevLocMap.Extent();
1680 if ( intMapLenght < 1 )
1681 return Standard_False; // should not be, but to avoid exception...?
1682 TopLoc_Location SupcompLoc;
1683 SupcompLoc = theaPrevLocMap.FindKey( intMapLenght );
1684 if (intMapLenght > 1) {
1685 Standard_Integer l = intMapLenght - 1;
1687 SupcompLoc = theaPrevLocMap.FindKey( l ).Multiplied( SupcompLoc );
1691 aSHUO_NUSh.Location( SupcompLoc );
1692 theShape = aSHUO_NUSh;
1694 return (!theShape.IsNull());
1697 //=======================================================================
1698 //function : GetSHUOInstance
1700 //=======================================================================
1702 TopoDS_Shape XCAFDoc_ShapeTool::GetSHUOInstance (const Handle(XCAFDoc_GraphNode)& theSHUO) const
1704 TopoDS_Shape aShape;
1705 if (theSHUO.IsNull())
1708 TDF_Label aSHUOlab = theSHUO->Label();
1709 // get location of the assembly
1710 TopLoc_Location loc = XCAFDoc_ShapeTool::GetLocation ( aSHUOlab.Father().Father() );
1711 // get location of the component
1712 TopLoc_Location compLoc = XCAFDoc_ShapeTool::GetLocation ( aSHUOlab.Father() );
1713 TopLoc_IndexedMapOfLocation aPrevLocMap;
1714 // get previous setted location
1715 if ( !loc.IsIdentity() )
1716 aPrevLocMap.Add( loc );
1717 aPrevLocMap.Add( compLoc );
1718 // get shape by recurse method
1719 const Handle(XCAFDoc_ShapeTool)& STool = this;
1720 getShapesOfSHUO( aPrevLocMap, STool, aSHUOlab, aShape );
1725 //=======================================================================
1726 //function : getUsersShapesOfSHUO
1727 //purpose : auxilary
1728 //=======================================================================
1730 static Standard_Boolean getUsersShapesOfSHUO (TopLoc_IndexedMapOfLocation& aPrevLocMap,
1731 const Handle(XCAFDoc_ShapeTool)& STool,
1732 const TDF_Label& aSHUOlab,
1733 const TDF_Label& theUserL,
1734 TopTools_SequenceOfShape& theSHUOShapeSeq)
1736 TopLoc_IndexedMapOfLocation aNewPrevLocMap;
1737 // get location of the assembly
1738 TopLoc_Location loc = XCAFDoc_ShapeTool::GetLocation ( theUserL.Father() );
1739 // get location of the component
1740 TopLoc_Location compLoc = XCAFDoc_ShapeTool::GetLocation ( theUserL );
1741 // get previous setted location
1742 aNewPrevLocMap.Add( loc );
1743 aNewPrevLocMap.Add( compLoc );
1745 for (i = 1; i <= aPrevLocMap.Extent(); i++)
1746 aNewPrevLocMap.Add( aPrevLocMap.FindKey(i) );
1747 TDF_Label L = theUserL.Father();
1748 TDF_LabelSequence usersLab;
1749 ::XCAFDoc_ShapeTool::GetUsers( L, usersLab );
1750 if (usersLab.Length() == 0) {
1751 TopoDS_Shape aShape;
1752 getShapesOfSHUO( aNewPrevLocMap, STool, aSHUOlab, aShape );
1753 if (!aShape.IsNull()) {
1754 theSHUOShapeSeq.Append(aShape);
1755 return Standard_True;
1758 // now iterates on users of this assembly as component
1759 for ( i = 1; i <= usersLab.Length(); i++ ) {
1760 TDF_Label aNewUserL = usersLab.Value(i);
1761 getUsersShapesOfSHUO( aNewPrevLocMap, STool, aSHUOlab, aNewUserL, theSHUOShapeSeq );
1764 return (theSHUOShapeSeq.Length() > 1);
1767 //=======================================================================
1768 //function : GetAllSHUOInstances
1769 //purpose : auxilary
1770 //=======================================================================
1772 Standard_Boolean XCAFDoc_ShapeTool::GetAllSHUOInstances (const Handle(XCAFDoc_GraphNode)& theSHUO,
1773 TopTools_SequenceOfShape& theSHUOShapeSeq) const
1775 if (theSHUO.IsNull())
1776 return Standard_False;
1778 TDF_Label aSHUOlab = theSHUO->Label();
1779 TopLoc_IndexedMapOfLocation aPrevLocMap;
1780 // get location of the assembly
1781 TopLoc_Location loc = XCAFDoc_ShapeTool::GetLocation ( aSHUOlab.Father().Father() );
1782 // get location of the component
1783 TopLoc_Location compLoc = XCAFDoc_ShapeTool::GetLocation ( aSHUOlab.Father() );
1784 // get previous setted location
1785 if ( !loc.IsIdentity() )
1786 aPrevLocMap.Add( loc );
1787 aPrevLocMap.Add( compLoc );
1788 // get label of assembly
1789 TDF_Label L = aSHUOlab.Father().Father();
1790 TDF_LabelSequence usersLab;
1791 ::XCAFDoc_ShapeTool::GetUsers( L, usersLab );
1792 TopoDS_Shape aShape;
1793 const Handle(XCAFDoc_ShapeTool)& STool = this;
1794 if (usersLab.Length() == 0) {
1795 getShapesOfSHUO( aPrevLocMap, STool, aSHUOlab, aShape );
1796 if (!aShape.IsNull()) {
1797 theSHUOShapeSeq.Append(aShape);
1798 return Standard_True;
1801 // now iterates on users of this assembly as component
1802 for (Standard_Integer i = 1; i <= usersLab.Length(); i++) {
1803 TDF_Label aUserL = usersLab.Value(i);
1804 getUsersShapesOfSHUO( aPrevLocMap, STool, aSHUOlab, aUserL, theSHUOShapeSeq );
1807 return (theSHUOShapeSeq.Length() > 1);
1810 //=======================================================================
1811 //function : SetInstanceSHUO
1813 //=======================================================================
1815 Handle(XCAFDoc_GraphNode) XCAFDoc_ShapeTool::SetInstanceSHUO (const TopoDS_Shape& theShape) const
1817 Handle(XCAFDoc_GraphNode) SHUO;
1818 TDF_LabelSequence aLabels;
1819 if ( FindComponent( theShape, aLabels ) )
1820 // set shuo structure on labels of component-assembly structure
1821 SetSHUO( aLabels, SHUO );
1825 //=======================================================================
1826 //function : FindSHUO
1828 //=======================================================================
1830 Standard_Boolean XCAFDoc_ShapeTool::FindSHUO (const TDF_LabelSequence& theLabels,
1831 Handle(XCAFDoc_GraphNode)& theSHUOAttr)
1833 TDF_AttributeSequence SHUOAttrs;
1834 TDF_Label aCompLabel = theLabels.Value(1);
1835 if (! ::XCAFDoc_ShapeTool::GetAllComponentSHUO( aCompLabel, SHUOAttrs ) )
1836 return Standard_False;
1837 // WARNING: manage that each SHUO upper_usage have only one SHUO next_usage
1838 for (Standard_Integer i = 1; i <= SHUOAttrs.Length(); i++) {
1839 TDF_LabelSequence aCondidate;
1840 Handle(XCAFDoc_GraphNode) anSHUO = Handle(XCAFDoc_GraphNode)::DownCast(SHUOAttrs.Value(i));
1841 aCondidate.Append( anSHUO->Label().Father() );
1842 while (anSHUO->NbChildren()) {
1843 anSHUO = anSHUO->GetChild( 1 );
1844 aCondidate.Append( anSHUO->Label().Father() );
1846 // check the label sequences
1847 Standard_Boolean isEqual = Standard_True;
1848 if (theLabels.Length() != aCondidate.Length())
1849 isEqual = Standard_False;
1851 for (Standard_Integer li = 1; li <= theLabels.Length(); li++)
1852 if ( theLabels.Value(li) != aCondidate.Value(li) ) {
1853 isEqual = Standard_False;
1859 theSHUOAttr = Handle(XCAFDoc_GraphNode)::DownCast(SHUOAttrs.Value(i));
1862 return ( !theSHUOAttr.IsNull() );
1865 //=======================================================================
1868 //=======================================================================
1869 Standard_Boolean XCAFDoc_ShapeTool::Expand (const TDF_Label& theShapeL)
1871 if (theShapeL.IsNull() || IsAssembly(theShapeL))
1872 return Standard_False;
1874 TopoDS_Shape aShape = GetShape(theShapeL);
1875 if (aShape.IsNull())
1876 return Standard_False;
1878 TopAbs_ShapeEnum aShapeType = aShape.ShapeType();
1879 Standard_Boolean isExpandedType = aShapeType == TopAbs_COMPOUND || aShapeType == TopAbs_COMPSOLID ||
1880 aShapeType == TopAbs_SHELL || aShapeType == TopAbs_WIRE;
1883 TopoDS_Iterator anIter(aShape);
1884 for(; anIter.More(); anIter.Next())
1886 const TopoDS_Shape& aChildShape = anIter.Value();
1887 TDF_Label aChild, aPart;
1889 // Find child shape as subshape of expanded shape
1890 FindSubShape(theShapeL, aChildShape, aChild);
1891 Handle(TDataStd_Name) anAttr;
1892 //make child (if color isn't set or if it is compound)
1893 if (aChild.IsNull()) {
1894 aChild = AddSubShape(theShapeL, aChildShape);
1898 aChild.FindAttribute(TDataStd_Name::GetID(), anAttr);
1901 // Try to find child shape as already existed part
1902 aPart = FindShape(aChildShape.Located(TopLoc_Location()));
1903 if (aPart.IsNull()) {
1904 // Create new part to link child shape
1905 aPart = AddShape(aChildShape.Located(TopLoc_Location()), Standard_False, Standard_False);
1907 // Add shape manually, if already existed subshape found instead of creation of new part
1908 if (!aPart.IsNull() && !IsTopLevel(aPart)) {
1909 if (!GetReferredShape(aPart, aPart)) {
1911 aPart = aTag.NewChild(Label());
1912 SetShape(aPart, aChildShape.Located(TopLoc_Location()));
1917 if (!anAttr.IsNull()) {
1918 TDataStd_Name::Set(aPart, anAttr->Get());
1921 Standard_SStream Stream;
1922 TopAbs::Print(aChildShape.ShapeType(), Stream);
1923 TCollection_AsciiString aName(Stream.str().c_str());
1924 TDataStd_Name::Set(aPart, TCollection_ExtendedString(aName));
1926 MakeReference(aChild, aPart, aChildShape.Location());
1927 makeSubShape(theShapeL, aPart, aChildShape, aChildShape.Location());
1929 //set assembly attribute
1930 TDataStd_UAttribute::Set(theShapeL, XCAFDoc::AssemblyGUID());
1931 return Standard_True;
1933 return Standard_False;
1936 //=======================================================================
1937 //function : makeSubShape
1939 //=======================================================================
1941 void XCAFDoc_ShapeTool::makeSubShape (const TDF_Label& theMainShapeL,
1942 const TDF_Label& thePart,
1943 const TopoDS_Shape& theShape,
1944 const TopLoc_Location& theLoc)
1946 TopoDS_Iterator anIter(theShape);
1947 Standard_Boolean isCompoundPart = (GetShape(thePart).ShapeType() == TopAbs_COMPOUND);
1948 Standard_Boolean isAssembly = IsAssembly(thePart);
1950 for(; anIter.More(); anIter.Next()) {
1951 const TopoDS_Shape& aChildShape = anIter.Value();
1952 TDF_Label aChildLabel;
1953 FindSubShape(theMainShapeL, aChildShape, aChildLabel);
1954 if(!aChildLabel.IsNull()) {
1956 aChildLabel.ForgetAllAttributes();
1957 makeSubShape(theMainShapeL, thePart, aChildShape, theLoc);
1961 Handle(TDataStd_Name) anAttr;
1962 aChildLabel.FindAttribute(TDataStd_Name::GetID(), anAttr);
1963 TopLoc_Location aSubLoc;
1964 // Calculate location for subshapes of compound parts
1965 aSubLoc = aChildShape.Location();
1967 aSubLoc = theLoc.Inverted() * aSubLoc;
1969 TDF_Label aSubLabel;
1970 // Identical location and empty location are not the same for ShapeTool, so try to process both
1971 // in case of aSubLoc is not identical, the second Add try will not affect algorithm.
1972 Standard_Boolean isNewSubL;
1973 isNewSubL = AddSubShape(thePart, aChildShape.Located(aSubLoc), aSubLabel);
1974 if (aSubLabel.IsNull())
1976 isNewSubL = AddSubShape(thePart, aChildShape.Located(TopLoc_Location()), aSubLabel);
1979 //set name to sub shape
1980 if (!anAttr.IsNull()) {
1981 TDataStd_Name::Set(aSubLabel, anAttr->Get());
1984 Standard_SStream Stream;
1985 TopAbs::Print(aChildShape.ShapeType(), Stream);
1986 TCollection_AsciiString aName(Stream.str().c_str());
1987 TDataStd_Name::Set(aSubLabel, TCollection_ExtendedString(aName));
1989 // Create auxiliary link, it will be removed during moving attributes
1990 MakeReference(aSubLabel, aChildLabel, aChildShape.Location());
1993 aChildLabel.ForgetAllAttributes();
1997 makeSubShape(theMainShapeL, thePart, aChildShape, theLoc);
2001 //=======================================================================
2002 //function : updateComponent
2004 //=======================================================================
2006 Standard_Boolean XCAFDoc_ShapeTool::updateComponent(const TDF_Label& theItemLabel,
2007 TopoDS_Shape& theUpdatedShape,
2008 TDF_LabelMap& theUpdated) const
2010 if ( !IsAssembly(theItemLabel) )
2011 return Standard_False; // Do nothing for non-assemblies
2013 // Get the currently stored compound for the assembly
2014 TopoDS_Shape aCurrentRootShape;
2015 GetShape(theItemLabel, aCurrentRootShape);
2017 // Check if the given assembly is already updated
2018 if (theUpdated.Contains(theItemLabel)) {
2019 theUpdatedShape = aCurrentRootShape;
2020 return Standard_True;
2023 TopTools_MapOfOrientedShape aCurrentRootShapeMap (aCurrentRootShape.NbChildren());
2025 // Get components of the assembly
2026 TDF_LabelSequence aComponentLabs;
2027 GetComponents(theItemLabel, aComponentLabs);
2029 // This flag indicates whether to update the compound of the assembly
2030 Standard_Boolean isModified = Standard_False;
2032 // Compare the number of components in XDE structure with the number of
2033 // components in topological structure. A component may happen to be removed,
2034 // so we have to update the assembly compound
2035 const Standard_Integer aNumTopoComponents = aCurrentRootShape.NbChildren();
2037 if ( aNumTopoComponents != aComponentLabs.Length() )
2038 isModified = Standard_True;
2040 // Iterate over the assembly components. If at least one component is
2041 // modified (this is the recursive check), then the actually stored
2042 // compound has to be updated
2043 TopTools_ListOfShape aComponentShapes;
2045 for ( TDF_LabelSequence::Iterator aCompIt(aComponentLabs); aCompIt.More(); aCompIt.Next() )
2047 const TDF_Label& aComponentLab = aCompIt.Value();
2049 // Take the referred assembly item (ultimately, a part for an instance)
2050 TDF_Label aComponentRefLab;
2051 GetReferredShape(aComponentLab, aComponentRefLab);
2053 // Shape comes with some placement transformation here
2054 TopoDS_Shape aComponentShape;
2055 GetShape(aComponentLab, aComponentShape);
2056 TopLoc_Location aComponentLoc = aComponentShape.Location();
2058 // If the component is a sub-assembly, then its associated compound
2059 // has to be processed in the same manner
2060 if ( IsAssembly(aComponentRefLab) )
2063 if ( updateComponent(aComponentRefLab, aComponentShape, theUpdated) )
2065 isModified = Standard_True;
2066 aComponentShape.Location(aComponentLoc); // Apply placement
2071 // Search for a part in the actual compound of the ultimate assembly.
2072 // If the part is there, then the compound is up-to-date, so it does not require rebuilding
2075 if (aCurrentRootShapeMap.IsEmpty())
2077 // optimize search for next labels in aComponentLabs
2078 for (TopoDS_Iterator aTopoIt(aCurrentRootShape); aTopoIt.More(); aTopoIt.Next())
2080 aCurrentRootShapeMap.Add (aTopoIt.Value());
2083 if (!aCurrentRootShapeMap.Contains (aComponentShape))
2085 // Part has been modified somewhere, so the compound has to be rebuilt
2086 isModified = Standard_True;
2091 // Fill the list of shapes composing a new compound for the assembly
2092 aComponentShapes.Append(aComponentShape);
2095 // If any component is modified, we update the currently stored shape
2098 TopoDS_Compound anUpdatedCompound;
2100 aBB.MakeCompound(anUpdatedCompound);
2102 // Compose new compound
2103 for ( TopTools_ListIteratorOfListOfShape aShapeIt(aComponentShapes); aShapeIt.More(); aShapeIt.Next() )
2105 aBB.Add( anUpdatedCompound, aShapeIt.Value() );
2108 // Store the updated shape as an output
2109 theUpdatedShape = anUpdatedCompound;
2111 // Use topological naming services to store the updated shape in XDE
2112 TNaming_Builder NB(theItemLabel);
2113 NB.Generated(theUpdatedShape);
2117 theUpdated.Add(theItemLabel);
2122 //=======================================================================
2123 //function : GetNamedProperties
2125 //=======================================================================
2127 Handle(TDataStd_NamedData) XCAFDoc_ShapeTool::GetNamedProperties (const TDF_Label& theLabel,
2128 const Standard_Boolean theToCreate) const
2130 Handle(TDataStd_NamedData) aNamedProperty;
2131 if (!theLabel.FindAttribute(TDataStd_NamedData::GetID(), aNamedProperty) && theToCreate)
2133 aNamedProperty = TDataStd_NamedData::Set(theLabel);
2136 return aNamedProperty;
2139 //=======================================================================
2140 //function : GetNamedProperties
2142 //=======================================================================
2144 Handle(TDataStd_NamedData) XCAFDoc_ShapeTool::GetNamedProperties (const TopoDS_Shape& theShape,
2145 const Standard_Boolean theToCreate) const
2147 Handle(TDataStd_NamedData) aNamedProperty;
2149 if (!Search (theShape, aLabel))
2150 return aNamedProperty;
2152 aNamedProperty = GetNamedProperties (aLabel, theToCreate);
2154 return aNamedProperty;
2157 //=======================================================================
2158 //function : DumpJson
2160 //=======================================================================
2161 void XCAFDoc_ShapeTool::DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth) const
2163 OCCT_DUMP_TRANSIENT_CLASS_BEGIN (theOStream)
2165 OCCT_DUMP_BASE_CLASS (theOStream, theDepth, TDF_Attribute)
2167 for (XCAFDoc_DataMapOfShapeLabel::Iterator aShapeLabelIt (myShapeLabels); aShapeLabelIt.More(); aShapeLabelIt.Next())
2169 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &aShapeLabelIt.Key())
2171 TCollection_AsciiString aShapeLabel;
2172 TDF_Tool::Entry (aShapeLabelIt.Value(), aShapeLabel);
2173 OCCT_DUMP_FIELD_VALUE_STRING (theOStream, aShapeLabel)
2176 for (XCAFDoc_DataMapOfShapeLabel::Iterator aSubShapeIt (mySubShapes); aSubShapeIt.More(); aSubShapeIt.Next())
2178 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &aSubShapeIt.Key())
2180 TCollection_AsciiString aSubShape;
2181 TDF_Tool::Entry (aSubShapeIt.Value(), aSubShape);
2182 OCCT_DUMP_FIELD_VALUE_STRING (theOStream, aSubShape)
2185 for (XCAFDoc_DataMapOfShapeLabel::Iterator aSimpleShapeIt (mySimpleShapes); aSimpleShapeIt.More(); aSimpleShapeIt.Next())
2187 OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &aSimpleShapeIt.Key())
2189 TCollection_AsciiString aSimpleShape;
2190 TDF_Tool::Entry (aSimpleShapeIt.Value(), aSimpleShape);
2191 OCCT_DUMP_FIELD_VALUE_STRING (theOStream, aSimpleShape)
2194 OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, hasSimpleShapes)