Skip to content

Make most dependencies private; document dependencies with graphviz #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 30, 2025
Merged

Make most dependencies private; document dependencies with graphviz #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93dcfc9
Make most dependencies private; document dependencies with graphviz
zfergus Jul 30, 2025
c575980
Fix STQ Pimpl
zfergus Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,3 +670,4 @@ python/update_bindings.py

# External test data
tests/data
CMakeGraphVizOptions.cmake
14 changes: 7 additions & 7 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,30 +154,30 @@ target_link_libraries(ipc_toolkit PUBLIC Eigen3::Eigen)

# libigl
include(libigl)
target_link_libraries(ipc_toolkit PUBLIC igl::core igl::predicates)
target_link_libraries(ipc_toolkit PRIVATE igl::core igl::predicates)

# TBB
include(onetbb)
target_link_libraries(ipc_toolkit PUBLIC TBB::tbb)
target_link_libraries(ipc_toolkit PRIVATE TBB::tbb)

# Provably conservative CCD of [Wang and Ferguson et al. 2021]
include(tight_inclusion)
target_link_libraries(ipc_toolkit PUBLIC tight_inclusion::tight_inclusion)
target_link_libraries(ipc_toolkit PRIVATE tight_inclusion::tight_inclusion)

# Scalable CCD (STQ broad phase and GPU Tight Inclusion)
include(scalable_ccd)
target_link_libraries(ipc_toolkit PUBLIC scalable_ccd::scalable_ccd)
target_link_libraries(ipc_toolkit PRIVATE scalable_ccd::scalable_ccd)

# CCD
if(IPC_TOOLKIT_WITH_INEXACT_CCD)
# Etienne Vouga's CTCD Library for the floating point root finding algorithm
include(evouga_ccd)
target_link_libraries(ipc_toolkit PUBLIC evouga::ccd)
target_link_libraries(ipc_toolkit PRIVATE evouga::ccd)
endif()

# SimpleBVH
include(simple_bvh)
target_link_libraries(ipc_toolkit PUBLIC simple_bvh::simple_bvh)
target_link_libraries(ipc_toolkit PRIVATE simple_bvh::simple_bvh)

# Logger
include(spdlog)
Expand All @@ -186,7 +186,7 @@ target_link_libraries(ipc_toolkit PUBLIC spdlog::spdlog)
# rational-cpp (requires GMP)
if(IPC_TOOLKIT_WITH_RATIONAL_INTERSECTION)
include(rational_cpp)
target_link_libraries(ipc_toolkit PUBLIC rational::rational)
target_link_libraries(ipc_toolkit PRIVATE rational::rational)
endif()

# Faster unordered map
Expand Down
4 changes: 2 additions & 2 deletions cmake/recipes/abseil.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ endif()

message(STATUS "Third-party: creating target 'absl::flat_hash_map'")

option(ABSL_PROPAGATE_CXX_STD "Use CMake C++ standard meta features (e.g. cxx_std_11) that propagate to targets that link to Abseil" ON)
option(ABSL_PROPAGATE_CXX_STD "Use CMake C++ standard meta features (e.g. cxx_std_17) that propagate to targets that link to Abseil" ON)
option(ABSL_USE_SYSTEM_INCLUDES "Silence warnings in Abseil headers by marking them as SYSTEM includes" ON)
option(ABSL_BUILD_TESTING "If ON, Abseil will build all of Abseil's own tests." OFF)
set(ABSL_IDE_FOLDER "ThirdParty/Abseil")

include(CPM)
CPMAddPackage("gh:abseil/abseil-cpp#20230125.3")
CPMAddPackage("gh:abseil/abseil-cpp#20250512.1")
81 changes: 81 additions & 0 deletions docs/source/_static/graphviz/dependencies.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
digraph "IPC Toolkit Dependencies" {
bgcolor = "transparent";
splines = ortho;
layout = dot;
// nodesep = 0.1;
ranksep = 0.5;
node [fontname = "Menlo"; style = filled; penwidth = 2;];
edge [penwidth = 2; fontname = "Menlo";];
subgraph clusterLegend {
label = "Legend";
color = "grey";
fontcolor = "grey";
fontname = "Avenir Medium";
penwidth = 2;
node [fontname = "Avenir Light";];
edge [fontname = "Avenir Light";];
legendNode0 [label = "Static Library";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
legendNode1 [label = "Shared Library";shape = box;style = "rounded,filled";fillcolor = "#CCE7F8";color = "#6596B2";];
legendNode2 [label = "Interface Library";shape = box;style = "rounded,filled";fillcolor = "#FFE6CC";color = "#DAA52D";];
legendNode0 -> legendNode1 [label = "Public"; color = "#8FB976"; fontcolor = "#8FB976";];
legendNode2 -> legendNode0 [label = "Interface"; color = "#DAA52D"; fontcolor = "#DAA52D";];
legendNode1 -> legendNode2 [label = "Private"; color = "#BE6562"; fontcolor = "#BE6562";];
}
// Force ipc_toolkit to top
subgraph {
rank = "source";
"node5";
}
"node0" [label = "Eigen3_Eigen\n(Eigen3::Eigen)";shape = box;style = "rounded,filled";fillcolor = "#FFE6CC";color = "#DAA52D";];
"node1" [label = "filib\n(filib::filib)";shape = box;style = "rounded,filled";fillcolor = "#CCE7F8";color = "#6596B2";];
"node2" [label = "igl_core\n(igl::core)";shape = box;style = "rounded,filled";fillcolor = "#FFE6CC";color = "#DAA52D";];
"node2" -> "node0" [color = "#DAA52D";];
// igl_core -> Eigen3_Eigen
"node3" [label = "igl_predicates\n(igl::predicates)";shape = box;style = "rounded,filled";fillcolor = "#FFE6CC";color = "#DAA52D";];
"node3" -> "node2" [color = "#DAA52D";];
// igl_predicates -> igl_core
"node4" [label = "predicates\n(predicates::predicates)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node3" -> "node4" [color = "#DAA52D";];
// igl_predicates -> predicates
"node5" [label = "ipc_toolkit\n(ipc::toolkit)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node5" -> "node0" [color = "#8FB976";];
// ipc_toolkit -> Eigen3_Eigen
"node5" -> "node1" [color = "#8FB976";];
// ipc_toolkit -> filib
"node5" -> "node2" [color = "#BE6562";];
// ipc_toolkit -> igl_core
"node5" -> "node3" [color = "#BE6562";];
// ipc_toolkit -> igl_predicates
"node6" [label = "robin_map\n(tsl::robin_map)";shape = box;style = "rounded,filled";fillcolor = "#FFE6CC";color = "#DAA52D";];
"node5" -> "node6" [color = "#8FB976";];
// ipc_toolkit -> robin_map
"node7" [label = "scalable_ccd\n(scalable_ccd::scalable_ccd)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node7" -> "node0" [color = "#8FB976";];
// scalable_ccd -> Eigen3_Eigen
"node8" [label = "spdlog\n(spdlog::spdlog)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node7" -> "node8" [color = "#8FB976";];
// scalable_ccd -> spdlog
"node9" [label = "tbb\n(TBB::tbb)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node7" -> "node9" [color = "#BE6562";];
// scalable_ccd -> tbb
"node5" -> "node7" [color = "#BE6562";];
// ipc_toolkit -> scalable_ccd
"node10" [label = "simple_bvh\n(simple_bvh::simple_bvh)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node10" -> "node0" [color = "#8FB976";];
// simple_bvh -> Eigen3_Eigen
"node5" -> "node10" [color = "#BE6562";];
// ipc_toolkit -> simple_bvh
"node5" -> "node8" [color = "#8FB976";];
// ipc_toolkit -> spdlog
"node5" -> "node9" [color = "#BE6562";];
// ipc_toolkit -> tbb
"node11" [label = "tight_inclusion\n(tight_inclusion::tight_inclusion)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node11" -> "node0" [color = "#8FB976";];
// tight_inclusion -> Eigen3_Eigen
"node11" -> "node8" [color = "#8FB976";];
// tight_inclusion -> spdlog
"node5" -> "node11" [color = "#BE6562";];
// ipc_toolkit -> tight_inclusion
"node12" [label = "absl_hash\n(absl::hash)";shape = box;style = "rounded,filled";fillcolor = "#D5E8D4";color = "#8FB976";];
"node5" -> "node12" [color = "#8FB976";];
}
Loading
Loading