Add Monitor class

Author: adazem009

CMakeLists.txt

@@ -52,6 +52,7 @@ target_sources(scratchcpp
     include/scratchcpp/rect.h
     include/scratchcpp/igraphicseffect.h
     include/scratchcpp/comment.h
+    include/scratchcpp/monitor.h
 )
 
 add_library(zip SHARED

include/scratchcpp/monitor.h

@@ -0,0 +1,67 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <scratchcpp/entity.h>
+
+namespace libscratchcpp
+{
+
+class Block;
+class Sprite;
+class MonitorPrivate;
+
+/*! \brief The Monitor class represents a stage monitor. */
+class LIBSCRATCHCPP_EXPORT Monitor : public Entity
+{
+    public:
+        enum class Mode
+        {
+            Default,
+            Large,
+            Slider,
+            List
+        };
+
+        Monitor(const std::string &id, const std::string &opcode);
+        Monitor(const Monitor &) = delete;
+
+        Mode mode() const;
+        void setMode(Mode mode);
+
+        std::shared_ptr<Block> block() const;
+
+        Sprite *sprite() const;
+        void setSprite(Sprite *sprite);
+
+        const std::string &opcode() const;
+
+        unsigned int width() const;
+        void setWidth(unsigned int width);
+
+        unsigned int height() const;
+        void setHeight(unsigned int height);
+
+        int x() const;
+        void setX(int x);
+
+        int y() const;
+        void setY(int y);
+
+        bool visible() const;
+        void setVisible(bool visible);
+
+        double sliderMin() const;
+        void setSliderMin(double sliderMin);
+
+        double sliderMax() const;
+        void setSliderMax(double sliderMax);
+
+        bool discrete() const;
+        void setDiscrete(bool discrete);
+
+    private:
+        spimpl::unique_impl_ptr<MonitorPrivate> impl;
+};
+
+} // namespace libscratchcpp

src/scratch/CMakeLists.txt

@@ -51,4 +51,7 @@ target_sources(scratchcpp
     comment.cpp
     comment_p.cpp
     comment_p.h
+    monitor.cpp
+    monitor_p.cpp
+    monitor_p.h
 )

src/scratch/monitor.cpp

@@ -0,0 +1,148 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/monitor.h>
+#include <scratchcpp/block.h>
+#include <scratchcpp/sprite.h>
+
+#include "monitor_p.h"
+
+using namespace libscratchcpp;
+
+/*! Constructs Monitor. */
+Monitor::Monitor(const std::string &id, const std::string &opcode) :
+    Entity(id),
+    impl(spimpl::make_unique_impl<MonitorPrivate>(opcode))
+{
+}
+
+/*! Returns the monitor's mode. */
+Monitor::Mode Monitor::mode() const
+{
+    return impl->mode;
+}
+
+/*! Sets the monitor's mode. */
+void Monitor::setMode(Mode mode)
+{
+    impl->mode = mode;
+}
+
+/*! Returns the block used to get the monitor's value. */
+std::shared_ptr<Block> Monitor::block() const
+{
+    return impl->block;
+}
+
+/*! Convenience method which calls block()->target(). */
+Sprite *Monitor::sprite() const
+{
+    return dynamic_cast<Sprite *>(impl->block->target());
+}
+
+/*! Convenience method which calls block()->setTarget(). */
+void Monitor::setSprite(Sprite *sprite)
+{
+    impl->block->setTarget(sprite);
+}
+
+/*! Convenience method which calls block()->opcode(). */
+const std::string &Monitor::opcode() const
+{
+    return impl->block->opcode();
+}
+
+/*! Returns the monitor's width. */
+unsigned int Monitor::width() const
+{
+    return impl->width;
+}
+
+/*! Sets the monitor's width. */
+void Monitor::setWidth(unsigned int width)
+{
+    impl->width = width;
+}
+
+/*! Returns the monitor's height. */
+unsigned int Monitor::height() const
+{
+    return impl->height;
+}
+
+/*! Sets the monitor's height. */
+void Monitor::setHeight(unsigned int height)
+{
+    impl->height = height;
+}
+
+/*! Returns the monitor's x-coordinate. */
+int Monitor::x() const
+{
+    return impl->x;
+}
+
+/*! Sets the monitor's x-coordinate. */
+void Monitor::setX(int x)
+{
+    impl->x = x;
+}
+
+/*! Returns the monitor's y-coordinate. */
+int Monitor::y() const
+{
+    return impl->y;
+}
+
+/*! Sets the monitor's y-coordinate. */
+void Monitor::setY(int y)
+{
+    impl->y = y;
+}
+
+/*! Returns true if the monitor is visible. */
+bool Monitor::visible() const
+{
+    return impl->visible;
+}
+
+/*! Sets whether the monitor is visible or not. */
+void Monitor::setVisible(bool visible)
+{
+    impl->visible = visible;
+}
+
+/*! Returns the minimum value of the monitor's slider. */
+double Monitor::sliderMin() const
+{
+    return impl->sliderMin;
+}
+
+/*! Sets the minimum value of the monitor's slider. */
+void Monitor::setSliderMin(double sliderMin)
+{
+    impl->sliderMin = sliderMin;
+}
+
+/*! Returns the maximum value of the monitor's slider. */
+double Monitor::sliderMax() const
+{
+    return impl->sliderMax;
+}
+
+/*! Sets the maximum value of the monitor's slider. */
+void Monitor::setSliderMax(double sliderMax)
+{
+    impl->sliderMax = sliderMax;
+}
+
+/*! Returns true if the monitor's slider allows only integer values. */
+bool Monitor::discrete() const
+{
+    return impl->discrete;
+}
+
+/*! Sets whether the monitor's slider allows only integer values. */
+void Monitor::setDiscrete(bool discrete)
+{
+    impl->discrete = discrete;
+}

src/scratch/monitor_p.cpp

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/block.h>
+
+#include "monitor_p.h"
+
+using namespace libscratchcpp;
+
+MonitorPrivate::MonitorPrivate(const std::string &opcode) :
+    block(std::make_shared<Block>("", opcode))
+{
+}

src/scratch/monitor_p.h

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <scratchcpp/monitor.h>
+
+namespace libscratchcpp
+{
+
+class Block;
+
+struct MonitorPrivate
+{
+        MonitorPrivate(const std::string &opcode);
+        MonitorPrivate(const MonitorPrivate &) = delete;
+
+        Monitor::Mode mode = Monitor::Mode::Default;
+        std::shared_ptr<Block> block; // Compiler needs shared_ptr
+        unsigned int width = 0;
+        unsigned int height = 0;
+        int x = 0;
+        int y = 0;
+        bool visible = true;
+        double sliderMin = 0;
+        double sliderMax = 0;
+        bool discrete = false;
+};
+
+} // namespace libscratchcpp

test/scratch_classes/CMakeLists.txt

@@ -217,3 +217,17 @@ target_link_libraries(
 )
 
 gtest_discover_tests(comment_test)
+
+# monitor_test
+add_executable(
+  monitor_test
+  monitor_test.cpp
+)
+
+target_link_libraries(
+  monitor_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(monitor_test)