Set graphics effects in costumes

Author: adazem009

include/scratchcpp/costume.h

@@ -41,7 +41,8 @@ class LIBSCRATCHCPP_EXPORT Costume : public Asset
 
         Rgb **bitmap() const;
 
-        void setGraphicsEffect(IGraphicsEffect *effect, double value);
+        double graphicsEffectValue(IGraphicsEffect *effect) const;
+        void setGraphicsEffectValue(IGraphicsEffect *effect, double value);
 
         Broadcast *broadcast();
 

include/scratchcpp/sprite.h

@@ -9,6 +9,7 @@ namespace libscratchcpp
 
 class ISpriteHandler;
 class Rect;
+class IGraphicsEffect;
 class SpritePrivate;
 
 /*! \brief The Sprite class represents a Scratch sprite. */
@@ -65,6 +66,9 @@ class LIBSCRATCHCPP_EXPORT Sprite : public Target
 
         Rect boundingRect() const;
 
+        double graphicsEffectValue(IGraphicsEffect *effect) const;
+        void setGraphicsEffectValue(IGraphicsEffect *effect, double value);
+
     private:
         Target *dataSource() const override;
         void setXY(double x, double y);

src/scratch/costume.cpp

@@ -107,8 +107,19 @@ Rgb **Costume::bitmap() const
     return impl->bitmap;
 }
 
-/*! Sets the value of the given graphics effect. */
-void Costume::setGraphicsEffect(IGraphicsEffect *effect, double value)
+/*! Returns the value of the given graphics effect. */
+double Costume::graphicsEffectValue(IGraphicsEffect *effect) const
+{
+    auto it = impl->graphicsEffects.find(effect);
+
+    if (it == impl->graphicsEffects.cend())
+        return 0;
+    else
+        return it->second;
+}
+
+/*! Sets the value of the given graphics effect (this is automatically set by the sprite). */
+void Costume::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
 {
     auto it = impl->graphicsEffects.find(effect);
     bool update = ((it == impl->graphicsEffects.cend()) || (it->second != value));

src/scratch/sprite.cpp

@@ -212,6 +212,9 @@ void Sprite::setCurrentCostume(int newCostume)
     if (costume) {
         costume->setScale(impl->size / 100);
         costume->setMirrorHorizontally(impl->rotationStyle == RotationStyle::LeftRight);
+
+        for (const auto &[effect, value] : impl->graphicsEffects)
+            costume->setGraphicsEffectValue(effect, value);
     }
 
     Target::setCurrentCostume(newCostume);
@@ -309,6 +312,29 @@ Rect Sprite::boundingRect() const
     return ret;
 }
 
+/*! Returns the value of the given graphics effect. */
+double Sprite::graphicsEffectValue(IGraphicsEffect *effect) const
+{
+    auto it = impl->graphicsEffects.find(effect);
+
+    if (it == impl->graphicsEffects.cend())
+        return 0;
+    else
+        return it->second;
+}
+
+/*! Sets the value of the given graphics effect. */
+void Sprite::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
+{
+    impl->graphicsEffects[effect] = value;
+
+    // TODO: Make currentCostume() return the costume (not index)
+    auto costume = costumeAt(currentCostume() - 1);
+
+    if (costume)
+        costume->setGraphicsEffectValue(effect, value);
+}
+
 Target *Sprite::dataSource() const
 {
     return impl->cloneRoot;

src/scratch/sprite_p.h

@@ -3,6 +3,7 @@
 #pragma once
 
 #include <scratchcpp/sprite.h>
+#include <unordered_map>
 
 namespace libscratchcpp
 {
@@ -32,6 +33,7 @@ struct SpritePrivate
         double direction = 90;
         bool draggable = false;
         Sprite::RotationStyle rotationStyle = Sprite::RotationStyle::AllAround;
+        std::unordered_map<IGraphicsEffect *, double> graphicsEffects;
 };
 
 } // namespace libscratchcpp

test/assets/costume_test.cpp

@@ -333,8 +333,13 @@ TEST_F(CostumeTest, BitmapWithGraphicsEffects)
     Costume costume("costume1", "a", "test");
 
     GraphicsEffectMock effect1, effect2;
-    costume.setGraphicsEffect(&effect1, 54.12);
-    costume.setGraphicsEffect(&effect2, -89.03);
+    costume.setGraphicsEffectValue(&effect1, 54.12);
+    ASSERT_EQ(costume.graphicsEffectValue(&effect1), 54.12);
+    ASSERT_EQ(costume.graphicsEffectValue(&effect2), 0);
+
+    costume.setGraphicsEffectValue(&effect2, -89.03);
+    ASSERT_EQ(costume.graphicsEffectValue(&effect1), 54.12);
+    ASSERT_EQ(costume.graphicsEffectValue(&effect2), -89.03);
 
     EXPECT_CALL(*m_imageFormat, width()).WillOnce(Return(4));
     EXPECT_CALL(*m_imageFormat, height()).WillOnce(Return(3));

test/scratch_classes/sprite_test.cpp

@@ -9,6 +9,7 @@
 #include <enginemock.h>
 #include <imageformatfactorymock.h>
 #include <imageformatmock.h>
+#include <graphicseffectmock.h>
 
 #include "../common.h"
 
@@ -616,3 +617,35 @@ TEST(SpriteTest, BoundingRect)
 
     ScratchConfiguration::removeImageFormat("test");
 }
+
+TEST(SpriteTest, GraphicsEffects)
+{
+    auto c1 = std::make_shared<Costume>("", "", "");
+    auto c2 = std::make_shared<Costume>("", "", "");
+
+    Sprite sprite;
+    sprite.addCostume(c1);
+    sprite.addCostume(c2);
+    sprite.setCurrentCostume(1);
+
+    GraphicsEffectMock effect1, effect2;
+    sprite.setGraphicsEffectValue(&effect1, 48.21);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect2), 0);
+    ASSERT_EQ(c1->graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(c1->graphicsEffectValue(&effect2), 0);
+
+    sprite.setCurrentCostume(2);
+    ASSERT_EQ(c1->graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(c1->graphicsEffectValue(&effect2), 0);
+
+    sprite.setGraphicsEffectValue(&effect2, -107.08);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect2), -107.08);
+    ASSERT_EQ(c2->graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(c2->graphicsEffectValue(&effect2), -107.08);
+
+    sprite.setCurrentCostume(1);
+    ASSERT_EQ(c1->graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(c1->graphicsEffectValue(&effect2), -107.08);
+}