Add touchingPoint() method

Author: adazem009

include/scratchcpp/ispritehandler.h

@@ -77,6 +77,9 @@ class LIBSCRATCHCPP_EXPORT ISpriteHandler
          * \note The rectangle must be relative to the stage, so make sure to use the sprite's coordinates.
          */
         virtual Rect fastBoundingRect() const = 0;
+
+        /*! Used to check whether the sprite touches the given point (in Scratch coordinates). */
+        virtual bool touchingPoint(double x, double y) const = 0;
 };
 
 } // namespace libscratchcpp

include/scratchcpp/istagehandler.h

@@ -52,6 +52,9 @@ class LIBSCRATCHCPP_EXPORT IStageHandler
          * which is calculated by transforming the costume rectangle.
          */
         virtual Rect fastBoundingRect() const = 0;
+
+        /*! Used to check whether the stage touches the given point (in Scratch coordinates). */
+        virtual bool touchingPoint(double x, double y) const = 0;
 };
 
 } // namespace libscratchcpp

include/scratchcpp/sprite.h

@@ -72,6 +72,8 @@ class LIBSCRATCHCPP_EXPORT Sprite
         Rect fastBoundingRect() const override;
         void keepInFence(double newX, double newY, double *fencedX, double *fencedY) const;
 
+        bool touchingPoint(double x, double y) const override;
+
         void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
 
         void clearGraphicsEffects() override;

include/scratchcpp/stage.h

@@ -51,6 +51,8 @@ class LIBSCRATCHCPP_EXPORT Stage : public Target
         Rect boundingRect() const override;
         Rect fastBoundingRect() const override;
 
+        bool touchingPoint(double x, double y) const override;
+
         void setGraphicsEffectValue(IGraphicsEffect *effect, double value) override;
 
         void clearGraphicsEffects() override;

include/scratchcpp/target.h

@@ -88,6 +88,7 @@ class LIBSCRATCHCPP_EXPORT Target
         virtual Rect boundingRect() const;
         virtual Rect fastBoundingRect() const;
 
+        virtual bool touchingPoint(double x, double y) const;
         bool touchingEdge() const;
 
         double graphicsEffectValue(IGraphicsEffect *effect) const;

src/scratch/sprite.cpp

@@ -406,6 +406,15 @@ void Sprite::keepInFence(double newX, double newY, double *fencedX, double *fenc
     *fencedY = newY + dy;
 }
 
+/*! Overrides Target#touchingPoint(). */
+bool Sprite::touchingPoint(double x, double y) const
+{
+    if (!impl->iface)
+        return false;
+
+    return impl->iface->touchingPoint(x, y);
+}
+
 /*! Overrides Target#setGraphicsEffectValue(). */
 void Sprite::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
 {

src/scratch/stage.cpp

@@ -149,6 +149,15 @@ Rect Stage::fastBoundingRect() const
     return impl->iface->fastBoundingRect();
 }
 
+/*! Overrides Target#touchingPoint(). */
+bool Stage::touchingPoint(double x, double y) const
+{
+    if (!impl->iface)
+        return false;
+
+    return impl->iface->touchingPoint(x, y);
+}
+
 /*! Overrides Target#setGraphicsEffectValue(). */
 void Stage::setGraphicsEffectValue(IGraphicsEffect *effect, double value)
 {

src/scratch/target.cpp

@@ -431,6 +431,12 @@ Rect Target::fastBoundingRect() const
     return Rect();
 }
 
+/*! Returns true if the Target is touching the given point (in Scratch coordinates). */
+bool Target::touchingPoint(double x, double y) const
+{
+    return false;
+}
+
 /*! Returns true if the target is touching the edge. */
 bool Target::touchingEdge() const
 {

test/mocks/spritehandlermock.h

@@ -31,4 +31,5 @@ class SpriteHandlerMock : public ISpriteHandler
 
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
+        MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
 };

test/mocks/stagehandlermock.h

@@ -22,4 +22,5 @@ class StageHandlerMock : public IStageHandler
 
         MOCK_METHOD(Rect, boundingRect, (), (const, override));
         MOCK_METHOD(Rect, fastBoundingRect, (), (const, override));
+        MOCK_METHOD(bool, touchingPoint, (double, double), (const, override));
 };