Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/notifications/NotificationOverlay.h @ 7163

Last change on this file since 7163 was 7163, checked in by dafrick, 14 years ago

Merged presentation3 branch into trunk.

  • Property svn:eol-style set to native
File size: 2.5 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 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @brief Definition of the NotificationOverlay class.
32*/
33
34
35#ifndef _NotificationOverlay_H__
36#define _NotificationOverlay_H__
37
38#include "questsystem/QuestsystemPrereqs.h"
39
40#include <string>
41#include "overlays/OverlayText.h"
42
43namespace orxonox
44{
45
46    /**
47    @brief
48        The NotificationOverlay is used to display single Notifications, then bundled in a NotificationQUeue.
49    @author
50        Damian 'Mozork' Frick
51    */
52    class _QuestsystemExport NotificationOverlay : public OverlayText
53    {
54
55        public:
56            NotificationOverlay(BaseObject* creator);
57            NotificationOverlay(NotificationQueue* queue, Notification* notification);
58            virtual ~NotificationOverlay();
59
60            bool processNotification(Notification* notification); //!< Processes the input Notification.
61
62            /**
63            @brief Sets the font size of this overlay's text.
64            @param size The font size.
65            */
66            inline void setFontSize(float size)
67                { this->setTextSize(size); }
68
69        protected:
70            std::string clipMessage(const std::string & message); //!< Clips the input message if too long.
71
72        private:
73            NotificationQueue* queue_; //!< The NotificationQeue this overlay belongs to.
74            Notification* notification_; //!< The Notification this overlay displays.
75
76            void initialize(void); //!< Initializes the object.
77            void defineOverlay(void); //!< Sets some overlay-specific values.
78
79    };
80
81}
82
83#endif /* _NotificationOverlay_H__ */
Note: See TracBrowser for help on using the repository browser.