From 2acc4e7e93884e867182e6a120af34cd8ffa0a7f Mon Sep 17 00:00:00 2001
From: David Vogel <Dadido3@aol.com>
Date: Sat, 23 Jul 2022 10:55:44 +0200
Subject: [PATCH] Move hilbert curve lib into library directory

---
 files/capture.lua                             |  5 +++-
 .../hilbert-curve.lua}                        | 25 ++++++++++++++++---
 2 files changed, 25 insertions(+), 5 deletions(-)
 rename files/{hilbert.lua => libraries/hilbert-curve.lua} (54%)

diff --git a/files/capture.lua b/files/capture.lua
index d6fe224..c2fd9bf 100644
--- a/files/capture.lua
+++ b/files/capture.lua
@@ -6,6 +6,9 @@
 ---@type NoitaEntityAPI
 local EntityAPI = dofile_once("mods/noita-mapcap/files/libraries/noita-api/entity.lua")
 
+---@type HilbertLib
+local Hilbert = dofile_once("mods/noita-mapcap/files/libraries/hilbert-curve.lua")
+
 ---@type JSONLib
 local json = dofile_once("mods/noita-mapcap/files/libraries/json.lua")
 
@@ -354,7 +357,7 @@ function startCapturingHilbert(area)
 	async(
 		function()
 			while t < tLimit do
-				local hx, hy = mapHilbert(t, gridPOTSize)
+				local hx, hy = Hilbert.Map(t, gridPOTSize)
 				if hx < gridWidth and hy < gridHeight then
 					local x, y = (hx + gridLeft) * CAPTURE_GRID_SIZE, (hy + gridTop) * CAPTURE_GRID_SIZE
 					x, y = x + 256, y + 256 -- Align screen with ingame chunk grid that is 512x512.
diff --git a/files/hilbert.lua b/files/libraries/hilbert-curve.lua
similarity index 54%
rename from files/hilbert.lua
rename to files/libraries/hilbert-curve.lua
index c7e4352..ef44708 100644
--- a/files/hilbert.lua
+++ b/files/libraries/hilbert-curve.lua
@@ -1,8 +1,19 @@
--- Copyright (c) 2019-2020 David Vogel
+-- Copyright (c) 2019-2022 David Vogel
 --
 -- This software is released under the MIT License.
 -- https://opensource.org/licenses/MIT
 
+---@class HilbertLib
+local Hilbert = {}
+
+---Rotate/flip quadrant.
+---@param n integer
+---@param x integer
+---@param y integer
+---@param rx boolean
+---@param ry boolean
+---@return integer
+---@return integer
 local function hilbertRotate(n, x, y, rx, ry)
 	if not ry then
 		if rx then
@@ -15,13 +26,17 @@ local function hilbertRotate(n, x, y, rx, ry)
 	return x, y
 end
 
--- Maps a variable t to a hilbert curve with the side length of 2^potSize (Power of two size)
-function mapHilbert(t, potSize)
+---Maps t in the range of [0, (2^potSize)^2-1] to a position on the hilbert curve with the side length of 2^potSize (Power of two size).
+---@param t integer
+---@param potSize integer
+---@return integer
+---@return integer
+function Hilbert.Map(t, potSize)
 	local size = math.pow(2, potSize)
 	local x, y = 0, 0
 
 	if t < 0 or t >= size * size then
-		error("Variable t is outside of the range")
+		error("variable t is outside of the range")
 	end
 
 	for i = 0, potSize - 1, 1 do
@@ -46,3 +61,5 @@ function mapHilbert(t, potSize)
 
 	return x, y
 end
+
+return Hilbert