Add touchingColor() method

adazem009 · adazem009 · commit 0353b336ae41 · 2024-04-01T13:29:18.000+02:00
diff --git a/include/scratchcpp/ispritehandler.h b/include/scratchcpp/ispritehandler.h
@@ -83,6 +83,9 @@ class LIBSCRATCHCPP_EXPORT ISpriteHandler
 
         /*! Used to check whether the sprite touches the given point (in Scratch coordinates). */
         virtual bool touchingPoint(double x, double y) const = 0;
+
+        /*! Used to check whether the sprite touches the given color. */
+        virtual bool touchingColor(const Value &color) const = 0;
 };
 
 } // namespace libscratchcpp
diff --git a/include/scratchcpp/istagehandler.h b/include/scratchcpp/istagehandler.h
@@ -60,6 +60,9 @@ class LIBSCRATCHCPP_EXPORT IStageHandler
 
         /*! Used to check whether the stage touches the given point (in Scratch coordinates). */
         virtual bool touchingPoint(double x, double y) const = 0;
+
+        /*! Used to check whether the stage touches the given color. */
+        virtual bool touchingColor(const Value &color) const = 0;
 };
 
 } // namespace libscratchcpp
diff --git a/include/scratchcpp/sprite.h b/include/scratchcpp/sprite.h
@@ -73,6 +73,7 @@ class LIBSCRATCHCPP_EXPORT Sprite
         void keepInFence(double newX, double newY, double *fencedX, double *fencedY) const;
 
         bool touchingPoint(double x, double y) const override;
+        bool touchingColor(const Value &color) const override;
 
         void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
 
diff --git a/include/scratchcpp/stage.h b/include/scratchcpp/stage.h
@@ -52,6 +52,7 @@ class LIBSCRATCHCPP_EXPORT Stage : public Target
         Rect fastBoundingRect() const override;
 
         bool touchingPoint(double x, double y) const override;
+        bool touchingColor(const Value &color) const override;
 
         void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
 
diff --git a/include/scratchcpp/target.h b/include/scratchcpp/target.h
@@ -92,6 +92,7 @@ class LIBSCRATCHCPP_EXPORT Target
         bool touchingSprite(Sprite *sprite) const;
         virtual bool touchingPoint(double x, double y) const;
         bool touchingEdge() const;
+        virtual bool touchingColor(const Value &color) const;
 
         double graphicsEffectValue(IGraphicsEffect *effect) const;
         virtual void setGraphicsEffectValue(IGraphicsEffect *effect, double value);
diff --git a/src/scratch/sprite.cpp b/src/scratch/sprite.cpp
@@ -415,6 +415,15 @@ bool Sprite::touchingPoint(double x, double y) const
     return impl->iface->touchingPoint(x, y);
 }
 
+/*! Overrides Target#touchingColor(). */
+bool Sprite::touchingColor(const Value &color) const
+{
+    if (!impl->iface)
+        return false;
+
+    return impl->iface->touchingColor(color);
+}
+
 /*! Overrides Target#setGraphicsEffectValue(). */
 void Sprite::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
 {
diff --git a/src/scratch/stage.cpp b/src/scratch/stage.cpp
@@ -158,6 +158,15 @@ bool Stage::touchingPoint(double x, double y) const
     return impl->iface->touchingPoint(x, y);
 }
 
+/*! Overrides Target#touchingColor(). */
+bool Stage::touchingColor(const Value &color) const
+{
+    if (!impl->iface)
+        return false;
+
+    return impl->iface->touchingColor(color);
+}
+
 /*! Overrides Target#setGraphicsEffectValue(). */
 void Stage::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
 {
diff --git a/src/scratch/target.cpp b/src/scratch/target.cpp
@@ -476,6 +476,12 @@ bool Target::touchingEdge() const
     return false;
 }
 
+/*! Returns true if the Target is touching the given color (RGB triplet). */
+bool Target::touchingColor(const Value &color) const
+{
+    return false;
+}
+
 /*! Returns the value of the given graphics effect. */
 double Target::graphicsEffectValue(IGraphicsEffect *effect) const
 {
diff --git a/test/mocks/spritehandlermock.h b/test/mocks/spritehandlermock.h
@@ -34,4 +34,5 @@ class SpriteHandlerMock : public ISpriteHandler
 
         MOCK_METHOD(bool, touchingClones, (const std::vector<Sprite *> &), (const, override));
         MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
+        MOCK_METHOD(bool, touchingColor, (const Value &), (const, override));
 };
diff --git a/test/mocks/stagehandlermock.h b/test/mocks/stagehandlermock.h
@@ -25,4 +25,5 @@ class StageHandlerMock : public IStageHandler
 
         MOCK_METHOD(bool, touchingClones, (const std::vector<Sprite *> &), (const, override));
         MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
+        MOCK_METHOD(bool, touchingColor, (const Value &), (const, override));
 };
diff --git a/test/mocks/targetmock.h b/test/mocks/targetmock.h
@@ -18,6 +18,8 @@ class TargetMock : public Target
 
         MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
 
+        MOCK_METHOD(bool, touchingColor, (const Value &), (const, override));
+
         MOCK_METHOD(void, setGraphicsEffectValue, (IGraphicsEffect *, double), (override));
         MOCK_METHOD(void, clearGraphicsEffects, (), (override));
 
diff --git a/test/scratch_classes/sprite_test.cpp b/test/scratch_classes/sprite_test.cpp
@@ -703,6 +703,23 @@ TEST(SpriteTest, TouchingPoint)
     ASSERT_TRUE(sprite.touchingPoint(-12.46, 120.72));
 }
 
+TEST(SpriteTest, TouchingColor)
+{
+    Sprite sprite;
+    ASSERT_FALSE(sprite.touchingColor(0));
+
+    SpriteHandlerMock iface;
+    EXPECT_CALL(iface, init);
+    sprite.setInterface(&iface);
+
+    Value v1 = 4278228630, v2 = "#FF00FA";
+    EXPECT_CALL(iface, touchingColor(v1)).WillOnce(Return(false));
+    ASSERT_FALSE(sprite.touchingColor(v1));
+
+    EXPECT_CALL(iface, touchingColor(v2)).WillOnce(Return(true));
+    ASSERT_TRUE(sprite.touchingColor(v2));
+}
+
 TEST(SpriteTest, GraphicsEffects)
 {
     Sprite sprite;
diff --git a/test/scratch_classes/stage_test.cpp b/test/scratch_classes/stage_test.cpp
@@ -1,6 +1,7 @@
 #include <scratchcpp/stage.h>
 #include <scratchcpp/sprite.h>
 #include <scratchcpp/costume.h>
+#include <scratchcpp/value.h>
 #include <enginemock.h>
 #include <graphicseffectmock.h>
 #include <stagehandlermock.h>
@@ -195,6 +196,23 @@ TEST(StageTest, TouchingPoint)
     ASSERT_TRUE(stage.touchingPoint(-12.46, 120.72));
 }
 
+TEST(SpriteTest, TouchingColor)
+{
+    Stage stage;
+    ASSERT_FALSE(stage.touchingColor(0));
+
+    StageHandlerMock iface;
+    EXPECT_CALL(iface, init);
+    stage.setInterface(&iface);
+
+    Value v1 = 4278228630, v2 = "#FF00FA";
+    EXPECT_CALL(iface, touchingColor(v1)).WillOnce(Return(false));
+    ASSERT_FALSE(stage.touchingColor(v1));
+
+    EXPECT_CALL(iface, touchingColor(v2)).WillOnce(Return(true));
+    ASSERT_TRUE(stage.touchingColor(v2));
+}
+
 TEST(StageTest, GraphicsEffects)
 {
     Stage stage;
diff --git a/test/scratch_classes/target_test.cpp b/test/scratch_classes/target_test.cpp
@@ -702,6 +702,13 @@ TEST(TargetTest, TouchingEdge)
     ASSERT_TRUE(sprite.touchingEdge());
 }
 
+TEST(TargetTest, TouchingColor)
+{
+    Target target;
+    Value v;
+    ASSERT_FALSE(target.touchingColor(v));
+}
+
 TEST(TargetTest, GraphicsEffects)
 {
     Target target;

Original file line number	Diff line number	Diff line change
`@@ -476,6 +476,12 @@ bool Target::touchingEdge() const`
`476`	`476`	`return false;`
`477`	`477`	`}`
`478`	`478`
	`479`	`+/! Returns true if the Target is touching the given color (RGB triplet). /`
	`480`	`+bool Target::touchingColor(const Value &color) const`
	`481`	`+{`
	`482`	`+ return false;`
	`483`	`+}`
	`484`	`+`
`479`	`485`	`/! Returns the value of the given graphics effect. /`
`480`	`486`	`double Target::graphicsEffectValue(IGraphicsEffect *effect) const`
`481`	`487`	`{`