X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=src%2FMoof%2FEngine.hh;h=c5e99864f103e49dedffee2721609f48e136fe84;hp=0617b1a5c3094025331233fe4c8ced0a5742010e;hb=71bd9dbaf1c1e3c55a9f63392a73865d8aeee7d4;hpb=57b78ebe21b1b48acd337daa5a1cb8c383959cfa diff --git a/src/Moof/Engine.hh b/src/Moof/Engine.hh index 0617b1a..c5e9986 100644 --- a/src/Moof/Engine.hh +++ b/src/Moof/Engine.hh @@ -29,64 +29,71 @@ #ifndef _MOOF_ENGINE_HH_ #define _MOOF_ENGINE_HH_ -#include - #include -#include -#include -#include +#include +#include +#include namespace Mf { -// forward declaration -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 { -protected: +public: - Engine(int argc, char* argv[], const std::string& configFile, - const std::string& name, const std::string& iconFile); + ~Engine() {} -public: + // get global instance + static Engine& getInstance(); - virtual ~Engine(); + // 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; - int run(); - void stop(int exitCode = 0); + void setTimestep(int ts); + int getTimestep() const; - void setTimestep(Scalar ts); - Scalar getTimestep(); - void setMaxFrameRate(long maxFps); - long getMaxFrameRate(); + void setMaxFps(int maxFps); // draw rate is always capped at the timestep + int getMaxFps() const; - Video& getVideo(); - long getFrameRate(); + int getFps() const; - // override these if you want - virtual void update(Scalar t, Scalar dt); - virtual void draw(Scalar alpha); - virtual void handleEvent(const Event& event); + 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) - struct Exception : public Mf::Exception - { - explicit Exception(unsigned error) : - Mf::Exception(error) {} + int getSize() const; // get the size of the stack - void raise() - { - throw *this; - } - }; + // set this machine in motion + void run(); + + 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() {} // this class must be subclassed to be useful + + Engine(); // use getInstance() to access the engine class Impl; - boost::shared_ptr impl_; + boost::shared_ptr mImpl; };