Modeling - New BRrep Graph representation (#1166)

Implement new representation of topology and BRep into OCCT. New foundation represent 2 levels: BRepGraph - public interfaces which making the topology graph representation BRepGraphInc - internal structure which represent topology as an incident tables. The foundation provides basic logic for conversion from TopoDS_Shape to BRepGraph and back. The foundation provides the iteration and exploring interfaces to travel in both directions on any level of topology. The internal id type of inc tables is 'int', which is not for long term and can be updated, better to use typed id aliases, even for the iterations, they provide all necessary operators. The access to the BRepGraph is done using multiple View classes available by methods from main class. The extensions on graphs is possible with 'Layer' and 'Cache', where first is persistent, second - temporary, Some basic operations on graph also provided for compact, analyze and copy.
2026-09-05 04:07:58 +08:00 · 2026-04-03 00:51:20 +01:00
parent 8d2d8650ca
commit c765cb4bd2
117 changed files with 49491 additions and 574 deletions
@@ -0,0 +1,237 @@
+// Copyright (c) 2026 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 <BRepGraph.hxx>
+#include <BRepGraph_BuilderView.hxx>
+#include <BRepGraph_TopoView.hxx>
+#include <BRepGraph_UIDsView.hxx>
+#include <BRepGraph_VersionStamp.hxx>
+#include <BRepPrimAPI_MakeBox.hxx>
+#include <Standard_GUID.hxx>
+
+#include <gtest/gtest.h>
+
+class BRepGraph_VersionStampTest : public testing::Test
+{
+protected:
+  void SetUp() override
+  {
+    BRepPrimAPI_MakeBox aBoxMaker(10.0, 20.0, 30.0);
+    const TopoDS_Shape& aBox = aBoxMaker.Shape();
+    myGraph.Build(aBox);
+    ASSERT_TRUE(myGraph.IsDone());
+  }
+
+  BRepGraph myGraph;
+};
+
+// --- VersionStamp struct tests ---
+
+TEST(BRepGraph_VersionStampBasicTest, DefaultStamp_IsInvalid)
+{
+  const BRepGraph_VersionStamp aStamp;
+  EXPECT_FALSE(aStamp.IsValid());
+}
+
+TEST_F(BRepGraph_VersionStampTest, StampOf_ValidNode_ReturnsValidStamp)
+{
+  const BRepGraph_FaceId aFaceId(0);
+  ASSERT_TRUE(aFaceId.IsValid(myGraph.Topo().Faces().Nb()));
+
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(aFaceId);
+  EXPECT_TRUE(aStamp.IsValid());
+  EXPECT_TRUE(aStamp.myUID.IsValid());
+  EXPECT_EQ(aStamp.myMutationGen, 0u);
+  EXPECT_EQ(aStamp.myGeneration, myGraph.UIDs().Generation());
+}
+
+TEST_F(BRepGraph_VersionStampTest, StampOf_InvalidNode_ReturnsInvalid)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_NodeId());
+  EXPECT_FALSE(aStamp.IsValid());
+}
+
+// --- IsStale tests ---
+
+TEST_F(BRepGraph_VersionStampTest, IsStale_UnmutatedNode_ReturnsFalse)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  EXPECT_FALSE(myGraph.UIDs().IsStale(aStamp));
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsStale_MutatedNode_ReturnsTrue)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+
+  // Mutate the face.
+  myGraph.Builder().MutFace(BRepGraph_FaceId(0))->NaturalRestriction = true;
+
+  EXPECT_TRUE(myGraph.UIDs().IsStale(aStamp));
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsStale_RemovedNode_ReturnsTrue)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+
+  myGraph.Builder().RemoveNode(BRepGraph_FaceId(0));
+
+  EXPECT_TRUE(myGraph.UIDs().IsStale(aStamp));
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsStale_DifferentGeneration_ReturnsTrue)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+
+  // Rebuild the graph - generation changes.
+  BRepPrimAPI_MakeBox aBoxMaker(10.0, 20.0, 30.0);
+  myGraph.Build(aBoxMaker.Shape());
+  ASSERT_TRUE(myGraph.IsDone());
+
+  EXPECT_TRUE(myGraph.UIDs().IsStale(aStamp));
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsStale_DeferredMode_TracksCorrectly)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_EdgeId(0));
+
+  // Mutate in deferred mode.
+  myGraph.Builder().BeginDeferredInvalidation();
+  myGraph.Builder().MutEdge(BRepGraph_EdgeId(0))->Tolerance = 0.5;
+  myGraph.Builder().EndDeferredInvalidation();
+
+  EXPECT_TRUE(myGraph.UIDs().IsStale(aStamp));
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsStale_InvalidStamp_ReturnsTrue)
+{
+  const BRepGraph_VersionStamp aStamp;
+  EXPECT_TRUE(myGraph.UIDs().IsStale(aStamp));
+}
+
+// --- Identity and version comparison ---
+
+TEST_F(BRepGraph_VersionStampTest, StampIdentity_SameNode_Equal)
+{
+  const BRepGraph_VersionStamp aStamp1 = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const BRepGraph_VersionStamp aStamp2 = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  EXPECT_EQ(aStamp1, aStamp2);
+}
+
+TEST_F(BRepGraph_VersionStampTest, StampIdentity_DifferentNodes_NotEqual)
+{
+  const BRepGraph_VersionStamp aStamp1 = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const BRepGraph_VersionStamp aStamp2 = myGraph.UIDs().StampOf(BRepGraph_FaceId(1));
+  EXPECT_NE(aStamp1, aStamp2);
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsSameNode_SameVersion_ReturnsTrue)
+{
+  const BRepGraph_VersionStamp aStamp1 = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const BRepGraph_VersionStamp aStamp2 = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  EXPECT_TRUE(aStamp1.IsSameNode(aStamp2));
+}
+
+TEST_F(BRepGraph_VersionStampTest, IsSameNode_DifferentVersion_StillSameNode)
+{
+  const BRepGraph_VersionStamp aStampBefore = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+
+  myGraph.Builder().MutFace(BRepGraph_FaceId(0))->NaturalRestriction = true;
+
+  const BRepGraph_VersionStamp aStampAfter = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+
+  // Full equality fails (different MutationGen).
+  EXPECT_NE(aStampBefore, aStampAfter);
+  // But they refer to the same node (same UID).
+  EXPECT_TRUE(aStampBefore.IsSameNode(aStampAfter));
+}
+
+TEST_F(BRepGraph_VersionStampTest, StampOf_AssemblyNodes_WorksForProductsAndOccurrences)
+{
+  // Box graph auto-creates a root Product.
+  ASSERT_GT(myGraph.Topo().Products().Nb(), 0);
+
+  const BRepGraph_VersionStamp aProdStamp = myGraph.UIDs().StampOf(BRepGraph_ProductId(0));
+  EXPECT_TRUE(aProdStamp.IsValid());
+  EXPECT_FALSE(myGraph.UIDs().IsStale(aProdStamp));
+}
+
+// --- Graph GUID tests ---
+
+TEST_F(BRepGraph_VersionStampTest, GraphGUID_AfterBuild_IsValid)
+{
+  const Standard_GUID& aGUID = myGraph.UIDs().GraphGUID();
+  // A random GUID should not be all zeros.
+  const Standard_GUID aZero;
+  EXPECT_NE(aGUID, aZero);
+}
+
+TEST_F(BRepGraph_VersionStampTest, GraphGUID_Rebuild_Changes)
+{
+  const Standard_GUID aGUID1 = myGraph.UIDs().GraphGUID();
+
+  BRepPrimAPI_MakeBox aBoxMaker(10.0, 20.0, 30.0);
+  myGraph.Build(aBoxMaker.Shape());
+  ASSERT_TRUE(myGraph.IsDone());
+
+  const Standard_GUID aGUID2 = myGraph.UIDs().GraphGUID();
+  // Two random GUIDs should differ (probability of collision is negligible).
+  EXPECT_NE(aGUID1, aGUID2);
+}
+
+// --- ToGUID tests ---
+
+TEST_F(BRepGraph_VersionStampTest, ToGUID_Deterministic_SameInputSameOutput)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const Standard_GUID&         aGraph = myGraph.UIDs().GraphGUID();
+  const Standard_GUID          aGUID1 = aStamp.ToGUID(aGraph);
+  const Standard_GUID          aGUID2 = aStamp.ToGUID(aGraph);
+  EXPECT_EQ(aGUID1, aGUID2);
+}
+
+TEST_F(BRepGraph_VersionStampTest, ToGUID_DifferentMutationGen_DifferentGUID)
+{
+  const BRepGraph_VersionStamp aStampBefore = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const Standard_GUID&         aGraph       = myGraph.UIDs().GraphGUID();
+  const Standard_GUID          aGUIDBefore  = aStampBefore.ToGUID(aGraph);
+
+  myGraph.Builder().MutFace(BRepGraph_FaceId(0))->NaturalRestriction = true;
+
+  const BRepGraph_VersionStamp aStampAfter = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const Standard_GUID          aGUIDAfter  = aStampAfter.ToGUID(aGraph);
+
+  EXPECT_NE(aGUIDBefore, aGUIDAfter);
+}
+
+TEST_F(BRepGraph_VersionStampTest, ToGUID_DifferentGraphGUID_DifferentGUID)
+{
+  const BRepGraph_VersionStamp aStamp = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+
+  const Standard_GUID aGraphA("a1b2c3d4-e5f6-7890-abcd-ef0123456789");
+  const Standard_GUID aGraphB("11223344-5566-7788-99aa-bbccddeeff00");
+
+  const Standard_GUID aGUIDA = aStamp.ToGUID(aGraphA);
+  const Standard_GUID aGUIDB = aStamp.ToGUID(aGraphB);
+
+  EXPECT_NE(aGUIDA, aGUIDB);
+}
+
+TEST_F(BRepGraph_VersionStampTest, ToGUID_DifferentNodes_DifferentGUID)
+{
+  const Standard_GUID& aGraph = myGraph.UIDs().GraphGUID();
+
+  const BRepGraph_VersionStamp aStamp0 = myGraph.UIDs().StampOf(BRepGraph_FaceId(0));
+  const BRepGraph_VersionStamp aStamp1 = myGraph.UIDs().StampOf(BRepGraph_FaceId(1));
+
+  EXPECT_NE(aStamp0.ToGUID(aGraph), aStamp1.ToGUID(aGraph));
+}