Merge pull request #530 from scratchcpp/sprite_dragging_api

Add API for sprite dragging

Author: adazem009

include/scratchcpp/sprite.h

@@ -49,6 +49,11 @@ class LIBSCRATCHCPP_EXPORT Sprite
 
         void setPosition(double x, double y);
 
+        bool dragging() const;
+        void startDragging();
+        void stopDragging();
+        void dragToPosition(double x, double y);
+
         double size() const;
         void setSize(double newSize);
 

src/scratch/sprite.cpp

@@ -169,6 +169,9 @@ double Sprite::x() const
 /*! Sets the X position of the sprite. */
 void Sprite::setX(double newX)
 {
+    if (impl->dragging)
+        return;
+
     setXY(newX, impl->y);
 
     if (impl->iface)
@@ -184,6 +187,9 @@ double Sprite::y() const
 /*! Sets the Y position of the sprite. */
 void Sprite::setY(double newY)
 {
+    if (impl->dragging)
+        return;
+
     setXY(impl->x, newY);
 
     if (impl->iface)
@@ -193,6 +199,42 @@ void Sprite::setY(double newY)
 /* Sets the position of the sprite. */
 void Sprite::setPosition(double x, double y)
 {
+    if (impl->dragging)
+        return;
+
+    setXY(x, y);
+
+    if (impl->iface) {
+        impl->iface->onXChanged(impl->x);
+        impl->iface->onYChanged(impl->y);
+    }
+}
+
+/*! Returns true if the sprite is being dragged. */
+bool Sprite::dragging() const
+{
+    return impl->dragging;
+}
+
+/*! Starts dragging. Calls to setX(), setY() and setPosition() will be ignored until stopDragging() is called. */
+void Sprite::startDragging()
+{
+    impl->dragging = true;
+}
+
+/*! Stops dragging. */
+void Sprite::stopDragging()
+{
+    impl->dragging = false;
+}
+
+/*!
+ * Drags the sprite to the given position.
+ * \note If startDragging() wasn't called before calling this method, dragging will be started automatically.
+ */
+void Sprite::dragToPosition(double x, double y)
+{
+    impl->dragging = true;
     setXY(x, y);
 
     if (impl->iface) {

src/scratch/sprite_p.h

@@ -30,6 +30,7 @@ struct SpritePrivate
         double size = 100;
         double direction = 90;
         bool draggable = false;
+        bool dragging = false;
         Sprite::RotationStyle rotationStyle = Sprite::RotationStyle::AllAround;
 };
 

test/scratch_classes/sprite_test.cpp

@@ -377,6 +377,59 @@ TEST(SpriteTest, XY)
     ASSERT_EQ(sprite.y(), -23);
 }
 
+TEST(SpriteTest, Dragging)
+{
+    Sprite sprite;
+    SpriteHandlerMock handler;
+    EXPECT_CALL(handler, init);
+    sprite.setInterface(&handler);
+    ASSERT_FALSE(sprite.dragging());
+
+    sprite.startDragging();
+    ASSERT_TRUE(sprite.dragging());
+
+    sprite.setX(10);
+    ASSERT_EQ(sprite.x(), 0);
+    sprite.setY(-56);
+    ASSERT_EQ(sprite.y(), 0);
+    sprite.setPosition(-2.8, 54.1);
+    ASSERT_EQ(sprite.x(), 0);
+    ASSERT_EQ(sprite.y(), 0);
+
+    EXPECT_CALL(handler, onMoved);
+    EXPECT_CALL(handler, onXChanged);
+    EXPECT_CALL(handler, onYChanged);
+    sprite.dragToPosition(34.2, -89.7);
+    ASSERT_EQ(sprite.x(), 34.2);
+    ASSERT_EQ(sprite.y(), -89.7);
+    ASSERT_TRUE(sprite.dragging());
+
+    sprite.stopDragging();
+    ASSERT_FALSE(sprite.dragging());
+
+    EXPECT_CALL(handler, onMoved);
+    EXPECT_CALL(handler, onXChanged);
+    EXPECT_CALL(handler, onYChanged);
+    sprite.setPosition(-2.8, 54.1);
+    ASSERT_EQ(sprite.x(), -2.8);
+    ASSERT_EQ(sprite.y(), 54.1);
+
+    EXPECT_CALL(handler, onMoved);
+    EXPECT_CALL(handler, onXChanged);
+    EXPECT_CALL(handler, onYChanged);
+    sprite.dragToPosition(-34.2, 89.7);
+    ASSERT_EQ(sprite.x(), -34.2);
+    ASSERT_EQ(sprite.y(), 89.7);
+    ASSERT_TRUE(sprite.dragging());
+
+    sprite.setPosition(-2.8, 54.1);
+    ASSERT_EQ(sprite.x(), -34.2);
+    ASSERT_EQ(sprite.y(), 89.7);
+
+    sprite.stopDragging();
+    ASSERT_FALSE(sprite.dragging());
+}
+
 TEST(SpriteTest, Size)
 {
     Sprite sprite;