From ba7986fce372967dfff572a3a17ebef7ee6ca7d4 Mon Sep 17 00:00:00 2001
From: Danny Robson <danny@nerdcruft.net>
Date: Fri, 8 Nov 2024 14:36:41 +1000
Subject: [PATCH] region: add 'path' query for segments

---
 cruft/util/region.hpp | 20 ++++++++++++++++++++
 test/region.cpp       | 26 ++++++++++++++++++++++++++
 2 files changed, 46 insertions(+)

diff --git a/cruft/util/region.hpp b/cruft/util/region.hpp
index 9e6bb65d..8e2a227f 100644
--- a/cruft/util/region.hpp
+++ b/cruft/util/region.hpp
@@ -370,6 +370,26 @@ namespace cruft {
     rotate90 (cruft::region2<T> obj, int steps);
 
 
+    ///////////////////////////////////////////////////////////////////////////
+    /// Returns the vertices of the region (excluding last->first vertex) in
+    /// CCW winding.
+    ///
+    /// It assumes the base position is the min / extent is strictly positive.
+    template <typename T>
+    std::array<cruft::point2<T>, 4>
+    path (cruft::region2<T> const &obj)
+    {
+        CHECK (all (obj.e > 0));
+
+        return {
+            obj.p,
+            obj.p + vector2<T> {      0, obj.e.h },
+            obj.p + vector2<T> {obj.e.w, obj.e.h },
+            obj.p + vector2<T> {obj.e.w,       0 },
+        };
+    }
+
+
     ///////////////////////////////////////////////////////////////////////////
     template <size_t S, typename T>
     std::ostream& operator<< (std::ostream&, const cruft::region<S,T>&);
diff --git a/test/region.cpp b/test/region.cpp
index cdaa8730..90093f4f 100644
--- a/test/region.cpp
+++ b/test/region.cpp
@@ -286,5 +286,31 @@ main (int, char **)
         }
     }
 
+    // Test that 'path' returns expected values
+    {
+        //  (-5, 3)   (1, 3)
+        //
+        //
+        //  (-5,-4)*  (1,-4)
+        //
+        //  Start at the bottom right corner.
+
+        cruft::region2i const shape {
+            cruft::point2i { -5, -4, },
+            cruft::point2i {  1,  3, },
+        };
+
+        cruft::point2i const expected[] = {
+            cruft::point2i {  -5, -4  },
+            cruft::point2i {  -5,  3  },
+            cruft::point2i {   1,  3  },
+            cruft::point2i {   1, -4  },
+        };
+
+        auto const computed = path (shape);
+
+        tap.expect (std::ranges::equal (computed, expected), "region2i path");
+    }
+
     return tap.status ();
 }