Merge pull request #223 from scratchcpp/mouse_position

Store mouse pointer position in Engine

Author: adazem009

include/scratchcpp/iengine.h

@@ -91,6 +91,18 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets the framerate of the project. */
         virtual void setFps(double fps) = 0;
 
+        /*! Returns the X coordinate of the mouse pointer. */
+        virtual double mouseX() const = 0;
+
+        /*! Sets the X coordinate of the mouse pointer. */
+        virtual void setMouseX(double x) = 0;
+
+        /*! Returns the Y coordinate of the mouse pointer. */
+        virtual double mouseY() const = 0;
+
+        /*! Sets the Y coordinate of the mouse pointer. */
+        virtual void setMouseY(double y) = 0;
+
         /*! Returns true if there are any running script of the broadcast with the given index. */
         virtual bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) = 0;
 

src/engine/internal/engine.cpp

@@ -363,6 +363,26 @@ void Engine::setFps(double fps)
     updateFrameDuration();
 }
 
+double Engine::mouseX() const
+{
+    return m_mouseX;
+}
+
+void Engine::setMouseX(double x)
+{
+    m_mouseX = x;
+}
+
+double Engine::mouseY() const
+{
+    return m_mouseY;
+}
+
+void Engine::setMouseY(double y)
+{
+    m_mouseY = y;
+}
+
 bool Engine::broadcastRunning(unsigned int index, VirtualMachine *sourceScript)
 {
     const auto &scripts = m_runningBroadcastMap[index];

src/engine/internal/engine.h

@@ -39,6 +39,12 @@ class Engine : public IEngine
         double fps() const override;
         void setFps(double fps) override;
 
+        double mouseX() const override;
+        void setMouseX(double x) override;
+
+        double mouseY() const override;
+        void setMouseY(double y) override;
+
         bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) override;
 
         void breakFrame() override;
@@ -114,6 +120,8 @@ class Engine : public IEngine
         ITimer *m_timer = nullptr;
         double m_fps = 30;                         // default FPS
         std::chrono::milliseconds m_frameDuration; // will be computed in run()
+        double m_mouseX = 0;
+        double m_mouseY = 0;
 
         bool m_running = false;
         bool m_breakFrame = false;

test/engine/engine_test.cpp

@@ -43,6 +43,24 @@ TEST(EngineTest, Fps)
     ASSERT_EQ(engine.fps(), 60.25);
 }
 
+TEST(EngineTest, MouseX)
+{
+    Engine engine;
+    ASSERT_EQ(engine.mouseX(), 0);
+
+    engine.setMouseX(-128.038);
+    ASSERT_EQ(engine.mouseX(), -128.038);
+}
+
+TEST(EngineTest, MouseY)
+{
+    Engine engine;
+    ASSERT_EQ(engine.mouseY(), 0);
+
+    engine.setMouseY(179.9258);
+    ASSERT_EQ(engine.mouseY(), 179.9258);
+}
+
 TEST(EngineTest, BreakFrame)
 {
     Engine engine;

test/mocks/enginemock.h

@@ -27,6 +27,12 @@ class EngineMock : public IEngine
         MOCK_METHOD(double, fps, (), (const, override));
         MOCK_METHOD(void, setFps, (double fps), (override));
 
+        MOCK_METHOD(double, mouseX, (), (const, override));
+        MOCK_METHOD(void, setMouseX, (double x), (override));
+
+        MOCK_METHOD(double, mouseY, (), (const, override));
+        MOCK_METHOD(void, setMouseY, (double y), (override));
+
         MOCK_METHOD(bool, broadcastRunning, (unsigned int, VirtualMachine *), (override));
 
         MOCK_METHOD(void, breakFrame, (), (override));