Add Drawable class

Author: adazem009

CMakeLists.txt

@@ -51,6 +51,7 @@ target_sources(scratchcpp
     include/scratchcpp/block.h
     include/scratchcpp/istagehandler.h
     include/scratchcpp/ispritehandler.h
+    include/scratchcpp/drawable.h
     include/scratchcpp/target.h
     include/scratchcpp/stage.h
     include/scratchcpp/sprite.h

include/scratchcpp/drawable.h

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "global.h"
+#include "spimpl.h"
+
+namespace libscratchcpp
+{
+
+class DrawablePrivate;
+
+/*! \brief The Drawable class is the base class of rendered elements (stage, sprites, text bubbles). */
+class LIBSCRATCHCPP_EXPORT Drawable
+{
+    public:
+        Drawable();
+        Drawable(const Drawable &) = delete;
+
+        int layerOrder() const;
+        virtual void setLayerOrder(int newLayerOrder);
+
+    private:
+        spimpl::unique_impl_ptr<DrawablePrivate> impl;
+};
+
+} // namespace libscratchcpp

include/scratchcpp/target.h

@@ -4,8 +4,7 @@
 
 #include <vector>
 
-#include "global.h"
-#include "spimpl.h"
+#include "drawable.h"
 #include "rect.h"
 #include "sound.h"
 
@@ -24,7 +23,7 @@ class IGraphicsEffect;
 class TargetPrivate;
 
 /*! \brief The Target class is the Stage or a Sprite. */
-class LIBSCRATCHCPP_EXPORT Target
+class LIBSCRATCHCPP_EXPORT Target : public Drawable
 {
     public:
         enum class BubbleType
@@ -83,9 +82,6 @@ class LIBSCRATCHCPP_EXPORT Target
         std::shared_ptr<Sound> soundAt(int index) const;
         int findSound(const std::string &soundName) const;
 
-        int layerOrder() const;
-        virtual void setLayerOrder(int newLayerOrder);
-
         double volume() const;
         void setVolume(double newVolume);
 

src/scratch/CMakeLists.txt

@@ -2,6 +2,9 @@ target_sources(scratchcpp
   PRIVATE
     value_functions.cpp
     value_functions_p.h
+    drawable.cpp
+    drawable_p.cpp
+    drawable_p.h
     target.cpp
     target_p.cpp
     target_p.h

src/scratch/drawable.cpp

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/drawable.h>
+
+#include "drawable_p.h"
+
+using namespace libscratchcpp;
+
+/*! Constructs Drawable. */
+Drawable::Drawable() :
+    impl(spimpl::make_unique_impl<DrawablePrivate>())
+{
+}
+
+/*! Returns the layer number. */
+int Drawable::layerOrder() const
+{
+    return impl->layerOrder;
+}
+
+/*! Sets the layer number. */
+void Drawable::setLayerOrder(int newLayerOrder)
+{
+    impl->layerOrder = newLayerOrder;
+}

src/scratch/drawable_p.cpp

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "drawable_p.h"
+
+using namespace libscratchcpp;

src/scratch/drawable_p.h

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+namespace libscratchcpp
+{
+
+struct DrawablePrivate
+{
+        int layerOrder = 0;
+};
+
+} // namespace libscratchcpp

src/scratch/target.cpp

@@ -24,6 +24,7 @@ static std::unordered_map<Sound::Effect, std::pair<double, double>> SOUND_EFFECT
 
 /*! Constructs target. */
 Target::Target() :
+    Drawable(),
     impl(spimpl::make_unique_impl<TargetPrivate>())
 {
 }
@@ -394,18 +395,6 @@ int Target::findSound(const std::string &soundName) const
         return it - impl->sounds.begin();
 }
 
-/*! Returns the layer number. */
-int Target::layerOrder() const
-{
-    return impl->layerOrder;
-}
-
-/*! Sets the layer number. */
-void Target::setLayerOrder(int newLayerOrder)
-{
-    impl->layerOrder = newLayerOrder;
-}
-
 /*! Returns the volume. */
 double Target::volume() const
 {

src/scratch/target_p.h

@@ -34,7 +34,6 @@ struct TargetPrivate
         int costumeIndex = -1;
         std::vector<std::shared_ptr<Costume>> costumes;
         std::vector<std::shared_ptr<Sound>> sounds;
-        int layerOrder = 0;
         double volume = 100;
         std::unordered_map<Sound::Effect, double> soundEffects;
         std::unordered_map<IGraphicsEffect *, double> graphicsEffects;

test/scratch_classes/CMakeLists.txt

@@ -26,6 +26,20 @@ target_link_libraries(
 
 gtest_discover_tests(list_test)
 
+# drawable_test
+add_executable(
+  drawable_test
+  drawable_test.cpp
+)
+
+target_link_libraries(
+  drawable_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(drawable_test)
+
 # sprite_test
 add_executable(
   sprite_test