link: GridPortalLink graphical doc comment

acts-project · Aug 21, 2024 · 6a06360 · 6a06360
1 parent c33d0d9
commit 6a06360
Showing 1 changed file with 64 additions and 0 deletions.
diff --git a/Core/include/Acts/Geometry/GridPortalLink.hpp b/Core/include/Acts/Geometry/GridPortalLink.hpp
@@ -69,6 +69,70 @@ class GridPortalLink : public PortalLinkBase {
       const std::shared_ptr<RegularSurface>& surface, TrackingVolume& volume,
       BinningValue direction);
 
+  /// +----------------------------------------------------------+
+  /// |Colinear                                                  |
+  /// |                                                          |
+  /// | +-------+-------+-------+     +-------+-------+-------+  |
+  /// | |       |       |       |     |       |       |       |  |
+  /// | |       |       |       |  +  |       |       |       |  |
+  /// | |       |       |       |     |       |       |       |  |
+  /// | +-------+-------+-------+     +-------+-------+-------+  |
+  /// |       +-------+-------+-------+-------+-------+-------+  |
+  /// |       |       |       |       |       |       |       |  |
+  /// |    =  |       |       |       |       |       |       |  |
+  /// |       |       |       |       |       |       |       |  |
+  /// |       +-------+-------+-------+-------+-------+-------+  |
+  /// |                                                          |
+  /// +----------------------------------------------------------+
+  ///
+  /// +-------------------------------------------------+
+  /// |Parallel                                         |
+  /// |                                                 |
+  /// | +-------+      +-------+     +-------+-------+  |
+  /// | |       |      |       |     |       |       |  |
+  /// | |       |      |       |     |       |       |  |
+  /// | |       |      |       |     |       |       |  |
+  /// | +-------+      +-------+     +-------+-------+  |
+  /// | |       |      |       |     |       |       |  |
+  /// | |       |  +   |       |  =  |       |       |  |
+  /// | |       |      |       |     |       |       |  |
+  /// | +-------+      +-------+     +-------+-------+  |
+  /// | |       |      |       |     |       |       |  |
+  /// | |       |      |       |     |       |       |  |
+  /// | |       |      |       |     |       |       |  |
+  /// | +-------+      +-------+     +-------+-------+  |
+  /// |                                                 |
+  /// +-------------------------------------------------+
+  ///
+  /// +-------------------------------------------+
+  /// |Perpendicular                              |
+  /// |                                           |
+  /// |  +-------+                                |
+  /// |  |       |                                |
+  /// |  |       |                                |
+  /// |  |       |                                |
+  /// |  +-------+     +-------+-------+-------+  |
+  /// |  |       |     |       |       |       |  |
+  /// |  |       |  +  |       |       |       |  |
+  /// |  |       |     |       |       |       |  |
+  /// |  +-------+     +-------+-------+-------+  |
+  /// |  |       |                                |
+  /// |  |       |                                |
+  /// |  |       |     +-------+-------+-------+  |
+  /// |  +-------+     |       |       |       |  |
+  /// |                |       |       |       |  |
+  /// |                |       |       |       |  |
+  /// |                +-------+-------+-------+  |
+  /// |                |       |       |       |  |
+  /// |             =  |       |       |       |  |
+  /// |                |       |       |       |  |
+  /// |                +-------+-------+-------+  |
+  /// |                |       |       |       |  |
+  /// |                |       |       |       |  |
+  /// |                |       |       |       |  |
+  /// |                +-------+-------+-------+  |
+  /// |                                           |
+  /// +-------------------------------------------+
   static std::unique_ptr<PortalLinkBase> merge(
       const GridPortalLink& a, const GridPortalLink& b, BinningValue direction,
       const Logger& logger = getDummyLogger());