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 | * Fabian 'x3n' Landau |
---|
24 | * Co-authors: |
---|
25 | * ... |
---|
26 | * |
---|
27 | */ |
---|
28 | |
---|
29 | /** |
---|
30 | @file |
---|
31 | @ingroup Object ObjectList |
---|
32 | @brief Declaration of the ObjectListBase class which stores all objects of each class. |
---|
33 | |
---|
34 | orxonox::ObjectListBase is a double-linked list, used by @ref orxonox::Identifier "Identifiers" |
---|
35 | to store all objects of a given class. Newly created objects are added to the list through the |
---|
36 | @c RegisterObject() macro in the constructor. |
---|
37 | */ |
---|
38 | |
---|
39 | #ifndef _ObjectListBase_H__ |
---|
40 | #define _ObjectListBase_H__ |
---|
41 | |
---|
42 | #include "core/CorePrereqs.h" |
---|
43 | #include <vector> |
---|
44 | #include "Context.h" |
---|
45 | |
---|
46 | namespace orxonox |
---|
47 | { |
---|
48 | // ############################### |
---|
49 | // ### ObjectListBaseElement ### |
---|
50 | // ############################### |
---|
51 | /// The list-element of the ObjectListBase |
---|
52 | class _CoreExport ObjectListBaseElement |
---|
53 | { |
---|
54 | public: |
---|
55 | /** |
---|
56 | @brief Constructor: Creates the list-element with an object. |
---|
57 | @param objectBase The object to store |
---|
58 | */ |
---|
59 | ObjectListBaseElement(Listable* object) : next_(0), prev_(0), objectBase_(object), list_(0) {} |
---|
60 | virtual ~ObjectListBaseElement() { this->removeFromList(); } |
---|
61 | |
---|
62 | virtual void changeContext(Context* oldContext, Context* newContext) = 0; |
---|
63 | |
---|
64 | ObjectListBaseElement* next_; //!< The next element in the list |
---|
65 | ObjectListBaseElement* prev_; //!< The previous element in the list |
---|
66 | Listable* objectBase_; //!< The object |
---|
67 | ObjectListBase* list_; //!< The list |
---|
68 | |
---|
69 | protected: |
---|
70 | void removeFromList(); |
---|
71 | }; |
---|
72 | |
---|
73 | |
---|
74 | // ############################### |
---|
75 | // ### ObjectListElement ### |
---|
76 | // ############################### |
---|
77 | /// The list-element that actually contains the object |
---|
78 | template <class T> |
---|
79 | class ObjectListElement : public ObjectListBaseElement |
---|
80 | { |
---|
81 | public: |
---|
82 | ObjectListElement(T* object) : ObjectListBaseElement(static_cast<Listable*>(object)), object_(object) {} |
---|
83 | |
---|
84 | virtual void changeContext(Context* oldContext, Context* newContext) |
---|
85 | { |
---|
86 | // add object to new context, but only if this element belongs exactly to the old context (and not to a sub-context to avoid re-adding objects |
---|
87 | // multiple times if they are in multiple contexts) |
---|
88 | if (oldContext->getObjectList<T>() == this->list_) |
---|
89 | newContext->addObject(this->object_); |
---|
90 | |
---|
91 | // remove from old list |
---|
92 | this->removeFromList(); |
---|
93 | } |
---|
94 | |
---|
95 | T* object_; //!< The object |
---|
96 | }; |
---|
97 | |
---|
98 | |
---|
99 | // ######################################## |
---|
100 | // ### ObjectListElementRemovalListener ### |
---|
101 | // ######################################## |
---|
102 | /// Gets called by the object list if an element is removed |
---|
103 | class _CoreExport ObjectListElementRemovalListener |
---|
104 | { |
---|
105 | public: |
---|
106 | virtual ~ObjectListElementRemovalListener() {} |
---|
107 | virtual void removedElement(ObjectListBaseElement* element) = 0; |
---|
108 | }; |
---|
109 | |
---|
110 | // ############################### |
---|
111 | // ### ObjectListBase ### |
---|
112 | // ############################### |
---|
113 | /** |
---|
114 | @brief The ObjectListBase contains all objects of a given class. |
---|
115 | |
---|
116 | The ObjectListBase is used by Identifiers to store all objects of their class. |
---|
117 | You can use Identifier::getObjects() to get the object-list from an Identifier. |
---|
118 | Use @ref Iterator "Iterator<T>" to iterate through them. |
---|
119 | |
---|
120 | Alternatively you can also use the static helper class @ref orxonox::ObjectList "ObjectList<T>" |
---|
121 | to get the list of all objects of type @a T. Use @ref ObjectListIterator "ObjectListIterator<T>" |
---|
122 | or @ref Iterator "Iterator<T>" to iterate through them. |
---|
123 | */ |
---|
124 | class _CoreExport ObjectListBase |
---|
125 | { |
---|
126 | public: |
---|
127 | ObjectListBase(); |
---|
128 | ~ObjectListBase(); |
---|
129 | |
---|
130 | void addElement(ObjectListBaseElement* element); |
---|
131 | void removeElement(ObjectListBaseElement* element); |
---|
132 | |
---|
133 | size_t size() const { return this->size_; } |
---|
134 | |
---|
135 | /// Returns a pointer to the first element in the list. Works only with Iterator. |
---|
136 | inline ObjectListBaseElement* begin() const { return this->first_; } |
---|
137 | /// Returns a pointer to the element after the last element in the list. Works only with Iterator. |
---|
138 | inline ObjectListBaseElement* end() const { return 0; } |
---|
139 | /// Returns a pointer to the last element in the list. Works only with Iterator. |
---|
140 | inline ObjectListBaseElement* rbegin() const { return this->last_; } |
---|
141 | /// Returns a pointer to the element in front of the first element in the list. Works only with Iterator. |
---|
142 | inline ObjectListBaseElement* rend() const { return 0; } |
---|
143 | |
---|
144 | inline void registerRemovalListener(ObjectListElementRemovalListener* listener) { this->listeners_.push_back(listener); } |
---|
145 | inline void unregisterRemovalListener(ObjectListElementRemovalListener* listener) |
---|
146 | { |
---|
147 | for (unsigned int i = 0; i < this->listeners_.size(); ++i) |
---|
148 | { |
---|
149 | if (listeners_[i] == listener) |
---|
150 | { |
---|
151 | listeners_.erase(listeners_.begin() + i); |
---|
152 | break; |
---|
153 | } |
---|
154 | } |
---|
155 | } |
---|
156 | |
---|
157 | private: |
---|
158 | void notifyRemovalListeners(ObjectListBaseElement* element) const; |
---|
159 | |
---|
160 | ObjectListBaseElement* first_; //!< The first element in the list |
---|
161 | ObjectListBaseElement* last_; //!< The last element in the list |
---|
162 | size_t size_; //!< The number of elements in the list |
---|
163 | std::vector<ObjectListElementRemovalListener*> listeners_; //!< A list of Iterators pointing on an element in this list |
---|
164 | }; |
---|
165 | } |
---|
166 | |
---|
167 | #endif /* _ObjectListBase_H__ */ |
---|