From b0b6c48a8804c9d373d043140402745deb925b8c Mon Sep 17 00:00:00 2001
From: elsid <elsid.mail@gmail.com>
Date: Sun, 26 Nov 2023 10:28:39 +0100
Subject: [PATCH] Add clarifying comments to detournavigator coordinates
 conversion functions

---
 components/detournavigator/settingsutils.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/components/detournavigator/settingsutils.hpp b/components/detournavigator/settingsutils.hpp
index 10e99d002f..c9d8665d51 100644
--- a/components/detournavigator/settingsutils.hpp
+++ b/components/detournavigator/settingsutils.hpp
@@ -47,6 +47,7 @@ namespace DetourNavigator
         return position;
     }
 
+    // Returns value in NavMesh coordinates
     inline float getTileSize(const RecastSettings& settings)
     {
         return static_cast<float>(settings.mTileSize) * settings.mCellSize;
@@ -62,16 +63,19 @@ namespace DetourNavigator
         return static_cast<int>(v);
     }
 
+    // Returns integer tile position for position in navmesh coordinates
     inline TilePosition getTilePosition(const RecastSettings& settings, const osg::Vec2f& position)
     {
         return TilePosition(getTilePosition(settings, position.x()), getTilePosition(settings, position.y()));
     }
 
+    // Returns integer tile position for position in navmesh coordinates
     inline TilePosition getTilePosition(const RecastSettings& settings, const osg::Vec3f& position)
     {
         return getTilePosition(settings, osg::Vec2f(position.x(), position.z()));
     }
 
+    // Returns tile bounds in navmesh coordinates
     inline TileBounds makeTileBounds(const RecastSettings& settings, const TilePosition& tilePosition)
     {
         return TileBounds{
@@ -80,6 +84,7 @@ namespace DetourNavigator
         };
     }
 
+    // Returns border size relative to cell size
     inline float getBorderSize(const RecastSettings& settings)
     {
         return static_cast<float>(settings.mBorderSize) * settings.mCellSize;
@@ -95,6 +100,7 @@ namespace DetourNavigator
         return std::floor(std::sqrt(settings.mMaxTilesNumber / osg::PI)) - 1;
     }
 
+    // Returns tile bounds in real coordinates
     inline TileBounds makeRealTileBoundsWithBorder(const RecastSettings& settings, const TilePosition& tilePosition)
     {
         TileBounds result = makeTileBounds(settings, tilePosition);