[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 | /** |
---|
[3196] | 30 | @file |
---|
[2911] | 31 | @brief Definition of the NotificationQueue class. |
---|
| 32 | */ |
---|
| 33 | |
---|
[2280] | 34 | #ifndef _NotificationOueue_H__ |
---|
| 35 | #define _NotificationOueue_H__ |
---|
| 36 | |
---|
[7164] | 37 | #include "notifications/NotificationsPrereqs.h" |
---|
[2911] | 38 | |
---|
[3196] | 39 | #include <ctime> |
---|
| 40 | #include <map> |
---|
| 41 | #include <set> |
---|
[2911] | 42 | #include <string> |
---|
[2280] | 43 | |
---|
[3196] | 44 | #include "util/Math.h" |
---|
[5633] | 45 | #include "tools/interfaces/Tickable.h" |
---|
[3196] | 46 | #include "overlays/OverlayGroup.h" |
---|
[5619] | 47 | #include "interfaces/NotificationListener.h" |
---|
[2280] | 48 | |
---|
[2435] | 49 | namespace orxonox |
---|
| 50 | { |
---|
[2911] | 51 | |
---|
| 52 | //! Container to allow easy handling. |
---|
| 53 | struct NotificationOverlayContainer |
---|
| 54 | { |
---|
| 55 | NotificationOverlay* overlay; //!< Pointer to the NotificationOverlay, everything is about. |
---|
| 56 | Notification* notification; //!< The Notification displayed by the overlay. |
---|
| 57 | time_t time; //!< The time the Notification was sent and thus first displayed. |
---|
| 58 | std::string name; //!< The name of the overlay. |
---|
| 59 | }; |
---|
[5619] | 60 | |
---|
[2911] | 61 | //! Struct to allow ordering of NotificationOverlayContainers. |
---|
| 62 | struct NotificationOverlayContainerCompare { |
---|
| 63 | bool operator() (const NotificationOverlayContainer* const & a, const NotificationOverlayContainer* const & b) const |
---|
| 64 | { return a->time < b->time; } //!< Ordered by time. |
---|
| 65 | }; |
---|
| 66 | |
---|
[2280] | 67 | /** |
---|
| 68 | @brief |
---|
[2911] | 69 | Displays Notifications from specific senders. |
---|
| 70 | Beware! The NotificationQueue is an OverlayGruop and thus cannot be be a sub-element of an OverlayGroup (at least no for now.) |
---|
[2501] | 71 | |
---|
[2911] | 72 | Creating a NotificationQueue through XML goes as follows: |
---|
[7163] | 73 | Be aware that the NotificationQueue must be inside the <Level></Level> tags or bad things will happen. |
---|
[2911] | 74 | <NotificationQueue |
---|
| 75 | name = "SuperQueue" //Name of your OverlayQueue. |
---|
[7164] | 76 | maxSize = "5" //The maximum number of Notifications displayed. (Default is 5) |
---|
| 77 | notificationLength = "64" //The maximum number of characters of a Notification, that are displayed. (Default is 64) |
---|
[2911] | 78 | displayTime = "30" //The time a Notification is displayed in seconds. (Default is 30) |
---|
| 79 | targets = "target1, target2" //The senders this NotificationQueue displays Notifications from. (all, if all Notifications should be displayed.) |
---|
| 80 | font = "VeraMono" //The font (Default is VeraMono) |
---|
| 81 | fontSize = '0.4' //The font size. (Default is 0.025) |
---|
[7164] | 82 | position = "0.0, 0.0" //The position of the NotificationQueue. (Default is 0.0,0.0) |
---|
[2911] | 83 | /> |
---|
[2280] | 84 | @author |
---|
| 85 | Damian 'Mozork' Frick |
---|
| 86 | */ |
---|
[2911] | 87 | |
---|
[7164] | 88 | class _NotificationsExport NotificationQueue : public OverlayGroup, public Tickable, public NotificationListener |
---|
[2280] | 89 | { |
---|
[5619] | 90 | |
---|
[2911] | 91 | public: |
---|
| 92 | NotificationQueue(BaseObject* creator); |
---|
| 93 | virtual ~NotificationQueue(); |
---|
[5619] | 94 | |
---|
[2911] | 95 | virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML. |
---|
[5619] | 96 | |
---|
[2911] | 97 | virtual void tick(float dt); //!< To update from time to time. |
---|
[5619] | 98 | |
---|
[2911] | 99 | void update(void); //!< Updates the queue. |
---|
| 100 | void update(Notification* notification, const std::time_t & time); //!< Adds a Notification to the queue. |
---|
[5619] | 101 | |
---|
[2911] | 102 | /** |
---|
| 103 | @brief Returns the maximum number of Notifications displayed. |
---|
| 104 | @return Returns maximum size. |
---|
| 105 | */ |
---|
| 106 | inline int getMaxSize() const |
---|
| 107 | { return this->maxSize_; } |
---|
| 108 | /** |
---|
| 109 | @brief Returns the current number of Notifications displayed. |
---|
| 110 | @return Returns the size of the queue. |
---|
| 111 | */ |
---|
| 112 | inline int getSize() const |
---|
| 113 | { return this->size_; } |
---|
| 114 | /** |
---|
| 115 | @brief Returns the maximum length in characters a Notification message is allowed to have. |
---|
| 116 | @return Returns the maximum Notification length. |
---|
| 117 | */ |
---|
| 118 | inline int getNotificationLength() const |
---|
| 119 | { return this->notificationLength_; } |
---|
| 120 | /** |
---|
| 121 | @brief Returns the time interval the Notification is displayed. |
---|
| 122 | @return Returns the display time. |
---|
| 123 | */ |
---|
| 124 | inline int getDisplayTime() const |
---|
| 125 | { return this->displayTime_; } |
---|
| 126 | /** |
---|
| 127 | @brief Returns the position of the NotificationQueue. |
---|
| 128 | @return Returns the position. |
---|
| 129 | */ |
---|
| 130 | inline const Vector2 & getPosition() const |
---|
| 131 | { return this->position_; } |
---|
| 132 | /** |
---|
| 133 | @brief Returns the font size used to display the Notifications. |
---|
| 134 | @return Returns the font size. |
---|
| 135 | */ |
---|
| 136 | inline float getFontSize() const |
---|
| 137 | { return this->fontSize_; } |
---|
| 138 | /** |
---|
| 139 | @brief Returns the font used to display the Notifications. |
---|
| 140 | @return Returns the font. |
---|
| 141 | */ |
---|
| 142 | inline const std::string & getFont() const |
---|
| 143 | { return this->font_; } |
---|
[5619] | 144 | |
---|
[2911] | 145 | /** |
---|
| 146 | @brief Returns the targets of this queue, reps. the senders which Notifications are displayed in this queue. |
---|
| 147 | @return Retuns a set of string holding the different targets. |
---|
| 148 | */ |
---|
| 149 | inline const std::set<std::string> & getTargetsSet() |
---|
| 150 | { return this->targets_; } |
---|
| 151 | bool getTargets(std::string* string) const; //!< Returns a string consisting of the concatination of the targets. |
---|
[5619] | 152 | |
---|
[2911] | 153 | /** |
---|
| 154 | @brief Sets the position of the NotificationQueue. |
---|
| 155 | @param pos The position. |
---|
| 156 | */ |
---|
[5619] | 157 | inline void setPosition(Vector2 pos) |
---|
[2911] | 158 | { this->position_ = pos; this->positionChanged(); } |
---|
[2501] | 159 | |
---|
[2911] | 160 | void scroll(const Vector2 pos); //!< Scrolls the NotificationQueue, meaning all NotificationOverlays are moved the input vector. |
---|
[5619] | 161 | |
---|
[2911] | 162 | private: |
---|
| 163 | static const int DEFAULT_SIZE = 5; //!< The default maximum number of Notifications displayed. |
---|
[7164] | 164 | static const int DEFAULT_LENGTH = 64; //!< The default maximum number of characters displayed. |
---|
[2911] | 165 | static const int DEFAULT_DISPLAY_TIME = 30; //!< The default display time. |
---|
[2926] | 166 | static const float DEFAULT_FONT_SIZE; //!< The default font size. |
---|
[2501] | 167 | |
---|
[2911] | 168 | static const std::string DEFAULT_FONT; //!< The default font. |
---|
| 169 | static const Vector2 DEFAULT_POSITION; //!< the default position. |
---|
[5619] | 170 | |
---|
[2911] | 171 | int maxSize_; //!< The maximal number of Notifications displayed. |
---|
| 172 | int size_; //!< The number of Notifications displayed. |
---|
| 173 | int notificationLength_; //!< The maximal number of characters a Notification-message is allowed to have. |
---|
| 174 | int displayTime_; //!< The time a Notification is displayed. |
---|
| 175 | Vector2 position_; //!< The position of the NotificationQueue. |
---|
[5619] | 176 | |
---|
[2911] | 177 | std::set<std::string> targets_; //!< The targets the Queue displays Notifications of. |
---|
[5619] | 178 | |
---|
[2911] | 179 | float fontSize_; //!< The font size. |
---|
| 180 | std::string font_; //!< The font. |
---|
[5619] | 181 | |
---|
[2911] | 182 | std::multiset<NotificationOverlayContainer*, NotificationOverlayContainerCompare> containers_; //!< Multiset, because the ordering is based on, not necessarily unique, timestamps. |
---|
| 183 | std::map<Notification*, NotificationOverlayContainer*> overlays_; //!< Mapping notifications to their corresponding overlay containers, for easier association and finding. |
---|
[5619] | 184 | |
---|
[2911] | 185 | float tickTime_; //!< Helper variable, to not have to check for overlays that have been displayed too long, every tick. |
---|
| 186 | NotificationOverlayContainer timeLimit_; //!< Helper object to check against to determine whether Notifications have expired. |
---|
[5619] | 187 | |
---|
[7163] | 188 | bool registered_; //!< Helper variable to remember whether the NotificationQueue is registered already. |
---|
| 189 | |
---|
[2911] | 190 | void initialize(void); //!< Initializes the object. |
---|
| 191 | void setDefaults(void); //!< Helper method to set the default values. |
---|
[5619] | 192 | |
---|
[2911] | 193 | bool setMaxSize(int size); //!< Sets the maximum number of displayed Notifications. |
---|
| 194 | bool setNotificationLength(int length); //!< Sets the maximum number of characters a Notification message displayed by this queue is allowed to have. |
---|
| 195 | bool setDisplayTime(int time); //!< Sets the maximum number of seconds a Notification is displayed. |
---|
[5619] | 196 | |
---|
[2911] | 197 | bool setTargets(const std::string & targets); //!< Set the targets of this queue. |
---|
[5619] | 198 | |
---|
[2911] | 199 | bool setFontSize(float size); //!< Set the font size. |
---|
| 200 | bool setFont(const std::string & font); //!< Set the font. |
---|
[2501] | 201 | |
---|
[2911] | 202 | void positionChanged(void); //!< Aligns all the Notifications to the position of the NotificationQueue. |
---|
[5619] | 203 | |
---|
[2911] | 204 | void addNotification(Notification* notification, const std::time_t & time); //!< Add a notification to the queue. |
---|
| 205 | bool removeContainer(NotificationOverlayContainer* container); //!< Remove a container from the queue. |
---|
[5619] | 206 | |
---|
[2911] | 207 | void clear(void); //!< Clear the queue. |
---|
[5619] | 208 | |
---|
[2280] | 209 | }; |
---|
| 210 | |
---|
| 211 | } |
---|
| 212 | |
---|
| 213 | #endif /* _NotificationOverlay_H__ */ |
---|