Merge pull request #472 from scratchcpp/mouse_wheel_api

Add mouse wheel API

Author: adazem009

include/scratchcpp/iengine.h

@@ -139,6 +139,12 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets whether any key is pressed (use this for any key, even for unsupported keys). */
         virtual void setAnyKeyPressed(bool pressed) = 0;
 
+        /*! Starts "when up arrow key pressed" hats. */
+        virtual void mouseWheelUp() = 0;
+
+        /*! Starts "when down arrow key pressed" hats. */
+        virtual void mouseWheelDown() = 0;
+
         /*! Returns the X coordinate of the mouse pointer. */
         virtual double mouseX() const = 0;
 

src/engine/internal/engine.cpp

@@ -654,6 +654,18 @@ void Engine::setAnyKeyPressed(bool pressed)
         startHats(HatType::KeyPressed, { { HatField::KeyOption, "any" } }, nullptr);
 }
 
+void Engine::mouseWheelUp()
+{
+    // Start "when up arrow pressed" scripts
+    startHats(HatType::KeyPressed, { { HatField::KeyOption, "up arrow" } }, nullptr);
+}
+
+void Engine::mouseWheelDown()
+{
+    // Start "when down arrow pressed" scripts
+    startHats(HatType::KeyPressed, { { HatField::KeyOption, "down arrow" } }, nullptr);
+}
+
 double Engine::mouseX() const
 {
     return m_mouseX;

src/engine/internal/engine.h

@@ -64,6 +64,9 @@ class Engine : public IEngine
         void setKeyState(const KeyEvent &event, bool pressed) override;
         void setAnyKeyPressed(bool pressed) override;
 
+        void mouseWheelUp() override;
+        void mouseWheelDown() override;
+
         double mouseX() const override;
         void setMouseX(double x) override;
 

test/engine/engine_test.cpp

@@ -706,6 +706,67 @@ TEST(EngineTest, WhenKeyPressed)
     ASSERT_EQ(GET_VAR(stage, "4_pressed")->value().toInt(), 1);
 }
 
+TEST(EngineTest, MouseWheel)
+{
+    Project p("mouse_wheel.sb3");
+    ASSERT_TRUE(p.load());
+
+    auto engine = p.engine();
+
+    Stage *stage = engine->stage();
+    ASSERT_TRUE(stage);
+
+    // Initial state
+    ASSERT_VAR(stage, "up");
+    ASSERT_EQ(GET_VAR(stage, "up")->value().toInt(), 0);
+    ASSERT_VAR(stage, "down");
+    ASSERT_EQ(GET_VAR(stage, "down")->value().toInt(), 0);
+    ASSERT_VAR(stage, "any");
+    ASSERT_EQ(GET_VAR(stage, "any")->value().toInt(), 0);
+
+    // Up
+    engine->mouseWheelUp();
+    ASSERT_FALSE(engine->keyPressed("up arrow"));
+    engine->step();
+    ASSERT_VAR(stage, "up");
+    ASSERT_EQ(GET_VAR(stage, "up")->value().toInt(), 1);
+    ASSERT_VAR(stage, "down");
+    ASSERT_EQ(GET_VAR(stage, "down")->value().toInt(), 0);
+    ASSERT_VAR(stage, "any");
+    ASSERT_EQ(GET_VAR(stage, "any")->value().toInt(), 0);
+
+    engine->mouseWheelUp();
+    ASSERT_FALSE(engine->keyPressed("up arrow"));
+    engine->step();
+    ASSERT_VAR(stage, "up");
+    ASSERT_EQ(GET_VAR(stage, "up")->value().toInt(), 2);
+    ASSERT_VAR(stage, "down");
+    ASSERT_EQ(GET_VAR(stage, "down")->value().toInt(), 0);
+    ASSERT_VAR(stage, "any");
+    ASSERT_EQ(GET_VAR(stage, "any")->value().toInt(), 0);
+
+    // Down
+    engine->mouseWheelDown();
+    ASSERT_FALSE(engine->keyPressed("down arrow"));
+    engine->step();
+    ASSERT_VAR(stage, "up");
+    ASSERT_EQ(GET_VAR(stage, "up")->value().toInt(), 2);
+    ASSERT_VAR(stage, "down");
+    ASSERT_EQ(GET_VAR(stage, "down")->value().toInt(), 1);
+    ASSERT_VAR(stage, "any");
+    ASSERT_EQ(GET_VAR(stage, "any")->value().toInt(), 0);
+
+    engine->mouseWheelDown();
+    ASSERT_FALSE(engine->keyPressed("down arrow"));
+    engine->step();
+    ASSERT_VAR(stage, "up");
+    ASSERT_EQ(GET_VAR(stage, "up")->value().toInt(), 2);
+    ASSERT_VAR(stage, "down");
+    ASSERT_EQ(GET_VAR(stage, "down")->value().toInt(), 2);
+    ASSERT_VAR(stage, "any");
+    ASSERT_EQ(GET_VAR(stage, "any")->value().toInt(), 0);
+}
+
 TEST(EngineTest, MouseX)
 {
     Engine engine;

test/mocks/enginemock.h

@@ -47,6 +47,9 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, setKeyState, (const KeyEvent &, bool), (override));
         MOCK_METHOD(void, setAnyKeyPressed, (bool), (override));
 
+        MOCK_METHOD(void, mouseWheelUp, (), (override));
+        MOCK_METHOD(void, mouseWheelDown, (), (override));
+
         MOCK_METHOD(double, mouseX, (), (const, override));
         MOCK_METHOD(void, setMouseX, (double x), (override));