]>
Dogcows Code - chaz/yoink/blob - src/Moof/Engine.hh
07e982abd9ee4207478d077b8365cedc01897643
2 /*******************************************************************************
4 Copyright (c) 2009, Charles McGarvey
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
10 * Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright notice,
13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution.
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *******************************************************************************/
29 #ifndef _MOOF_ENGINE_HH_
30 #define _MOOF_ENGINE_HH_
32 #include <boost/shared_ptr.hpp>
34 #include <Moof/Dispatch.hh>
35 #include <Moof/Error.hh>
36 #include <Moof/Video.hh>
37 #include <Moof/Layer.hh>
44 * The engine is essentially a stack of layers. While running, it updates each
45 * layer from the bottom up every timestep. It also draws each layer from the
46 * bottom up, adhering to the maximum frame-rate. Events are sent to each layer
47 * from the top down until a layer signals the event was handled. The engine is
48 * also responsible for firing timers on time. The engine will continue running
49 * as long as there are layers on the stack.
59 const Error
& getError() const;
61 // setting the video is required before you can run the engine and should
62 // probably be done before adding any layers
63 void setVideo(VideoP video
);
64 VideoP
getVideo() const;
66 void setTimestep(int ts
);
67 int getTimestep() const;
69 void setMaxFps(int maxFps
); // draw rate is always capped at the timestep
70 int getMaxFps() const;
74 void push(LayerP layer
); // push a layer onto the top
75 LayerP
pop(); // pop the top layer
76 LayerP
pop(Layer
* layer
); // pops a specific layer and all layers above it
77 void clear(); // remove all layers (the engine will stop)
79 int getSize() const; // get the size of the stack
81 // set this machine in motion
84 Dispatch::Handler
addHandler(const std::string
& event
,
85 const Dispatch::Function
& callback
);
86 Dispatch::Handler
addHandler(const std::string
& event
,
87 const Dispatch::Function
& callback
, Dispatch::Handler handler
);
89 void dispatch(const std::string
& event
,
90 const Dispatch::Message
* message
= 0);
95 boost::shared_ptr
<Impl
> mImpl
;
104 #endif // _MOOF_ENGINE_HH_
106 /** vim: set ts=4 sw=4 tw=80: *************************************************/
This page took 0.036113 seconds and 4 git commands to generate.