Renamed the library to Easy Spatial Navigation.

Author: Espyo

.gitignore

@@ -14,7 +14,7 @@ allegro.log
 *.aps
 game_data/test/*
 user_data/*
-spat_nav_tests
+easy_spat_nav_tests
 /pikifen
 /pikifen_shortcut
 /pikifen*.exe

source/source/content/other/gui.cpp

@@ -862,7 +862,7 @@ bool GuiManager::draw() {
         );
     }
 
-#ifdef SPAT_NAV_DEBUG
+#ifdef EASY_SPAT_NAV_DEBUG
     for(const auto& i : sNInterface.lastNavInfo) {
         al_draw_filled_circle(
             i.second.focusX, i.second.focusY, 3, al_map_rgb(0, 0, 255)
@@ -1322,16 +1322,16 @@ void GuiManager::handleSpatialNavigationAction(const Inpution::Action& action) {
     //Fill in the data for the spatial navigation algorithm.
     sNInterface.clearItems();
     bool hasItems = false;
-    SpatNav::DIRECTION direction = SpatNav::DIRECTION_RIGHT;
+    EasySpatNav::DIRECTION direction = EasySpatNav::DIRECTION_RIGHT;
     switch(action.actionTypeId) {
     case PLAYER_ACTION_TYPE_MENU_UP: {
-        direction = SpatNav::DIRECTION_UP;
+        direction = EasySpatNav::DIRECTION_UP;
         break;
     } case PLAYER_ACTION_TYPE_MENU_LEFT: {
-        direction = SpatNav::DIRECTION_LEFT;
+        direction = EasySpatNav::DIRECTION_LEFT;
         break;
     } case PLAYER_ACTION_TYPE_MENU_DOWN: {
-        direction = SpatNav::DIRECTION_DOWN;
+        direction = EasySpatNav::DIRECTION_DOWN;
         break;
     }
     }

source/source/content/other/gui.h

@@ -22,7 +22,7 @@
 #include "../../core/controls_mediator.h"
 #include "../../core/misc_structs.h"
 #include "../../lib/data_file/data_file.h"
-#include "../../lib/spatial_navigation/spatial_navigation.h"
+#include "../../lib/easy_spat_nav/easy_spat_nav.h"
 #include "../../util/drawing_utils.h"
 #include "../../util/general_utils.h"
 #include "../../util/geometry_utils.h"
@@ -797,7 +797,7 @@ class GuiManager {
     bool visible = true;
 
     //Spatial navigation algorithm interface.
-    SpatNav::Interface sNInterface;
+    EasySpatNav::Interface sNInterface;
 
     //Focus cursor.
     struct FocusCursor {

source/source/lib/spatial_navigation/spatial_navigation.cpp renamed to source/source/lib/easy_spat_nav/easy_spat_nav.cpp

@@ -2,7 +2,7 @@
  * Copyright (c) Andre 'Espyo' Silva 2013.
  *
  * === FILE DESCRIPTION ===
- * Source code for the spatial navigation library.
+ * Source code for the Easy Spatial Navigation library.
  * Please read the included readme file.
  */
 
@@ -11,10 +11,10 @@
 #include <float.h>
 #include <limits.h>
 
-#include "spatial_navigation.h"
+#include "easy_spat_nav.h"
 
 
-namespace SpatNav {
+namespace EasySpatNav {
 
 
 /**
@@ -124,7 +124,7 @@ void* Interface::doNavigation(
 ) {
     //Setup.
 
-#ifdef SPAT_NAV_DEBUG
+#ifdef EASY_SPAT_NAV_DEBUG
     lastNavInfo.clear();
 #endif
 
@@ -289,7 +289,7 @@ void Interface::getBestItem(
             *bestItemId = i.first;
         }
 
-#ifdef SPAT_NAV_DEBUG
+#ifdef EASY_SPAT_NAV_DEBUG
         lastNavInfo[i.first].score = score;
         lastNavInfo[i.first].accepted = true;
         lastNavInfo[i.first].looped = loopedItems;
@@ -371,7 +371,7 @@ void Interface::getItemDiffs(
     *outDiffX = itemX - workingX;
     *outDiffY = itemY - workingY;
 
-#ifdef SPAT_NAV_DEBUG
+#ifdef EASY_SPAT_NAV_DEBUG
     lastNavInfo[iPtr->id].focusX = workingX;
     lastNavInfo[iPtr->id].focusY = workingY;
     lastNavInfo[iPtr->id].itemX = itemX;
@@ -453,7 +453,7 @@ void Interface::getItemRelativeUnits(
     if(heuristics.centerOnly) {
         diffX = iPtr->flatX - focusX;
         diffY = iPtr->flatY - focusY;
-#ifdef SPAT_NAV_DEBUG
+#ifdef EASY_SPAT_NAV_DEBUG
         lastNavInfo[iPtr->id].focusX = focusX;
         lastNavInfo[iPtr->id].focusY = focusY;
         lastNavInfo[iPtr->id].itemX = iPtr->flatX;

source/source/lib/spatial_navigation/spatial_navigation.h renamed to source/source/lib/easy_spat_nav/easy_spat_nav.h

@@ -2,7 +2,7 @@
  * Copyright (c) Andre 'Espyo' Silva 2025.
  *
  * === FILE DESCRIPTION ===
- * Header for the spatial navigation library.
+ * Header for the Easy Spatial Navigation library.
  * Please read the included readme file.
  */
 
@@ -14,10 +14,10 @@
 #include <vector>
 
 
-//#define SPAT_NAV_DEBUG
+//#define EASY_SPAT_NAV_DEBUG
 
 
-namespace SpatNav {
+namespace EasySpatNav {
 
 //Full circle, in radians.
 constexpr const float TAU = (float) M_PI * 2.0f;
@@ -118,7 +118,7 @@ class Interface {
     } heuristics;
 
 
-#ifdef SPAT_NAV_DEBUG
+#ifdef EASY_SPAT_NAV_DEBUG
 
     /**
      * @brief Represents an item when it was checked for the latest navigation.

source/source/lib/spatial_navigation/readme.md renamed to source/source/lib/easy_spat_nav/readme.md

@@ -1,6 +1,6 @@
-# Spatial Navigation
+# Easy Spatial Navigation
 
-Espyo's GUI spatial navigation algorithm.
+Espyo's Easy Spatial Navigation algorithm for GUIs.
 
 > * [Overview](#overview)
 > * [Quick example](#quick-example)
@@ -24,29 +24,30 @@ Spatial navigation is surprisingly tricky. Guessing which GUI item the user want
 ## Quick example
 
 ```cpp
-#include "spatial_navigation.h"
+#include "easy_spat_nav.h"
 #include "my_program_stuff.h"
 
 // (...)
 
-void myProgram::doSpatialNavigation(SpatNav::DIRECTION direction) {
-    SpatNav::Interface spatNavManager;
+void myProgram::doSpatialNavigation(EGSpatNav::DIRECTION direction) {
+    EasySpatNav::Interface esnInterface;
 
     for(const auto& item : myProgram.currentGUI.items) {
         if(!item.canBeFocused()) continue;
-        spatNavManager.addItem((void*) item, item.center.x, item.center.y, item.size.x, item.size.y);
+        esnInterface.addItem((void*) item, item.center.x, item.center.y, item.size.x, item.size.y);
     }
 
-    GuiItem* targetItemPtr = (MyProgram::GuiItem*) spatNavManager.navigate(direction, (void*) myProgram.currentGui.focusedItem);
+    MyProgram::GuiItem* targetItemPtr =
+        (MyProgram::GuiItem*) esnInterface.navigate(direction, (void*) myProgram.currentGui.focusedItem);
 }
 ```
 
 ## Features
 
-* Support for looping around the edges of the GUI (see `Manager::settings`).
-* Support for parent items that have children items that can overflow inside (see `Manager::setParentItem`).
-* Customizable heuristics (see `Manager::heuristics`).
-* Basic debugging logic (see `SPAT_NAV_DEBUG`).
+* Support for looping around the edges of the GUI (see `Interface::settings`).
+* Support for parent items that have children items that can overflow inside (see `Interface::setParentItem`).
+* Customizable heuristics (see `Interface::heuristics`).
+* Basic debugging logic (see `EASY_SPAT_NAV_DEBUG`).
 * Fairly light, and fairly simple.
 * Very agnostic, and with no external dependencies.
 * Simple unit test coverage for the library itself.
@@ -67,9 +68,9 @@ void myProgram::doSpatialNavigation(SpatNav::DIRECTION direction) {
 * When looping through an edge of the GUI, it's skipping over an item.
   * Make sure there's at least a small gap between the items and the edges of the GUI. If it doesn't, you can manually grow the limits by 0.01 without any real drawback.
 * The algorithm is picking the wrong item and I can't understand why.
-  * Try defining `SPAT_NAV_DEBUG` (or uncomment its line near the top of the header file). Then on every frame draw onto the window the contents provided by `Manager::lastNavInfo` in whatever way you want. This should help you understand what the algorithm is doing and what you can customize to make it do what you want.
+  * Try defining `EASY_SPAT_NAV_DEBUG` (or uncomment its line near the top of the header file). Then on every frame draw onto the window the contents provided by `Interface::lastNavInfo` in whatever way you want. This should help you understand what the algorithm is doing and what you can customize to make it do what you want.
 * There's an item a bit out of the way, but I can't seem to reach it.
-  * Try `Manager::heuristics::singleLoopPass`.
+  * Try `Interface::heuristics::singleLoopPass`.
 
 
 ## Inner workings notes

source/source/lib/spatial_navigation/tests/makefile renamed to source/source/lib/easy_spat_nav/tests/makefile

@@ -1,8 +1,8 @@
-# Makefile for the spatial navigation library's test framework. This should be run in the tests folder.
+# Makefile for the Easy Spatial Navigation library's test framework. This should be run in the tests folder.
 
 
 # Basics.
-PROG         := spat_nav_tests
+PROG         := easy_spat_nav_tests
 CXX          := g++
 SRCS         := $(shell find .. -name '*.cpp')
 OBJS         := $(SRCS:.cpp=.o)

source/source/lib/spatial_navigation/tests/tests_main.cpp renamed to source/source/lib/easy_spat_nav/tests/tests_main.cpp

@@ -2,14 +2,14 @@
  * Copyright (c) Andre 'Espyo' Silva 2025.
  *
  * === FILE DESCRIPTION ===
- * Unit tests for the spatial navigation library.
+ * Unit tests for the Easy Spatial Navigation library.
  * Please read the included readme file.
  */
 
 #include <vector>
 #include <string>
 
-#include "../spatial_navigation.h"
+#include "../easy_spat_nav.h"
 
 
 constexpr const char* COLOR_BOLD = "\033[1m";
@@ -186,15 +186,15 @@ void SpatNavTestInterface::fromString(const std::string& s) {
 
 
 /**
- * @brief Recursively adds children interfaces to the SpatNav manager.
+ * @brief Recursively adds children interfaces to the EasySpatNav manager.
  * 
  * @param manager The manager.
  * @param interface Interface whose children to add.
  * @param itemNr Current item number.
  * @param interfaceFirstItemNr Item number of the first item in the interface.
  */
 void addChildren(
-    SpatNav::Interface& manager, SpatNavTestInterface* interface,
+    EasySpatNav::Interface& manager, SpatNavTestInterface* interface,
     size_t& itemNr, size_t interfaceFirstItemNr
 ) {
     for(size_t ci = 0; ci < interface->children.size(); ci++) {
@@ -273,12 +273,12 @@ void test(
  */
 void testNav(
     const std::string& testDescription,
-    SpatNavTestInterface& interface, SpatNav::DIRECTION direction,
+    SpatNavTestInterface& interface, EasySpatNav::DIRECTION direction,
     size_t focusedItemNr, size_t expectedItemNr,
-    const SpatNav::Interface::Heuristics& heuristics = {},
-    const SpatNav::Interface::Settings& settings = {}
+    const EasySpatNav::Interface::Heuristics& heuristics = {},
+    const EasySpatNav::Interface::Settings& settings = {}
 ) {
-    SpatNav::Interface spatNavManager;
+    EasySpatNav::Interface spatNavManager;
     spatNavManager.heuristics = heuristics;
     spatNavManager.settings = settings;
 
@@ -309,10 +309,10 @@ void testNav(
 }
 
 
-using SpatNav::DIRECTION_RIGHT;
-using SpatNav::DIRECTION_DOWN;
-using SpatNav::DIRECTION_LEFT;
-using SpatNav::DIRECTION_UP;
+using EasySpatNav::DIRECTION_RIGHT;
+using EasySpatNav::DIRECTION_DOWN;
+using EasySpatNav::DIRECTION_LEFT;
+using EasySpatNav::DIRECTION_UP;
 
 
 /**
@@ -506,17 +506,17 @@ int main(int argc, char** argv) {
     testNav(
         "Test that Euclidean distance checks pick the best option.",
         ifDistances, DIRECTION_UP, 3, 2,
-        { .distCalcMethod = SpatNav::DIST_CALC_METHOD_EUCLIDEAN }
+        { .distCalcMethod = EasySpatNav::DIST_CALC_METHOD_EUCLIDEAN }
     );
     testNav(
         "Test that taxicab distance checks pick the best option.",
         ifDistances, DIRECTION_UP, 3, 1,
-        { .distCalcMethod = SpatNav::DIST_CALC_METHOD_TAXICAB }
+        { .distCalcMethod = EasySpatNav::DIST_CALC_METHOD_TAXICAB }
     );
     testNav(
         "Test that taxicab 2 distance checks pick the best option.",
         ifDistances2, DIRECTION_UP, 3, 1,
-        { .distCalcMethod = SpatNav::DIST_CALC_METHOD_TAXICAB_2 }
+        { .distCalcMethod = EasySpatNav::DIST_CALC_METHOD_TAXICAB_2 }
     );
 
     //Single loop pass.

source/vs_code/launch.json

@@ -25,10 +25,10 @@
             "preLaunchTask": "Build Pikifen - Debug"
         },
         {
-            "name": "Debug SpatNav's unit tests with GDB",
+            "name": "Debug EasySpatNav's unit tests with GDB",
             "type": "cppdbg",
             "request": "launch",
-            "program": "${workspaceFolder}/source/source/lib/spatial_navigation/tests/spat_nav_tests",
+            "program": "${workspaceFolder}/source/source/lib/easy_spat_nav/tests/easy_spat_nav_tests",
             "args": [],
             "stopAtEntry": false,
             "cwd": "${workspaceFolder}",
@@ -42,7 +42,7 @@
                     "ignoreFailures": true
                 }
             ],
-            "preLaunchTask": "Build SpatNav's unit tests - Debug"
+            "preLaunchTask": "Build EasySpatNav's unit tests - Debug"
         }
     ]
 }

source/vs_code/tasks.json

@@ -106,13 +106,13 @@
 		},
 		{
 			"type": "shell",
-			"label": "Build SpatNav's unit tests - Debug",
+			"label": "Build EasySpatNav's unit tests - Debug",
 			"command": "make",
 			"args": [
 				"debug",
 			],
 			"options": {
-				"cwd": "${workspaceFolder}/source/source/lib/spatial_navigation/tests"
+				"cwd": "${workspaceFolder}/source/source/lib/easy_spat_nav/tests"
 			},
 			"problemMatcher": [
 				"$gcc"
@@ -124,7 +124,7 @@
 				"reveal": "always",
 				"echo": true
 			},
-			"detail": "Use make to compile the spatial navigation library's unit tests."
+			"detail": "Use make to compile the Easy Spatial Navigation library's unit tests."
 		},
 	]
 }