Replace redraw handler with a signal

Author: adazem009

include/scratchcpp/iengine.h

@@ -6,6 +6,7 @@
 #include <vector>
 #include <unordered_map>
 #include <functional>
+#include <sigslot/signal.hpp>
 
 #include "global.h"
 
@@ -109,8 +110,8 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Stops the event loop which is running in another thread. */
         virtual void stopEventLoop() = 0;
 
-        /*! Sets the function which is called on every frame. */
-        virtual void setRedrawHandler(const std::function<void()> &handler) = 0;
+        /*! Emits when rendering should occur. */
+        virtual sigslot::signal<> &aboutToRender() = 0;
 
         /*! Returns true if the project is currently running. */
         virtual bool isRunning() const = 0;

src/engine/internal/engine.cpp

@@ -486,8 +486,7 @@ void Engine::step()
     stepThreads();
 
     // Render
-    if (m_redrawHandler)
-        m_redrawHandler();
+    m_aboutToRedraw();
 }
 
 void Engine::run()
@@ -509,9 +508,9 @@ void Engine::stopEventLoop()
     m_stopEventLoopMutex.unlock();
 }
 
-void Engine::setRedrawHandler(const std::function<void()> &handler)
+sigslot::signal<> &Engine::aboutToRender()
 {
-    m_redrawHandler = handler;
+    return m_aboutToRedraw;
 }
 
 std::vector<std::shared_ptr<VirtualMachine>> Engine::stepThreads()

src/engine/internal/engine.h

@@ -49,7 +49,7 @@ class Engine : public IEngine
         void runEventLoop() override;
         void stopEventLoop() override;
 
-        void setRedrawHandler(const std::function<void()> &handler) override;
+        sigslot::signal<> &aboutToRender() override;
 
         bool isRunning() const override;
 
@@ -268,7 +268,7 @@ class Engine : public IEngine
 
         bool m_running = false;
         bool m_redrawRequested = false;
-        std::function<void()> m_redrawHandler = nullptr;
+        sigslot::signal<> m_aboutToRedraw;
         bool m_stopEventLoop = false;
         std::mutex m_stopEventLoopMutex;
 

test/engine/engine_test.cpp

@@ -341,7 +341,7 @@ TEST(EngineTest, FpsProject)
     engine->setFps(10);
     RedrawMock redrawMock;
     auto handler = std::bind(&RedrawMock::redraw, &redrawMock);
-    engine->setRedrawHandler(std::function<void()>(handler));
+    engine->aboutToRender().connect(handler);
     std::chrono::steady_clock::time_point time7(std::chrono::milliseconds(100));
     std::chrono::steady_clock::time_point time8(std::chrono::milliseconds(200));
     std::chrono::steady_clock::time_point time9(std::chrono::milliseconds(300));

test/mocks/enginemock.h

@@ -32,7 +32,7 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, runEventLoop, (), (override));
         MOCK_METHOD(void, stopEventLoop, (), (override));
 
-        MOCK_METHOD(void, setRedrawHandler, (const std::function<void()> &), (override));
+        MOCK_METHOD(sigslot::signal<> &, aboutToRender, (), (override));
 
         MOCK_METHOD(bool, isRunning, (), (const, override));