X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=src%2FMoof%2FEngine.hh;h=c5e99864f103e49dedffee2721609f48e136fe84;hp=e42510d3d86af61744bab076f2186249e1e91e26;hb=71bd9dbaf1c1e3c55a9f63392a73865d8aeee7d4;hpb=a31d65a998121df0651c57bfb68782e2a07d2e2f

diff --git a/src/Moof/Engine.hh b/src/Moof/Engine.hh
index e42510d..c5e9986 100644
--- a/src/Moof/Engine.hh
+++ b/src/Moof/Engine.hh
@@ -31,57 +31,69 @@
 
 #include <boost/shared_ptr.hpp>
 
-#include <Moof/Exception.hh>
+#include <Moof/Dispatch.hh>
+#include <Moof/Video.hh>
 #include <Moof/Layer.hh>
-#include <Moof/Math.hh>
 
 
 namespace Mf {
 
 
-// forward declarations
-class Video;
+/**
+ * The engine is essentially a stack of layers.  While running, it updates each
+ * layer from the bottom up every timestep.  It also draws each layer from the
+ * bottom up, adhering to the maximum frame-rate.  Events are send to each layer
+ * from the top down until a layer signals the event was handled.  The engine is
+ * also responsible for firing timers on time.  The engine will continue running
+ * as long as there are layers on the stack.
+ */
 
 class Engine
 {
-	class Impl;
-	boost::shared_ptr<Impl> mImpl;
-
 public:
 
-	Engine(int argc, char* argv[], const std::string& name, 
-			const std::string& iconFile, const std::string& configFile);
 	~Engine() {}
 
 	// get global instance
 	static Engine& getInstance();
 
+	// setting the video is required before you can run the engine and should
+	// probably be done before adding any layers
+	void setVideo(VideoP video);
+	VideoP getVideo() const;
+
+	void setTimestep(int ts);
+	int getTimestep() const;
+
+	void setMaxFps(int maxFps);	// draw rate is always capped at the timestep
+	int getMaxFps() const;
+
+	int getFps() const;
+
+	void push(LayerP layer);	// push a layer onto the top
+	LayerP pop();				// pop the top layer
+	LayerP pop(Layer* layer);	// pops a specific layer and all layers above it
+	void clear();				// remove all layers (the engine will stop)
+
+	int getSize() const;		// get the size of the stack
+
+	// set this machine in motion
 	void run();
 
-	void setTimestep(Scalar ts);
-	Scalar getTimestep() const;
-	void setMaxFrameRate(long maxFps);
-	long getMaxFrameRate() const;
-
-	Video& getVideo() const;
-	long getFrameRate() const;
-
-	void push(LayerP layer);
-	LayerP pop();
-	// pops a specific layer and all layers above it
-	LayerP pop(Layer* layer);
-	void clear();
-
-	struct Exception : public Mf::Exception
-	{
-		explicit Exception(unsigned error) :
-			Mf::Exception(error) {}
-
-		void raise()
-		{
-			throw *this;
-		}
-	};
+	Dispatch::Handler addHandler(const std::string& event,
+			const Dispatch::Function& callback);
+	Dispatch::Handler addHandler(const std::string& event,
+			const Dispatch::Function& callback, Dispatch::Handler handler);
+
+	void dispatch(const std::string& event,
+			const Dispatch::Message* message = 0);
+
+private:
+
+	Engine();		// use getInstance() to access the engine
+
+	class Impl;
+	boost::shared_ptr<Impl> mImpl;
 };