Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/overlays/stats/Scoreboard.h @ 7308

Last change on this file since 7308 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: 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 *      Benjamin Hildebrandt
24 *
25 */
26
27#ifndef _Scoreboard_H__
28#define _Scoreboard_H__
29
30
31#include "overlays/OverlaysPrereqs.h"
32
33#include <string>
34#include <vector>
35#include "tools/interfaces/Tickable.h"
36#include "overlays/OrxonoxOverlay.h"
37
38namespace orxonox
39{
40    class _OverlaysExport Scoreboard : public OrxonoxOverlay, public Tickable
41    {
42    public: // functions
43        Scoreboard(BaseObject* creator);
44        virtual ~Scoreboard();
45
46        virtual void tick(float dt);
47
48        inline void setCreateLines(CreateLines* cl)
49            { this->createlines_ = cl; }
50        inline CreateLines* getCreateLines() const
51            { return this->createlines_; }
52
53        virtual void changedVisibility();
54
55    private: // functions
56        void printLines();
57
58    private: // variables
59        std::vector<CreateLines*> lines_;
60
61        unsigned int numberOfColumns;
62        unsigned int numberOfLines;
63        unsigned int columnIndex;
64        float topOffset;
65        float leftOffset;
66        float lineSpacing;
67        std::string columnText;
68        CreateLines* createlines_;
69    };
70}
71
72#endif /* _Scoreboard_H__ */
Note: See TracBrowser for help on using the repository browser.