Add touchingSprite() method

Author: adazem009

include/scratchcpp/ispritehandler.h

@@ -78,6 +78,9 @@ class LIBSCRATCHCPP_EXPORT ISpriteHandler
          */
         virtual Rect fastBoundingRect() const = 0;
 
+        /*! Used to check whether the sprite touches any of the given sprite clones. */
+        virtual bool touchingClones(const std::vector<Sprite *> &clones) const = 0;
+
         /*! Used to check whether the sprite touches the given point (in Scratch coordinates). */
         virtual bool touchingPoint(double x, double y) const = 0;
 };

include/scratchcpp/istagehandler.h

@@ -8,6 +8,8 @@
 namespace libscratchcpp
 {
 
+class Sprite;
+
 /*! \brief The IStageHandler class provides a stage interface for Scratch project players. */
 class LIBSCRATCHCPP_EXPORT IStageHandler
 {
@@ -53,6 +55,9 @@ class LIBSCRATCHCPP_EXPORT IStageHandler
          */
         virtual Rect fastBoundingRect() const = 0;
 
+        /*! Used to check whether the stage touches any of the given sprite clones. */
+        virtual bool touchingClones(const std::vector<Sprite *> &clones) const = 0;
+
         /*! Used to check whether the stage touches the given point (in Scratch coordinates). */
         virtual bool touchingPoint(double x, double y) const = 0;
 };

include/scratchcpp/sprite.h

@@ -83,6 +83,7 @@ class LIBSCRATCHCPP_EXPORT Sprite
 
     private:
         Target *dataSource() const override;
+        bool touchingClones(const std::vector<Sprite *> &clones) const override;
         void setXY(double x, double y);
 
         spimpl::unique_impl_ptr<SpritePrivate> impl;

include/scratchcpp/stage.h

@@ -61,6 +61,8 @@ class LIBSCRATCHCPP_EXPORT Stage : public Target
         virtual void setBubbleText(const std::string &text) override;
 
     private:
+        bool touchingClones(const std::vector<Sprite *> &clones) const override;
+
         spimpl::unique_impl_ptr<StagePrivate> impl;
 };
 

include/scratchcpp/target.h

@@ -18,6 +18,7 @@ class Block;
 class Comment;
 class Costume;
 class Sound;
+class Sprite;
 class IGraphicsEffect;
 class TargetPrivate;
 
@@ -88,6 +89,7 @@ class LIBSCRATCHCPP_EXPORT Target
         virtual Rect boundingRect() const;
         virtual Rect fastBoundingRect() const;
 
+        bool touchingSprite(Sprite *sprite) const;
         virtual bool touchingPoint(double x, double y) const;
         bool touchingEdge() const;
 
@@ -109,6 +111,9 @@ class LIBSCRATCHCPP_EXPORT Target
         /*! Override this method to set a custom data source for blocks, assets, comments, etc. */
         virtual Target *dataSource() const { return nullptr; }
 
+        /*! Override this method to check whether the target touches the given sprite clones. */
+        virtual bool touchingClones(const std::vector<Sprite *> &clones) const { return false; }
+
     private:
         spimpl::unique_impl_ptr<TargetPrivate> impl;
 };

src/scratch/sprite.cpp

@@ -477,6 +477,14 @@ Target *Sprite::dataSource() const
     return impl->cloneSprite;
 }
 
+bool Sprite::touchingClones(const std::vector<Sprite *> &clones) const
+{
+    if (!impl->iface)
+        return false;
+
+    return impl->iface->touchingClones(clones);
+}
+
 void Sprite::setXY(double x, double y)
 {
     IEngine *eng = engine();

src/scratch/stage.cpp

@@ -208,3 +208,11 @@ void Stage::setBubbleText(const std::string &text)
     if (impl->iface)
         impl->iface->onBubbleTextChanged(text);
 }
+
+bool Stage::touchingClones(const std::vector<Sprite *> &clones) const
+{
+    if (!impl->iface)
+        return false;
+
+    return impl->iface->touchingClones(clones);
+}

src/scratch/target.cpp

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <scratchcpp/target.h>
+#include <scratchcpp/sprite.h>
 #include <scratchcpp/variable.h>
 #include <scratchcpp/list.h>
 #include <scratchcpp/block.h>
@@ -431,6 +432,28 @@ Rect Target::fastBoundingRect() const
     return Rect();
 }
 
+/*! Returns true if the Target is touching the given Sprite (or its clones). */
+bool Target::touchingSprite(Sprite *sprite) const
+{
+    // https://github.com/scratchfoundation/scratch-vm/blob/8dbcc1fc8f8d8c4f1e40629fe8a388149d6dfd1c/src/sprites/rendered-target.js#L792-L805
+    if (!sprite)
+        return false;
+
+    Sprite *firstClone = sprite->isClone() ? sprite->cloneSprite() : sprite;
+    assert(firstClone);
+    std::vector<Sprite *> clones;
+
+    if (true) // TODO: Filter clones that are being dragged, including firstClone
+        clones.push_back(firstClone);
+
+    for (auto clone : firstClone->clones()) {
+        if (true) // TODO: Filter clones that are being dragged
+            clones.push_back(clone.get());
+    }
+
+    return touchingClones(clones);
+}
+
 /*! Returns true if the Target is touching the given point (in Scratch coordinates). */
 bool Target::touchingPoint(double x, double y) const
 {

test/mocks/spritehandlermock.h

@@ -31,5 +31,7 @@ class SpriteHandlerMock : public ISpriteHandler
 
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
+
+        MOCK_METHOD(bool, touchingClones, (const std::vector<Sprite *> &), (const, override));
         MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
 };

test/mocks/stagehandlermock.h

@@ -22,5 +22,7 @@ class StageHandlerMock : public IStageHandler
 
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
+
+        MOCK_METHOD(bool, touchingClones, (const std::vector<Sprite *> &), (const, override));
         MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
 };