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 | @defgroup ObjectList Object-lists and iterators |
---|
31 | @ingroup Object |
---|
32 | */ |
---|
33 | |
---|
34 | /** |
---|
35 | @file |
---|
36 | @ingroup Object ObjectList |
---|
37 | @brief Definition of the ObjectList class, a wrapper of ObjectListBase. |
---|
38 | |
---|
39 | @ref orxonox::ObjectList "ObjectList<T>" is a wrapper of an @ref orxonox::ObjectListBase |
---|
40 | "ObjectListBase" of class @a T. Use @ref orxonox::ObjectListIterator "ObjectListIterator<T>" |
---|
41 | to iterate through the list. |
---|
42 | */ |
---|
43 | |
---|
44 | #ifndef _ObjectList_H__ |
---|
45 | #define _ObjectList_H__ |
---|
46 | |
---|
47 | #include "core/CorePrereqs.h" |
---|
48 | |
---|
49 | #include "ObjectListBase.h" |
---|
50 | #include "ObjectListIterator.h" |
---|
51 | #include "Context.h" |
---|
52 | |
---|
53 | namespace orxonox |
---|
54 | { |
---|
55 | // ############################### |
---|
56 | // ### ObjectList ### |
---|
57 | // ############################### |
---|
58 | /** |
---|
59 | @brief The ObjectList contains all objects of the given class. |
---|
60 | |
---|
61 | Wraps the ObjectListBase which contains all objects of type @a T. Use @ref ObjectListIterator |
---|
62 | "ObjectListIterator<T>" or its typedef ObjectList<T>::iterator to iterate through all objects |
---|
63 | in the list. |
---|
64 | */ |
---|
65 | template <class T> |
---|
66 | class ObjectList |
---|
67 | { |
---|
68 | public: |
---|
69 | typedef ObjectListIterator<T> iterator; |
---|
70 | |
---|
71 | /// Returns the size of the list |
---|
72 | inline static size_t size() |
---|
73 | { |
---|
74 | return Context::getRootContext()->getObjectList<T>()->size(); |
---|
75 | } |
---|
76 | |
---|
77 | /// Returns an Iterator to the first element in the list. |
---|
78 | inline static ObjectListElement<T>* begin() |
---|
79 | { |
---|
80 | ObjectListBase* list = Context::getRootContext()->getObjectList<T>(); |
---|
81 | return static_cast<ObjectListElement<T>*>(list->begin()); |
---|
82 | } |
---|
83 | |
---|
84 | /// Returns an Iterator to the element after the last element in the list. |
---|
85 | inline static ObjectListElement<T>* end() |
---|
86 | { |
---|
87 | ObjectListBase* list = Context::getRootContext()->getObjectList<T>(); |
---|
88 | return static_cast<ObjectListElement<T>*>(list->end()); |
---|
89 | } |
---|
90 | |
---|
91 | /// Returns an Iterator to the last element in the list. |
---|
92 | inline static ObjectListElement<T>* rbegin() |
---|
93 | { |
---|
94 | ObjectListBase* list = Context::getRootContext()->getObjectList<T>(); |
---|
95 | return static_cast<ObjectListElement<T>*>(list->rbegin()); |
---|
96 | } |
---|
97 | |
---|
98 | /// Returns an Iterator to the element before the first element in the list. |
---|
99 | inline static ObjectListElement<T>* rend() |
---|
100 | { |
---|
101 | ObjectListBase* list = Context::getRootContext()->getObjectList<T>(); |
---|
102 | return static_cast<ObjectListElement<T>*>(list->rend()); |
---|
103 | } |
---|
104 | }; |
---|
105 | } |
---|
106 | |
---|
107 | #endif /* _ObjectList_H__ */ |
---|