Move graphics effect API to Target

Author: adazem009

include/scratchcpp/sprite.h

@@ -67,10 +67,9 @@ class LIBSCRATCHCPP_EXPORT Sprite : public Target
         Rect boundingRect() const;
         void keepInFence(double newX, double newY, double *fencedX, double *fencedY) const;
 
-        double graphicsEffectValue(IGraphicsEffect *effect) const;
-        void setGraphicsEffectValue(IGraphicsEffect *effect, double value);
+        void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
 
-        void clearGraphicsEffects();
+        void clearGraphicsEffects() override;
 
     private:
         Target *dataSource() const override;

include/scratchcpp/stage.h

@@ -47,6 +47,10 @@ class LIBSCRATCHCPP_EXPORT Stage : public Target
         const std::string &textToSpeechLanguage() const;
         void setTextToSpeechLanguage(const std::string &newTextToSpeechLanguage);
 
+        void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
+
+        void clearGraphicsEffects() override;
+
     private:
         spimpl::unique_impl_ptr<StagePrivate> impl;
 };

include/scratchcpp/target.h

@@ -17,6 +17,7 @@ class Block;
 class Comment;
 class Costume;
 class Sound;
+class IGraphicsEffect;
 class TargetPrivate;
 
 /*! \brief The Target class is the Stage or a Sprite. */
@@ -77,6 +78,11 @@ class LIBSCRATCHCPP_EXPORT Target
         double volume() const;
         void setVolume(double newVolume);
 
+        double graphicsEffectValue(IGraphicsEffect *effect) const;
+        virtual void setGraphicsEffectValue(IGraphicsEffect *effect, double value);
+
+        virtual void clearGraphicsEffects();
+
         IEngine *engine() const;
         void setEngine(IEngine *engine);
 

src/scratch/sprite.cpp

@@ -400,21 +400,10 @@ void Sprite::keepInFence(double newX, double newY, double *fencedX, double *fenc
     *fencedY = newY + dy;
 }
 
-/*! 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. */
+/*! Overrides Target#setGraphicsEffectValue(). */
 void Sprite::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
 {
-    impl->graphicsEffects[effect] = value;
+    Target::setGraphicsEffectValue(effect, value);
 
     if (impl->visible) {
         IEngine *eng = engine();
@@ -424,10 +413,10 @@ void Sprite::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
     }
 }
 
-/*! Sets the value of all graphics effects to 0 (clears them). */
+/*! Overrides Target#clearGraphicsEffects. */
 void Sprite::clearGraphicsEffects()
 {
-    impl->graphicsEffects.clear();
+    Target::clearGraphicsEffects();
 
     if (impl->visible) {
         IEngine *eng = engine();

src/scratch/sprite_p.h

@@ -31,7 +31,6 @@ struct SpritePrivate
         double direction = 90;
         bool draggable = false;
         Sprite::RotationStyle rotationStyle = Sprite::RotationStyle::AllAround;
-        std::unordered_map<IGraphicsEffect *, double> graphicsEffects;
 };
 
 } // namespace libscratchcpp

src/scratch/stage.cpp

@@ -2,6 +2,7 @@
 
 #include <scratchcpp/stage.h>
 #include <scratchcpp/istagehandler.h>
+#include <scratchcpp/iengine.h>
 #include <cassert>
 
 #include "stage_p.h"
@@ -123,3 +124,23 @@ void Stage::setTextToSpeechLanguage(const std::string &newTextToSpeechLanguage)
 {
     impl->textToSpeechLanguage = newTextToSpeechLanguage;
 }
+
+/*! Overrides Target#setGraphicsEffectValue(). */
+void Stage::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
+{
+    Target::setGraphicsEffectValue(effect, value);
+    IEngine *eng = engine();
+
+    if (eng)
+        eng->requestRedraw();
+}
+
+/*! Overrides Target#clearGraphicsEffects(). */
+void Stage::clearGraphicsEffects()
+{
+    Target::clearGraphicsEffects();
+    IEngine *eng = engine();
+
+    if (eng)
+        eng->requestRedraw();
+}

src/scratch/target.cpp

@@ -409,6 +409,29 @@ void Target::setVolume(double newVolume)
         impl->volume = newVolume;
 }
 
+/*! Returns the value of the given graphics effect. */
+double Target::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 Target::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
+{
+    impl->graphicsEffects[effect] = value;
+}
+
+/*! Sets the value of all graphics effects to 0 (clears them). */
+void Target::clearGraphicsEffects()
+{
+    impl->graphicsEffects.clear();
+}
+
 /*! Returns the engine. */
 IEngine *Target::engine() const
 {

src/scratch/target_p.h

@@ -5,6 +5,7 @@
 #include <string>
 #include <vector>
 #include <memory>
+#include <unordered_map>
 #include <scratchcpp/costume.h>
 #include <scratchcpp/sound.h>
 
@@ -16,6 +17,7 @@ class Variable;
 class List;
 class Block;
 class Comment;
+class IGraphicsEffect;
 
 struct TargetPrivate
 {
@@ -33,6 +35,7 @@ struct TargetPrivate
         std::vector<std::shared_ptr<Sound>> sounds;
         int layerOrder = 0;
         double volume = 100;
+        std::unordered_map<IGraphicsEffect *, double> graphicsEffects;
 };
 
 } // namespace libscratchcpp

test/scratch_classes/sprite_test.cpp

@@ -616,4 +616,13 @@ TEST(SpriteTest, GraphicsEffects)
     sprite.clearGraphicsEffects();
     ASSERT_EQ(sprite.graphicsEffectValue(&effect1), 0);
     ASSERT_EQ(sprite.graphicsEffectValue(&effect2), 0);
+
+    sprite.setVisible(false);
+    sprite.setGraphicsEffectValue(&effect2, -107.08);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect1), 0);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect2), -107.08);
+
+    sprite.clearGraphicsEffects();
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect1), 0);
+    ASSERT_EQ(sprite.graphicsEffectValue(&effect2), 0);
 }

test/scratch_classes/stage_test.cpp

@@ -1,6 +1,7 @@
 #include <scratchcpp/stage.h>
 #include <scratchcpp/costume.h>
 #include <enginemock.h>
+#include <graphicseffectmock.h>
 
 #include "../common.h"
 
@@ -105,3 +106,25 @@ TEST(StageTest, TextToSpeechLanguage)
     stage.setTextToSpeechLanguage("English");
     ASSERT_EQ(stage.textToSpeechLanguage(), "English");
 }
+
+TEST(StageTest, GraphicsEffects)
+{
+    Stage stage;
+
+    EngineMock engine;
+    stage.setEngine(&engine);
+    EXPECT_CALL(engine, requestRedraw()).Times(3);
+
+    GraphicsEffectMock effect1, effect2;
+    stage.setGraphicsEffectValue(&effect1, 48.21);
+    ASSERT_EQ(stage.graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(stage.graphicsEffectValue(&effect2), 0);
+
+    stage.setGraphicsEffectValue(&effect2, -107.08);
+    ASSERT_EQ(stage.graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(stage.graphicsEffectValue(&effect2), -107.08);
+
+    stage.clearGraphicsEffects();
+    ASSERT_EQ(stage.graphicsEffectValue(&effect1), 0);
+    ASSERT_EQ(stage.graphicsEffectValue(&effect2), 0);
+}

test/scratch_classes/target_test.cpp

@@ -7,6 +7,7 @@
 #include <scratchcpp/sound.h>
 #include <enginemock.h>
 #include <targetmock.h>
+#include <graphicseffectmock.h>
 
 #include "../common.h"
 
@@ -481,6 +482,27 @@ TEST(TargetTest, Volume)
     ASSERT_EQ(target.volume(), 0);
 }
 
+TEST(TargetTest, GraphicsEffects)
+{
+    Target target;
+
+    EngineMock engine;
+    target.setEngine(&engine);
+
+    GraphicsEffectMock effect1, effect2;
+    target.setGraphicsEffectValue(&effect1, 48.21);
+    ASSERT_EQ(target.graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(target.graphicsEffectValue(&effect2), 0);
+
+    target.setGraphicsEffectValue(&effect2, -107.08);
+    ASSERT_EQ(target.graphicsEffectValue(&effect1), 48.21);
+    ASSERT_EQ(target.graphicsEffectValue(&effect2), -107.08);
+
+    target.clearGraphicsEffects();
+    ASSERT_EQ(target.graphicsEffectValue(&effect1), 0);
+    ASSERT_EQ(target.graphicsEffectValue(&effect2), 0);
+}
+
 TEST(TargetTest, Engine)
 {
     Target target;