Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem5/src/orxonox/overlays/notifications/NotificationOverlay.h @ 3015

Last change on this file since 3015 was 2858, checked in by dafrick, 16 years ago

Done some documenting, and resolved some (possible) issues. So the Notifications are about finished…

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