added 3dengfx into the repo, probably not the correct version for this
[summerhack] / src / 3dengfx / src / sim / sim.hpp
1 /*
2 This file is part of the simulation module of 3dengfx.
3
4 Copyright (c) 2005 John Tsiombikas <nuclear@siggraph.org>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20
21 /* provides a basic framework for running time-based simulations
22  *
23  * Author: John Tsiombikas 2005
24  */
25
26 #ifndef _SIM_HPP_
27 #define _SIM_HPP_
28
29 #include "n3dmath2/n3dmath2.hpp"
30 #include "common/timer.h"
31
32 #define SIM_STD_TIMESLICE       1.0 / 30.0
33
34 class Simulation {
35 private:
36         scalar_t timeslice;             // time between two updates (in seconds)
37         scalar_t prev_update;
38         ntimer timer;
39
40 protected:
41         virtual void run(unsigned long msec) = 0;       // override this
42
43 public:
44         Simulation(scalar_t timeslice = SIM_STD_TIMESLICE);
45         virtual ~Simulation();
46
47         void start();
48         void stop();
49         void reset();
50
51         void update();
52         void update(unsigned long msec);        // overrides dedicated timer
53 };
54         
55
56 #endif  // _SIM_HPP_