Target: Add clearSoundEffects() method

Author: adazem009

include/scratchcpp/target.h

@@ -92,6 +92,8 @@ class LIBSCRATCHCPP_EXPORT Target
         virtual double soundEffect(Sound::Effect effect) const;
         virtual void setSoundEffect(Sound::Effect effect, double value);
 
+        virtual void clearSoundEffects();
+
         virtual Rect boundingRect() const;
         virtual Rect fastBoundingRect() const;
 

src/scratch/target.cpp

@@ -444,6 +444,17 @@ void Target::setSoundEffect(Sound::Effect effect, double value)
     }
 }
 
+/*! Sets the value of all sound effects to 0 (clears them). */
+void Target::clearSoundEffects()
+{
+    std::unordered_map<Sound::Effect, double> effects = impl->soundEffects; // must copy!
+
+    for (const auto &[effect, value] : effects)
+        setSoundEffect(effect, 0);
+
+    impl->soundEffects.clear();
+}
+
 /*! Returns the bounding rectangle of the sprite. */
 Rect Target::boundingRect() const
 {

test/mocks/targetmock.h

@@ -20,6 +20,8 @@ class TargetMock : public Target
         MOCK_METHOD(double, soundEffect, (Sound::Effect), (const, override));
         MOCK_METHOD(void, setSoundEffect, (Sound::Effect, double), (override));
 
+        MOCK_METHOD(void, clearSoundEffects, (), (override));
+
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
 

test/scratch_classes/target_test.cpp

@@ -512,7 +512,7 @@ TEST(TargetTest, Volume)
     SoundPrivate::audioOutput = nullptr;
 }
 
-TEST(TargetTest, SoundEffect)
+TEST(TargetTest, SoundEffects)
 {
     Target target;
     ASSERT_EQ(target.soundEffect(Sound::Effect::Pitch), 0);
@@ -548,6 +548,18 @@ TEST(TargetTest, SoundEffect)
     EXPECT_CALL(*s4, setEffect(Sound::Effect::Pitch, 12.5));
     EXPECT_CALL(*s4, setEffect(Sound::Effect::Pan, -56.7));
     target.addSound(s4);
+
+    EXPECT_CALL(*s1, setEffect(Sound::Effect::Pitch, 0));
+    EXPECT_CALL(*s1, setEffect(Sound::Effect::Pan, 0));
+    EXPECT_CALL(*s2, setEffect(Sound::Effect::Pitch, 0));
+    EXPECT_CALL(*s2, setEffect(Sound::Effect::Pan, 0));
+    EXPECT_CALL(*s3, setEffect(Sound::Effect::Pitch, 0));
+    EXPECT_CALL(*s3, setEffect(Sound::Effect::Pan, 0));
+    EXPECT_CALL(*s4, setEffect(Sound::Effect::Pitch, 0));
+    EXPECT_CALL(*s4, setEffect(Sound::Effect::Pan, 0));
+    target.clearSoundEffects();
+    ASSERT_EQ(target.soundEffect(Sound::Effect::Pitch), 0);
+    ASSERT_EQ(target.soundEffect(Sound::Effect::Pan), 0);
 }
 
 TEST(TargetTest, CurrentCostumeWidth)