Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/overlays/stats/Stats.h @ 7297

Last change on this file since 7297 was 7297, checked in by landauf, 14 years ago

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

  • Property svn:eol-style set to native
File size: 1.6 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 *      Felix Schulthess
24 *   Co-authors:
25 *      Fabian 'x3n' Landau, Benjamin Hildebrandt
26 *
27 */
28
29#ifndef _Stats_H__
30#define _Stats_H__
31
32#include "overlays/OverlaysPrereqs.h"
33
34#include "util/OgreForwardRefs.h"
35#include "tools/interfaces/Tickable.h"
36#include "overlays/OrxonoxOverlay.h"
37
38namespace orxonox
39{
40    class _OverlaysExport Stats : public OrxonoxOverlay, public Tickable
41    {
42    public: // functions
43        Stats(BaseObject* creator);
44        virtual ~Stats();
45
46        void setConfigValues();
47
48        virtual void tick(float dt);
49
50    private: // variables
51        Ogre::PanelOverlayElement* statsOverlayNoise_;
52        Ogre::BorderPanelOverlayElement* statsOverlayBorder_;
53        float noiseSize_;
54    };
55}
56
57#endif /* _Stats_H__ */
Note: See TracBrowser for help on using the repository browser.