Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/notifications/NotificationQueue.h @ 8370

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

Resolving some TODOs and doing some additional cleanup. Almost done now…

  • Property svn:eol-style set to native
File size: 7.7 KB
RevLine 
[2280]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
[2911]29/**
[7403]30    @file NotificationQueue.h
[2911]31    @brief Definition of the NotificationQueue class.
[7456]32    @ingroup Notifications
[2911]33*/
34
[2280]35#ifndef _NotificationOueue_H__
36#define _NotificationOueue_H__
37
[7164]38#include "notifications/NotificationsPrereqs.h"
[2911]39
[3196]40#include <ctime>
41#include <set>
[2911]42#include <string>
[7403]43#include <vector>
[2280]44
[7489]45#include "NotificationManager.h"
46
[5633]47#include "tools/interfaces/Tickable.h"
[5619]48#include "interfaces/NotificationListener.h"
[2280]49
[7403]50namespace orxonox // tolua_export
51{ // tolua_export
[2911]52
[7552]53    /**
54    @brief
55        Container to allow easy handling of the @ref orxonox::Notification "Notifications".
56
57    @ingroup Notifications
58    */
[7403]59    struct NotificationContainer
[2911]60    {
[7489]61        Notification* notification; //!< The Notification displayed.
62        time_t time; //!< The time the Notification was sent and thus first displayed.
[2911]63    };
[5619]64
[7552]65    /**
66    @brief
67        Struct to allow ordering of @ref orxonox::NotificationContainer "NotificationContainers".
68
69    @ingroup Notifications
70    */
[7403]71    struct NotificationContainerCompare {
72        bool operator() (const NotificationContainer* const & a, const NotificationContainer* const & b) const
[7489]73            { return a->time < b->time; } //!< Ordering by time.
[2911]74    };
75
[2280]76    /**
77    @brief
[7484]78        Displays @ref orxonox::Notification "Notifications" from specific senders.
79
80        There are quite some parameters that influence the behaviour of the NotificationQueue:
[7488]81        - @b name The name of the NotificationQueue. It needs to be unique.
82        - @b senders The senders that are targets of this NotificationQueue, i.e. the names of senders whose Notifications this NotificationQueue displays.
83        - @b size The size of the NotificationQueue, it specifies how many @ref orxonox::Notification "Notifications" are displayed at once at the most.
84        - @b displayTime The time a @ref orxonox::Notification "Notification" is displayed with this NotificationQueue.
[7486]85
[2280]86    @author
87        Damian 'Mozork' Frick
[7552]88
89    @ingroup Notifications
[2280]90    */
[7403]91    class _NotificationsExport NotificationQueue // tolua_export
92        : public Tickable, public NotificationListener
93    { // tolua_export
[2911]94
95        public:
[7403]96            NotificationQueue(const std::string& name, const std::string& senders = NotificationManager::ALL, unsigned int size = NotificationQueue::DEFAULT_SIZE, unsigned int displayTime = NotificationQueue::DEFAULT_DISPLAY_TIME);
[2911]97            virtual ~NotificationQueue();
[5619]98
[7488]99            //! Destroys the NotificationQueue.
100            void destroy(bool noGraphics = false); // tolua_export
[5619]101
[2911]102            virtual void tick(float dt); //!< To update from time to time.
[5619]103
[7403]104            void update(void); //!< Updates the NotificationQueue.
105            void update(Notification* notification, const std::time_t & time); //!< Updates the NotificationQueue by adding an new Notification.
[5619]106
[7403]107            // tolua_begin
[2911]108            /**
[7403]109            @brief Get the name of the NotificationQueue.
110            @return Returns the name.
111            */
112            inline const std::string& getName() const
113                { return this->name_; }
114
115            void setMaxSize(unsigned int size); //!< Sets the maximum number of displayed Notifications.
116            /**
[2911]117            @brief Returns the maximum number of Notifications displayed.
118            @return Returns maximum size.
119            */
[7403]120            inline unsigned int getMaxSize() const
[2911]121                { return this->maxSize_; }
[7403]122
123            void setDisplayTime(unsigned int time); //!< Sets the maximum number of seconds a Notification is displayed.
[2911]124            /**
125            @brief Returns the time interval the Notification is displayed.
126            @return Returns the display time.
127            */
[7410]128            inline unsigned int getDisplayTime() const
[2911]129                { return this->displayTime_; }
[7403]130            // tolua_end
131
[2911]132            /**
[7403]133            @brief Returns the current number of Notifications displayed.
134            @return Returns the size of the NotificationQueue.
[2911]135            */
[7403]136            inline unsigned int getSize() const
137                { return this->size_; }
[5619]138
[2911]139            /**
[7403]140            @brief Returns the targets of this NotificationQueue, reps. the senders which Notifications are displayed in this NotificationQueue.
141            @return Returns a set of strings holding the different targets.
[2911]142            */
[7417]143            inline const std::set<std::string> & getTargetsSet()
[2911]144                { return this->targets_; }
[5619]145
[7403]146            // tolua_begin
147            void setTargets(const std::string & targets); //!< Set the targets of this NotificationQueue.
148            const std::string& getTargets(void) const; //!< Returns a string consisting of the concatination of the targets.
149            // tolua_end
[2501]150
[2911]151        private:
[7403]152            static const unsigned int DEFAULT_SIZE = 5; //!< The default maximum number of Notifications displayed.
153            static const unsigned int DEFAULT_DISPLAY_TIME = 30; //!< The default display time.
[2501]154
[7403]155            std::string name_; //!< The name of the NotificationQueue.
[5619]156
[7403]157            unsigned int maxSize_; //!< The maximal number of Notifications displayed.
158            unsigned int size_; //!< The number of Notifications displayed.
159            unsigned int displayTime_; //!< The time a Notification is displayed.
[5619]160
[7163]161            bool registered_; //!< Helper variable to remember whether the NotificationQueue is registered already.
162
[7417]163            std::set<std::string> targets_; //!< The targets the NotificationQueue displays Notifications of.
[5619]164
[7403]165            std::multiset<NotificationContainer*, NotificationContainerCompare> ordering_; //!< The NotificationContainers ordered by the time they were registered.
166            std::vector<NotificationContainer*> notifications_; //!< The NotificationContainers in the order they were added to the NotificationQueue.
[5619]167
[7403]168            float tickTime_; //!< Helper variable, to not have to check for Notifications that have been displayed too long, every tick.
169            NotificationContainer timeLimit_; //!< Helper object to check against to determine whether Notifications have expired.
[5619]170
[7403]171            void create(void); //!< Creates the NotificationQueue in lua.
[2501]172
[7403]173            void setName(const std::string& name); //!< Sets the name of the NotificationQueue.
[5619]174
[7403]175            void push(Notification* notification, const std::time_t & time); //!< Adds (pushes) a Notification to the NotificationQueue.
176            void pop(void); //!< Removes (pops) the least recently added Notification form the NotificationQueue.
[7412]177            void remove(const std::multiset<NotificationContainer*, NotificationContainerCompare>::iterator& containerIterator); //!< Removes the Notification that is stored in the input NotificationContainer.
[5619]178
[7488]179            void clear(bool noGraphics = false); //!< Clears the NotificationQueue by removing all NotificationContainers.
[5619]180
[7403]181    }; // tolua_export
[2280]182
[7403]183} // tolua_export
[2280]184
185#endif /* _NotificationOverlay_H__ */
Note: See TracBrowser for help on using the repository browser.