Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial/src/orxonox/objects/Tickable.h @ 2258

Last change on this file since 2258 was 859, checked in by landauf, 17 years ago

more or less a copy of the trunk

File size: 2.9 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *
4 *
5 *   License notice:
6 *
7 *   This program is free software; you can redistribute it and/or
8 *   modify it under the terms of the GNU General Public License
9 *   as published by the Free Software Foundation; either version 2
10 *   of the License, or (at your option) any later version.
11 *
12 *   This program is distributed in the hope that it will be useful,
13 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 *   GNU General Public License for more details.
16 *
17 *   You should have received a copy of the GNU General Public License
18 *   along with this program; if not, write to the Free Software
19 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20 *
21 *   Author:
22 *      Fabian 'x3n' Landau
23 *   Co-authors:
24 *      ...
25 *
26 */
27
28/*!
29    @file Tickable.h
30    @brief Definition of the Tickable interface.
31
32    The Tickable interface provides a tick(dt) function, that gets called every frame.
33    float dt is the time since the last frame in seconds.
34
35    Attention:
36    Classes derived from a Tickable that want to have a tick(dt) function on their part, MUST call the
37    parent::tick(dt) function explicit in their implementation of tick(dt) because it's a virtual function.
38*/
39
40#ifndef _Tickable_H__
41#define _Tickable_H__
42
43#include <OgreFrameListener.h>
44
45#include "../OrxonoxPrereqs.h"
46
47#include "../core/CoreIncludes.h"
48
49namespace orxonox
50{
51    class TickFrameListener; // Forward declaration
52
53    //! The Tickable interface provides a tick(dt) function, that gets called every frame.
54    class _OrxonoxExport Tickable : virtual public OrxonoxClass
55    {
56        public:
57            /**
58                @brief Gets called every frame.
59                @param dt The time since the last frame in seconds
60            */
61            virtual void tick(float dt) = 0;
62
63        protected:
64            /**
65                @brief Constructor: Registers the object in the Tickable-list
66            */
67            Tickable() { RegisterRootObject(Tickable); }
68    };
69    ExportAbstractClass(Tickable, Orxonox);
70
71    //! The TickFrameListener calls the tick(dt) function of all Tickables every frame.
72    class _OrxonoxExport TickFrameListener : public Ogre::FrameListener
73    {
74        private:
75            /** @brief Gets called before a frame gets rendered. */
76            bool frameStarted(const Ogre::FrameEvent &evt)
77            {
78                // Iterate through all Tickables and call their tick(dt) function
79                for (Iterator<Tickable> it = ObjectList<Tickable>::start(); it; )
80                    (it++)->tick(evt.timeSinceLastFrame);
81
82                return FrameListener::frameStarted(evt);
83            }
84    };
85}
86
87#endif /* _Tickable_H__ */
Note: See TracBrowser for help on using the repository browser.