Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/mac_HS16/src/libraries/tools/interfaces/Tickable.h

Last change on this file was 9667, checked in by landauf, 11 years ago

merged core6 back to trunk

  • Property svn:eol-style set to native
File size: 2.0 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/*!
30    @file
31    @brief Declaration of the Tickable interface.
32
33    The Tickable interface provides a tick(dt) function, that gets called every frame.
34    float dt is the time since the last frame in seconds.
35
36    Attention:
37    Classes derived from a Tickable that want to have a tick(dt) function on their part, MUST call the
38    parent::tick(dt) function explicitly in their implementation of tick(dt) because it's a virtual function.
39*/
40
41#ifndef _Tickable_H__
42#define _Tickable_H__
43
44#include "tools/ToolsPrereqs.h"
45
46#include "core/class/OrxonoxInterface.h"
47#include "core/class/Super.h"
48
49namespace orxonox
50{
51    //! The Tickable interface provides a tick(dt) function, that gets called every frame.
52    class _ToolsExport Tickable : virtual public OrxonoxInterface
53    {
54        public:
55            /**
56                @brief Gets called every frame.
57                @param dt The time since the last frame in seconds
58            */
59            virtual void tick(float dt) { }
60
61        protected:
62            Tickable();
63    };
64
65    SUPER_FUNCTION(1, Tickable, tick, true);
66}
67
68#endif /* _Tickable_H__ */
Note: See TracBrowser for help on using the repository browser.