Merge pull request #204 from ntut-rick/pos

Fix PTSD Position & update docs

Author: ntut-rick

CMakeLists.txt

@@ -113,7 +113,6 @@ set(TEST_FILES
     ${TEST_DIR}/SimpleTest.cpp
     ${TEST_DIR}/NotSimpleTest.cpp
     ${TEST_DIR}/TransformTest.cpp
-    ${TEST_DIR}/PositionTest.cpp
 )
 
 add_library(PTSD STATIC

include/Util/Input.hpp

@@ -45,12 +45,11 @@ class Input {
 
     /**
      * @brief Retrieves the current position of the cursor.
-     * @note The cursor position is relative to the upper-left corner of the
-     * client area of the window.
      *
-     * @return The cursor position as vec2(x, y).
+     * @return The cursor position as a PTSDPosition (x, y).
      *
      * @see Util::Input::SetCursorPosition()
+     * @see Util::PTSDPosition
      */
     static Util::PTSDPosition GetCursorPosition();
 
@@ -115,11 +114,11 @@ class Input {
     /**
      * @brief Sets the position of the cursor.
      * @param pos The position to set the cursor to.
-     * @note The cursor position is relative to the upper-left corner of the
-     * client area of the window.
-     * @note It also generates a mouse motion event, which leads
-     * Util::Input::IsMouseMoving() to return true in this update-cycle.
+     * @note This also triggers a mouse motion event, making Util::Input::IsMouseMoving() return true 
+     *       in the current update cycle.
+     *
      * @see Util::Input::GetCursorPosition()
+     * @see Util::PTSDPosition
      */
     static void SetCursorPosition(const Util::PTSDPosition &pos);
 

include/Util/Position.hpp

@@ -7,6 +7,15 @@ namespace Util {
 
 struct PTSDPosition;
 
+/**
+ * @struct SDLPosition
+ * @brief A class representing a position in screen coordinates.
+ *
+ * This class is used to store the X and Y coordinates of a point in a screen coordinate system where:
+ * - The origin (0, 0) is at the upper-left corner of the window.
+ * - X increases to the right.
+ * - Y increases downwards.
+ */
 struct SDLPosition {
 public:
     const int x;
@@ -20,6 +29,15 @@ struct SDLPosition {
           y(y) {}
 };
 
+/**
+ * @struct PTSDPosition
+ * @brief A class representing a position in a Cartesian coordinates.
+ *
+ * This class is used to store the X and Y coordinates of a point in a Cartesian coordinate system where:
+ * - The origin (0, 0) is at the center of the window.
+ * - X increases to the right.
+ * - Y increases upwards.
+ */
 struct PTSDPosition {
     float x{};
     float y{};

src/Util/Position.cpp

@@ -10,15 +10,15 @@ PTSDPosition PTSDPosition::FromSDL(int sdlx, int sdly) {
     return PTSDPosition{
         static_cast<float>(sdlx) -
             static_cast<float>(PTSD_Config::WINDOW_WIDTH) / 2.0F,
-        static_cast<float>(sdly) -
-            static_cast<float>(PTSD_Config::WINDOW_HEIGHT) / 2.0F};
+        -(static_cast<float>(sdly) -
+            static_cast<float>(PTSD_Config::WINDOW_HEIGHT) / 2.0F)};
 }
 
 SDLPosition PTSDPosition::ToSDLPosition() const {
     return SDLPosition(
         static_cast<int>(this->x +
                          static_cast<float>(PTSD_Config::WINDOW_WIDTH) / 2.0F),
-        static_cast<int>(
-            this->y + static_cast<float>(PTSD_Config::WINDOW_HEIGHT) / 2.0F));
+        -(static_cast<int>(
+            this->y + static_cast<float>(PTSD_Config::WINDOW_HEIGHT) / 2.0F)));
 }
 } // namespace Util