Loading files
3d097a032This file is pinned to the selected release. Download the original to open it in your design tool.
// Created on: 2022-05-11
// Copyright (c) 2022 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#include <Standard_NullObject.hxx>
#include <TColStd_PackedMapOfInteger.hxx>
#include <TDataStd_TreeNode.hxx>
#include <TDF_ChildIterator.hxx>
#include <TDF_Tool.hxx>
#include <TDocStd_Document.hxx>
#include <XCAFDoc.hxx>
#include <XCAFDoc_AssemblyGraph.hxx>
#include <XCAFDoc_DocumentTool.hxx>
#include <XCAFDoc_ShapeTool.hxx>
// =======================================================================
// function : XCAFDoc_AssemblyGraph constructor
// purpose : Builds an assembly graph from the OCAF document
// =======================================================================
XCAFDoc_AssemblyGraph::XCAFDoc_AssemblyGraph(const occ::handle<TDocStd_Document>& theDoc)
{
Standard_NullObject_Raise_if(theDoc.IsNull(), "Null document!");
myShapeTool = XCAFDoc_DocumentTool::ShapeTool(theDoc->Main());
Standard_NoSuchObject_Raise_if(myShapeTool.IsNull(), "No XCAFDoc_ShapeTool attribute!");
TDF_Label aDummy;
buildGraph(aDummy);
}
// =======================================================================
// function : XCAFDoc_AssemblyGraph constructor
// purpose : Builds an assembly graph from the OCAF label
// =======================================================================
XCAFDoc_AssemblyGraph::XCAFDoc_AssemblyGraph(const TDF_Label& theLabel)
{
Standard_NullObject_Raise_if(theLabel.IsNull(), "Null label!");
myShapeTool = XCAFDoc_DocumentTool::ShapeTool(theLabel);
Standard_NoSuchObject_Raise_if(myShapeTool.IsNull(), "No XCAFDoc_ShapeTool attribute!");
buildGraph(theLabel);
}
// =======================================================================
// function : IsDirectLink
// purpose : Checks if one node is the direct child of other one
// =======================================================================
bool XCAFDoc_AssemblyGraph::IsDirectLink(const int theNode1, const int theNode2) const
{
if (!HasChildren(theNode1))
{
return false;
}
return GetChildren(theNode1).Contains(theNode2);
}
//=================================================================================================
XCAFDoc_AssemblyGraph::NodeType XCAFDoc_AssemblyGraph::GetNodeType(const int theNode) const
{
const NodeType* typePtr = myNodeTypes.Seek(theNode);
if (typePtr == nullptr)
{
return NodeType_UNDEFINED;
}
return (*typePtr);
}
// =======================================================================
// function : NbLinks
// purpose : Calculates and returns the number of links
// =======================================================================
int XCAFDoc_AssemblyGraph::NbLinks() const
{
int aNumLinks = 0;
for (AdjacencyMap::Iterator it(myAdjacencyMap); it.More(); it.Next())
{
aNumLinks += it.Value().Extent();
}
return aNumLinks;
}
//=================================================================================================
int XCAFDoc_AssemblyGraph::NbOccurrences(const int theNode) const
{
const int* aUsageOQPtr = myUsages.Seek(theNode);
if (aUsageOQPtr == nullptr)
{
return 0;
}
return (*aUsageOQPtr);
}
// =======================================================================
// function : buildGraph
// purpose : Builds an assembly graph from the OCAF document
// =======================================================================
void XCAFDoc_AssemblyGraph::buildGraph(const TDF_Label& theLabel)
{
// We start from those shapes which are "free" in terms of XDE.
NCollection_Sequence<TDF_Label> aRoots;
if (theLabel.IsNull() || (myShapeTool->Label() == theLabel))
{
myShapeTool->GetFreeShapes(aRoots);
}
else
{
aRoots.Append(theLabel);
}
for (NCollection_Sequence<TDF_Label>::Iterator it(aRoots); it.More(); it.Next())
{
TDF_Label aLabel = it.Value();
TDF_Label anOriginal;
int aRootId, anIdToProceed;
if (!myShapeTool->GetReferredShape(aLabel, anOriginal))
{
anOriginal = aLabel;
aRootId = addNode(anOriginal, 0);
anIdToProceed = aRootId;
}
else
{
aRootId = addNode(aLabel, 0);
if (aRootId == 0)
{
continue;
}
anIdToProceed = addNode(anOriginal, aRootId);
}
if (aRootId == 0 || anIdToProceed == 0)
{
continue;
}
myRoots.Add(aRootId);
// Add components (the objects nested into the current one).
if (myShapeTool->IsAssembly(anOriginal))
{
addComponents(anOriginal, anIdToProceed);
}
}
}
// =======================================================================
// function : addComponents
// purpose : Adds components for the given parent to the graph structure
// =======================================================================
void XCAFDoc_AssemblyGraph::addComponents(const TDF_Label& theParent, const int theParentId)
{
if (!myShapeTool->IsShape(theParent))
{
return; // We have to return here in order to prevent iterating by
// sub-labels. For parts, sub-labels are used to encode
// metadata which is out of interest in conceptual design
// intent represented by assembly graph.
}
// Loop over the children (persistent representation of "part-of" relation).
for (TDF_ChildIterator anIt(theParent); anIt.More(); anIt.Next())
{
TDF_Label aComponent = anIt.Value();
// Add component
const int aComponentId = addNode(aComponent, theParentId);
if (aComponentId == 0)
{
continue;
}
// Protection against deleted empty labels (after expand compounds, for example).
occ::handle<TDataStd_TreeNode> aJumpNode;
if (!aComponent.FindAttribute(XCAFDoc::ShapeRefGUID(), aJumpNode))
{
continue;
}
// Jump to the referred object (the original).
TDF_Label aChildOriginal;
if (!aJumpNode.IsNull() && aJumpNode->HasFather())
{
aChildOriginal = aJumpNode->Father()->Label(); // Declaration-level origin.
}
if (aChildOriginal.IsNull())
{
continue;
}
// Add child
const int aChildId = addNode(aChildOriginal, aComponentId);
if (aChildId == 0)
{
continue;
}
// Process children: add components recursively.
addComponents(aChildOriginal, aChildId);
}
}
//=================================================================================================
int XCAFDoc_AssemblyGraph::addNode(const TDF_Label& theLabel, const int theParentId)
{
NodeType aNodeType = NodeType_UNDEFINED;
if (myShapeTool->IsAssembly(theLabel))
{
if (myShapeTool->IsFree(theLabel))
{
aNodeType = NodeType_AssemblyRoot;
}
else
{
aNodeType = NodeType_Subassembly;
}
}
else if (myShapeTool->IsReference(theLabel))
{
aNodeType = NodeType_Occurrence;
}
else if (myShapeTool->IsSubShape(theLabel))
{
aNodeType = NodeType_Subshape;
}
else if (myShapeTool->IsSimpleShape(theLabel))
{
aNodeType = NodeType_Part;
}
if (aNodeType == NodeType_UNDEFINED)
{
return 0;
}
// Get ID of the insertion-level node in the abstract assembly graph.
const int aChildId = myNodes.Add(theLabel);
myNodeTypes.Bind(aChildId, aNodeType);
if (aNodeType != NodeType_Occurrence)
{
// Bind usage occurrences.
int* aUsageOQPtr = myUsages.ChangeSeek(aChildId);
if (aUsageOQPtr == nullptr)
{
aUsageOQPtr = myUsages.Bound(aChildId, 1);
}
else
{
++(*aUsageOQPtr);
}
}
if (theParentId > 0)
{
// Add link
TColStd_PackedMapOfInteger* aMapPtr = myAdjacencyMap.ChangeSeek(theParentId);
if (aMapPtr == nullptr)
{
aMapPtr = myAdjacencyMap.Bound(theParentId, TColStd_PackedMapOfInteger());
}
(*aMapPtr).Add(aChildId);
}
return aChildId;
}
// =======================================================================
// function : Iterator constructor
// purpose : Iteration starts from the specified node.
// =======================================================================
XCAFDoc_AssemblyGraph::Iterator::Iterator(const occ::handle<XCAFDoc_AssemblyGraph>& theGraph,
const int theNode)
{
Standard_NullObject_Raise_if(theGraph.IsNull(), "Null assembly graph!");
Standard_NullObject_Raise_if(theNode < 1, "Node ID must be positive one-based integer!");
myGraph = theGraph;
myCurrentIndex = theNode;
}