hexagon tests

CHANGELOG.md

@@ -1,12 +1,12 @@
 # Changelog
 
-## [v3.4.0] - forthcoming 
+## [v3.4.0] - 2022-07-13 09:01:18
 
 ### Added
 
 - BoundingBox() can be used on Tables and table cells (needs tests)
 
-- first pass at hexagon constructors 
+- hexagon constructors 
 
 ### Changed
 
@@ -18,6 +18,8 @@
 
 ### Removed
 
+- some old unused stuff
+
 ### Deprecated
 
 # ────────────────────────────────────────────────────────────────────────────────────

docs/src/howto/tables-grids.md

@@ -416,3 +416,22 @@ for i in 1:10
 end
 end # hide
 ```
+
+### Spiralling hexagons
+
+```@example
+using Luxor # hide
+using Colors # hide
+
+@drawsvg begin # hide
+background("black")
+hexagon = HexagonOffsetEvenR(0, 0, 16)
+setline(0.75)
+for h in hexspiral(hexagon, 10)
+    sethue(HSB(mod1(5n, 360), 0.8, 0.8))
+    poly(hextile(h), :fillpreserve)
+    sethue("black")
+    strokepath()
+end
+end 600 600 # hide
+```

src/Luxor.jl

@@ -154,7 +154,7 @@ export Drawing,
     HexagonAxial, HexagonCubic, HexagonOffsetOddR, HexagonOffsetEvenR,
     # hexagon, 
     hexcenter, hexcube_round, hexcube_linedraw,
-    HexagonVertexIterator, hextile,
+    HexagonVertexIterator, hextile, hexspiral,
     HexagonNeighborIterator, hexneighbors,
     HexagonDiagonalIterator, hexdiagonals,
     HexagonDistanceIterator, hexagons_within,

src/hexagons.jl

@@ -78,20 +78,6 @@ struct HexagonCubic <: Hexagon
     height::Float64
 end
 
-# """
-#     hexagon(q::Int64, r::Int64, s::Int64)
-
-# calls HexagonCubic(q, r, s, Point(0, 0), 10.0, 10.0)
-# """
-# hexagon(q::Int64, r::Int64, s::Int64) = HexagonCubic(q, r, s, Point(0, 0), 10.0, 10.0)
-
-# """
-#     hexagon(q::Int64, r::Int64)
-
-# calls HexagonAxial(q, r, Point(0, 0), 10.0, 10.0)
-# """
-# hexagon(q::Int64, r::Int64) = HexagonAxial(q, r, Point(0, 0), 10.0, 10.0)
-
 HexagonAxial(q, r) = HexagonAxial(q, r, Point(0, 0), 10.0, 10.0)
 HexagonAxial(q, r, o::Point) = HexagonAxial(q, r, o, 10.0, 10.0)
 HexagonAxial(q, r, w) = HexagonAxial(q, r, Point(0, 0), w, w)
@@ -352,8 +338,7 @@ hexring(hex::Hexagon, n::Int) = hexring(n, hex)
 
 Base.length(it::HexagonRingIterator) = it.n * 6
 
-function Base.iterate(it::HexagonRingIterator,
-    state::(Tuple{Int,HexagonCubic}) = (1, hexneighbor(it.hex, 5, it.n)))
+function Base.iterate(it::HexagonRingIterator, state::(Tuple{Int,HexagonCubic}) = (1, hexneighbor(it.hex, 5, it.n)))
     hex_i, cur_hex = state
     hex_i > length(it) && return nothing
     ring_part = div(hex_i - 1, it.n) + 1
@@ -365,6 +350,23 @@ function Base.collect(it::HexagonRingIterator)
     collect(HexagonCubic, it)
 end
 
+"""
+    hexspiral(hex, n)
+
+Return an array of hexagons to spiral around a central hexagon forming `n` rings.
+"""
+function hexspiral(hex, nrings)
+    result = Luxor.Hexagon[]
+    ringn = 1
+    while ringn < nrings
+        hexes = collect(hexring(hex, ringn))
+        circshift!(hexes, 1)
+        append!(result, hexes)
+        ringn += 1
+    end
+    return result
+end
+
 """
     distance(h1::Hexagon, h2::Hexagon)
 
@@ -402,7 +404,7 @@ end
 """
     hexcube_linedraw(hexa::Hexagon, hexb::Hexagon)
 
-Find and return the hexagons that lie (mostly) on a straight line between `hexa` and `hexb`.
+Find and return the hexagons that lie (mostly) on a straight line between `hexa` and `hexb`. If you filled/stroked them appropriately, you'd get a jagged line.
 """
 function hexcube_linedraw(a::Hexagon, b::Hexagon)
     hexa = convert(HexagonCubic, a)

test/grid-test.jl

@@ -10,7 +10,6 @@ function grid_test(fname)
     background("white")
 
     panes = Tiler(Luxor.current_width(), Luxor.current_height(), 1, 2)
-    @show panes
     @layer begin
         translate(first(panes[1]))
         circle(O, 10, :fill)

test/tiling-images.jl

@@ -12,7 +12,6 @@ function get_png_files()
     folder = dirname(dirname(pathof(Luxor))) * "/docs/src/assets/figures/"
     imagelist = filter(f -> !startswith(f, ".") && endswith(f, "png"), readdir(folder))
     imagepathlist = map(fn -> folder * "/" * fn, imagelist)
-    @show imagepathlist
     return imagepathlist
 end