Move engine property from Target to Drawable

Author: adazem009

include/scratchcpp/drawable.h

@@ -8,6 +8,8 @@
 namespace libscratchcpp
 {
 
+class IEngine;
+
 class DrawablePrivate;
 
 /*! \brief The Drawable class is the base class of rendered elements (stage, sprites, text bubbles). */
@@ -26,6 +28,9 @@ class LIBSCRATCHCPP_EXPORT Drawable
         int layerOrder() const;
         virtual void setLayerOrder(int newLayerOrder);
 
+        IEngine *engine() const;
+        void setEngine(IEngine *engine);
+
     private:
         spimpl::unique_impl_ptr<DrawablePrivate> impl;
 };

include/scratchcpp/target.h

@@ -11,7 +11,6 @@
 namespace libscratchcpp
 {
 
-class IEngine;
 class Variable;
 class List;
 class Block;
@@ -104,9 +103,6 @@ class LIBSCRATCHCPP_EXPORT Target : public Drawable
         TextBubble *bubble();
         const TextBubble *bubble() const;
 
-        IEngine *engine() const;
-        void setEngine(IEngine *engine);
-
     protected:
         /*! Override this method to set a custom data source for blocks, assets, comments, etc. */
         virtual Target *dataSource() const { return nullptr; }

src/scratch/drawable.cpp

@@ -23,3 +23,15 @@ void Drawable::setLayerOrder(int newLayerOrder)
 {
     impl->layerOrder = newLayerOrder;
 }
+
+/*! Returns the engine. */
+IEngine *Drawable::engine() const
+{
+    return impl->engine;
+}
+
+/*! Sets the engine. */
+void Drawable::setEngine(IEngine *engine)
+{
+    impl->engine = engine;
+}

src/scratch/drawable_p.h

@@ -5,9 +5,12 @@
 namespace libscratchcpp
 {
 
+class IEngine;
+
 struct DrawablePrivate
 {
         int layerOrder = 0;
+        IEngine *engine = nullptr;
 };
 
 } // namespace libscratchcpp

src/scratch/target.cpp

@@ -280,8 +280,10 @@ void Target::setCostumeIndex(int newCostumeIndex)
         impl->costumeIndex = newCostumeIndex;
 
     if (isStage()) {
-        if (impl->engine)
-            impl->engine->requestRedraw();
+        IEngine *eng = engine();
+
+        if (eng)
+            eng->requestRedraw();
     }
 }
 
@@ -509,9 +511,11 @@ bool Target::touchingPoint(double x, double y) const
 bool Target::touchingEdge() const
 {
     // https://github.com/scratchfoundation/scratch-vm/blob/8dbcc1fc8f8d8c4f1e40629fe8a388149d6dfd1c/src/sprites/rendered-target.js#L772-L785
-    if (impl->engine) {
-        const double stageWidth = impl->engine->stageWidth();
-        const double stageHeight = impl->engine->stageHeight();
+    IEngine *eng = engine();
+
+    if (eng) {
+        const double stageWidth = eng->stageWidth();
+        const double stageHeight = eng->stageHeight();
         Rect bounds = boundingRect();
 
         if ((bounds.left() < -stageWidth / 2) || (bounds.right() > stageWidth / 2) || (bounds.top() > stageHeight / 2) || (bounds.bottom() < -stageHeight / 2))
@@ -568,15 +572,3 @@ const TextBubble *Target::bubble() const
 {
     return &impl->bubble;
 }
-
-/*! Returns the engine. */
-IEngine *Target::engine() const
-{
-    return impl->engine;
-}
-
-/*! Sets the engine. */
-void Target::setEngine(IEngine *engine)
-{
-    impl->engine = engine;
-}

src/scratch/target_p.h

@@ -26,7 +26,6 @@ struct TargetPrivate
         TargetPrivate();
         TargetPrivate(const TargetPrivate &) = delete;
 
-        IEngine *engine = nullptr;
         std::string name;
         std::vector<std::shared_ptr<Variable>> variables;
         std::vector<std::shared_ptr<List>> lists;

test/scratch_classes/CMakeLists.txt

@@ -35,7 +35,9 @@ add_executable(
 target_link_libraries(
   drawable_test
   GTest::gtest_main
+  GTest::gmock_main
   scratchcpp
+  scratchcpp_mocks
 )
 
 gtest_discover_tests(drawable_test)

test/scratch_classes/drawable_test.cpp

@@ -1,4 +1,5 @@
 #include <scratchcpp/drawable.h>
+#include <enginemock.h>
 
 #include "../common.h"
 
@@ -23,3 +24,13 @@ TEST(DrawableTest, LayerOrder)
     drawable.setLayerOrder(2);
     ASSERT_EQ(drawable.layerOrder(), 2);
 }
+
+TEST(TargetTest, Engine)
+{
+    Drawable drawable;
+    ASSERT_EQ(drawable.engine(), nullptr);
+
+    EngineMock engine;
+    drawable.setEngine(&engine);
+    ASSERT_EQ(drawable.engine(), &engine);
+}

test/scratch_classes/target_test.cpp

@@ -797,16 +797,6 @@ TEST(SpriteTest, BubbleTextRedraw)
     target.bubble()->setText("");
 }
 
-TEST(TargetTest, Engine)
-{
-    Target target;
-    ASSERT_EQ(target.engine(), nullptr);
-
-    EngineMock engine;
-    target.setEngine(&engine);
-    ASSERT_EQ(target.engine(), &engine);
-}
-
 TEST(TargetTest, DataSource)
 {
     TargetMock target;