Sprite: Add clone info methods

Author: adazem009

include/scratchcpp/sprite.h

@@ -22,9 +22,15 @@ class LIBSCRATCHCPP_EXPORT Sprite : public Target
         };
 
         Sprite();
+        ~Sprite();
 
         void setInterface(ISpriteHandler *newInterface);
 
+        bool isClone() const;
+
+        Sprite *cloneRoot() const;
+        Sprite *cloneParent() const;
+
         bool visible() const;
         void setVisible(bool newVisible);
 

src/scratch/sprite.cpp

@@ -16,6 +16,15 @@ Sprite::Sprite() :
 {
 }
 
+/*! Destroys the Sprite object. */
+Sprite::~Sprite()
+{
+    if (isClone()) {
+        assert(impl->cloneParent);
+        impl->cloneParent->impl->removeClone(this);
+    }
+}
+
 /*! Sets the sprite interface. */
 void Sprite::setInterface(ISpriteHandler *newInterface)
 {
@@ -24,6 +33,24 @@ void Sprite::setInterface(ISpriteHandler *newInterface)
     impl->iface->onSpriteChanged(this);
 }
 
+/*! Returns true if this is a clone. */
+bool Sprite::isClone() const
+{
+    return (impl->cloneParent != nullptr);
+}
+
+/*! Returns the sprite this clone was created from, or nullptr if this isn't a clone. */
+Sprite *Sprite::cloneRoot() const
+{
+    return impl->cloneRoot;
+}
+
+/*! Returns the sprite or clone this clone was created from, or nullptr if this isn't a clone. */
+Sprite *Sprite::cloneParent() const
+{
+    return impl->cloneParent;
+}
+
 /*! Returns true if the sprite is visible. */
 bool Sprite::visible() const
 {

src/scratch/sprite_p.cpp

@@ -10,6 +10,19 @@ SpritePrivate::SpritePrivate()
 {
 }
 
+void SpritePrivate::removeClone(Sprite *clone)
+{
+    int index = 0;
+    for (const auto &child : childClones) {
+        if (child.get() == clone) {
+            childClones.erase(childClones.begin() + index);
+            return;
+        }
+
+        index++;
+    }
+}
+
 void SpritePrivate::setCostumeData(const char *data)
 {
     if (iface)

src/scratch/sprite_p.h

@@ -12,9 +12,14 @@ struct SpritePrivate
         SpritePrivate();
         SpritePrivate(const SpritePrivate &) = delete;
 
+        void removeClone(Sprite *clone);
+
         void setCostumeData(const char *data);
 
         ISpriteHandler *iface = nullptr;
+        Sprite *cloneRoot = nullptr;
+        Sprite *cloneParent = nullptr;
+        std::vector<std::shared_ptr<Sprite>> childClones;
         bool visible = true;
         double x = 0;
         double y = 0;