Merge pull request #546 from scratchcpp/size_limit

adazem009 · web-flow · commit b691e30ba075 · 2024-04-20T15:45:39.000+02:00
Add sprite size limit
diff --git a/include/scratchcpp/ispritehandler.h b/include/scratchcpp/ispritehandler.h
@@ -65,6 +65,12 @@ class LIBSCRATCHCPP_EXPORT ISpriteHandler
         /*! Called when the bubble text changes. */
         virtual void onBubbleTextChanged(const std::string &text) = 0;
 
+        /*! Used to get the current costume width. */
+        virtual int costumeWidth() const = 0;
+
+        /*! Used to get the current costume height. */
+        virtual int costumeHeight() const = 0;
+
         /*!
          * Used to get the bounding rectangle of the sprite.
          * \note The rectangle must be relative to the stage, so make sure to use the sprite's coordinates.
diff --git a/include/scratchcpp/istagehandler.h b/include/scratchcpp/istagehandler.h
@@ -46,6 +46,12 @@ class LIBSCRATCHCPP_EXPORT IStageHandler
         /*! Called when the bubble text changes. */
         virtual void onBubbleTextChanged(const std::string &text) = 0;
 
+        /*! Used to get the current costume width. */
+        virtual int costumeWidth() const = 0;
+
+        /*! Used to get the current costume height. */
+        virtual int costumeHeight() const = 0;
+
         /*! Used to get the bounding rectangle of the stage. */
         virtual Rect boundingRect() const = 0;
 
diff --git a/include/scratchcpp/sprite.h b/include/scratchcpp/sprite.h
@@ -59,6 +59,9 @@ class LIBSCRATCHCPP_EXPORT Sprite
 
         void setCostumeIndex(int newCostumeIndex) override;
 
+        int currentCostumeWidth() const override;
+        int currentCostumeHeight() const override;
+
         double direction() const;
         void setDirection(double newDirection);
 
diff --git a/include/scratchcpp/stage.h b/include/scratchcpp/stage.h
@@ -33,6 +33,9 @@ class LIBSCRATCHCPP_EXPORT Stage : public Target
 
         void setCostumeIndex(int newCostumeIndex) override;
 
+        int currentCostumeWidth() const override;
+        int currentCostumeHeight() const override;
+
         int tempo() const;
         void setTempo(int newTempo);
 
diff --git a/include/scratchcpp/target.h b/include/scratchcpp/target.h
@@ -69,6 +69,8 @@ class LIBSCRATCHCPP_EXPORT Target
         virtual void setCostumeIndex(int newCostumeIndex);
 
         std::shared_ptr<Costume> currentCostume() const;
+        virtual int currentCostumeWidth() const;
+        virtual int currentCostumeHeight() const;
 
         const std::vector<std::shared_ptr<Costume>> &costumes() const;
         int addCostume(std::shared_ptr<Costume> costume);
diff --git a/src/scratch/sprite.cpp b/src/scratch/sprite.cpp
@@ -258,13 +258,21 @@ double Sprite::size() const
 /*! Sets the size. */
 void Sprite::setSize(double newSize)
 {
+    IEngine *engine = this->engine();
+
+    if (engine) {
+        const int oldWidth = currentCostumeWidth();
+        const int oldHeight = currentCostumeHeight();
+        const double minScale = std::min(1.0, std::max(5.0 / oldWidth, 5.0 / oldHeight));
+        const double maxScale = std::min((1.5 * engine->stageWidth()) / oldWidth, (1.5 * engine->stageHeight()) / oldHeight);
+        newSize = std::clamp(newSize, minScale * 100, maxScale * 100);
+    }
+
     impl->size = newSize;
 
     if (impl->visible) {
-        IEngine *eng = engine();
-
-        if (eng)
-            eng->requestRedraw();
+        if (engine)
+            engine->requestRedraw();
     }
 
     if (impl->iface)
@@ -288,6 +296,24 @@ void Sprite::setCostumeIndex(int newCostumeIndex)
         impl->iface->onCostumeChanged(costume.get());
 }
 
+/*! Overrides Target#currentCostumeWidth(). */
+int Sprite::currentCostumeWidth() const
+{
+    if (!impl->iface)
+        return 0;
+
+    return impl->iface->costumeWidth();
+}
+
+/*! Overrides Target#currentCostumeHeight(). */
+int Sprite::currentCostumeHeight() const
+{
+    if (!impl->iface)
+        return 0;
+
+    return impl->iface->costumeHeight();
+}
+
 /*! Returns the direction. */
 double Sprite::direction() const
 {
diff --git a/src/scratch/stage.cpp b/src/scratch/stage.cpp
@@ -46,6 +46,24 @@ void Stage::setCostumeIndex(int newCostumeIndex)
         impl->iface->onCostumeChanged(costume.get());
 }
 
+/*! Overrides Target#currentCostumeWidth(). */
+int Stage::currentCostumeWidth() const
+{
+    if (!impl->iface)
+        return 0;
+
+    return impl->iface->costumeWidth();
+}
+
+/*! Overrides Target#currentCostumeHeight(). */
+int Stage::currentCostumeHeight() const
+{
+    if (!impl->iface)
+        return 0;
+
+    return impl->iface->costumeHeight();
+}
+
 /*! Returns the tempo. */
 int Stage::tempo() const
 {
diff --git a/src/scratch/target.cpp b/src/scratch/target.cpp
@@ -278,6 +278,18 @@ std::shared_ptr<Costume> Target::currentCostume() const
     return costumeAt(impl->costumeIndex);
 }
 
+/*! Returns the width of the current costume. */
+int Target::currentCostumeWidth() const
+{
+    return 0;
+}
+
+/*! Returns the height of the current costume. */
+int Target::currentCostumeHeight() const
+{
+    return 0;
+}
+
 /*! Returns the list of costumes. */
 const std::vector<std::shared_ptr<Costume>> &Target::costumes() const
 {
diff --git a/test/mocks/spritehandlermock.h b/test/mocks/spritehandlermock.h
@@ -29,6 +29,9 @@ class SpriteHandlerMock : public ISpriteHandler
         MOCK_METHOD(void, onBubbleTypeChanged, (Target::BubbleType), (override));
         MOCK_METHOD(void, onBubbleTextChanged, (const std::string &), (override));
 
+        MOCK_METHOD(int, costumeWidth, (), (const, override));
+        MOCK_METHOD(int, costumeHeight, (), (const, override));
+
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
 
diff --git a/test/mocks/stagehandlermock.h b/test/mocks/stagehandlermock.h
@@ -20,6 +20,9 @@ class StageHandlerMock : public IStageHandler
         MOCK_METHOD(void, onBubbleTypeChanged, (Target::BubbleType), (override));
         MOCK_METHOD(void, onBubbleTextChanged, (const std::string &), (override));
 
+        MOCK_METHOD(int, costumeWidth, (), (const, override));
+        MOCK_METHOD(int, costumeHeight, (), (const, override));
+
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
 
diff --git a/test/mocks/targetmock.h b/test/mocks/targetmock.h
@@ -11,6 +11,10 @@ class TargetMock : public Target
         MOCK_METHOD(bool, isStage, (), (const, override));
 
         MOCK_METHOD(void, setCostumeIndex, (int), (override));
+
+        MOCK_METHOD(int, currentCostumeWidth, (), (const, override));
+        MOCK_METHOD(int, currentCostumeHeight, (), (const, override));
+
         MOCK_METHOD(void, setLayerOrder, (int), (override));
 
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
diff --git a/test/scratch_classes/sprite_test.cpp b/test/scratch_classes/sprite_test.cpp
@@ -448,21 +448,43 @@ TEST(SpriteTest, Dragging)
 TEST(SpriteTest, Size)
 {
     Sprite sprite;
+    SpriteHandlerMock handler;
+    EXPECT_CALL(handler, init);
+    sprite.setInterface(&handler);
     ASSERT_EQ(sprite.size(), 100);
 
     EngineMock engine;
     sprite.setEngine(&engine);
-    EXPECT_CALL(engine, requestRedraw()).Times(4);
+    EXPECT_CALL(engine, requestRedraw()).WillRepeatedly(Return());
+    EXPECT_CALL(engine, stageWidth()).WillRepeatedly(Return(480));
+    EXPECT_CALL(engine, stageHeight()).WillRepeatedly(Return(360));
+    EXPECT_CALL(handler, onSizeChanged).WillRepeatedly(Return());
 
+    EXPECT_CALL(handler, costumeWidth()).WillRepeatedly(Return(50));
+    EXPECT_CALL(handler, costumeHeight()).WillRepeatedly(Return(30));
     sprite.setSize(63.724);
     ASSERT_EQ(sprite.size(), 63.724);
-
-    sprite.setCostumeIndex(1);
+    sprite.setSize(0);
+    ASSERT_EQ(std::round(sprite.size() * 100) / 100, 16.67);
+    sprite.setSize(2000);
+    ASSERT_EQ(sprite.size(), 1440);
+
+    EXPECT_CALL(handler, costumeWidth()).WillRepeatedly(Return(30));
+    EXPECT_CALL(handler, costumeHeight()).WillRepeatedly(Return(50));
+    sprite.setSize(0);
+    ASSERT_EQ(std::round(sprite.size() * 100) / 100, 16.67);
+    sprite.setSize(2000);
+    ASSERT_EQ(sprite.size(), 1080);
+
+    EXPECT_CALL(handler, costumeWidth()).WillRepeatedly(Return(88));
+    EXPECT_CALL(handler, costumeHeight()).WillRepeatedly(Return(88));
+    sprite.setSize(0);
+    ASSERT_EQ(std::round(sprite.size() * 100) / 100, 5.68);
+    sprite.setSize(2000);
+    ASSERT_EQ(std::round(sprite.size() * 100) / 100, 613.64);
 
     sprite.setSize(186.84);
     ASSERT_EQ(sprite.size(), 186.84);
-
-    sprite.setCostumeIndex(0);
 }
 
 TEST(SpriteTest, CostumeIndex)
@@ -662,6 +684,28 @@ TEST(SpriteTest, KeepInFence)
     ASSERT_EQ(std::round(fencedY * 100) / 100, 150.9);
 }
 
+TEST(SpriteTest, CurrentCostumeWidth)
+{
+    Sprite sprite;
+    SpriteHandlerMock handler;
+    EXPECT_CALL(handler, init);
+    sprite.setInterface(&handler);
+
+    EXPECT_CALL(handler, costumeWidth()).WillOnce(Return(46));
+    ASSERT_EQ(sprite.currentCostumeWidth(), 46);
+}
+
+TEST(SpriteTest, CurrentCostumeHeight)
+{
+    Sprite sprite;
+    SpriteHandlerMock handler;
+    EXPECT_CALL(handler, init);
+    sprite.setInterface(&handler);
+
+    EXPECT_CALL(handler, costumeHeight()).WillOnce(Return(24));
+    ASSERT_EQ(sprite.currentCostumeHeight(), 24);
+}
+
 TEST(SpriteTest, DefaultBoundingRect)
 {
     Sprite sprite;
diff --git a/test/scratch_classes/stage_test.cpp b/test/scratch_classes/stage_test.cpp
@@ -137,6 +137,28 @@ TEST(StageTest, DefaultBoundingRect)
     ASSERT_EQ(rect.bottom(), 0);
 }
 
+TEST(StageTest, CurrentCostumeWidth)
+{
+    Stage stage;
+    StageHandlerMock handler;
+    EXPECT_CALL(handler, init);
+    stage.setInterface(&handler);
+
+    EXPECT_CALL(handler, costumeWidth()).WillOnce(Return(46));
+    ASSERT_EQ(stage.currentCostumeWidth(), 46);
+}
+
+TEST(StageTest, CurrentCostumeHeight)
+{
+    Stage stage;
+    StageHandlerMock handler;
+    EXPECT_CALL(handler, init);
+    stage.setInterface(&handler);
+
+    EXPECT_CALL(handler, costumeHeight()).WillOnce(Return(24));
+    ASSERT_EQ(stage.currentCostumeHeight(), 24);
+}
+
 TEST(StageTest, DefaultFastBoundingRect)
 {
     Stage stage;
diff --git a/test/scratch_classes/target_test.cpp b/test/scratch_classes/target_test.cpp
@@ -511,6 +511,18 @@ TEST(TargetTest, Volume)
     SoundPrivate::audioOutput = nullptr;
 }
 
+TEST(TargetTest, CurrentCostumeWidth)
+{
+    Target target;
+    ASSERT_EQ(target.currentCostumeWidth(), 0);
+}
+
+TEST(TargetTest, CurrentCostumeHeight)
+{
+    Target target;
+    ASSERT_EQ(target.currentCostumeHeight(), 0);
+}
+
 TEST(TargetTest, BoundingRect)
 {
     Target target;
diff --git a/test/target_interfaces/ispritehandler_test.cpp b/test/target_interfaces/ispritehandler_test.cpp
@@ -116,9 +116,21 @@ TEST_F(ISpriteHandlerTest, Position)
 
 TEST_F(ISpriteHandlerTest, Size)
 {
-    EXPECT_CALL(m_handler, onSizeChanged(53.8)).Times(1);
+    EXPECT_CALL(m_handler, onSizeChanged(53.8));
+    EXPECT_CALL(m_handler, costumeWidth()).WillOnce(Return(100));
+    EXPECT_CALL(m_handler, costumeHeight()).WillOnce(Return(100));
+    EXPECT_CALL(m_engine, stageWidth()).WillOnce(Return(480));
+    EXPECT_CALL(m_engine, stageHeight()).WillOnce(Return(360));
     EXPECT_CALL(m_engine, requestRedraw());
     m_sprite.setSize(53.8);
+
+    EXPECT_CALL(m_handler, onSizeChanged(540));
+    EXPECT_CALL(m_handler, costumeWidth()).WillOnce(Return(100));
+    EXPECT_CALL(m_handler, costumeHeight()).WillOnce(Return(100));
+    EXPECT_CALL(m_engine, stageWidth()).WillOnce(Return(480));
+    EXPECT_CALL(m_engine, stageHeight()).WillOnce(Return(360));
+    EXPECT_CALL(m_engine, requestRedraw());
+    m_sprite.setSize(100000);
 }
 
 TEST_F(ISpriteHandlerTest, Direction)
