[1505] | 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 | /** |
---|
[2171] | 30 | @file |
---|
[1505] | 31 | @brief Definition and implementation of the ObjectList class. |
---|
| 32 | |
---|
[1747] | 33 | The ObjectList is a wrapper of an ObjectListBase of a given class. |
---|
[1505] | 34 | Use Iterator<class> to iterate through all objects of the class. |
---|
| 35 | */ |
---|
| 36 | |
---|
| 37 | #ifndef _ObjectList_H__ |
---|
| 38 | #define _ObjectList_H__ |
---|
| 39 | |
---|
| 40 | #include "CorePrereqs.h" |
---|
| 41 | |
---|
[1543] | 42 | #include "Identifier.h" |
---|
[1747] | 43 | #include "ObjectListIterator.h" |
---|
[1505] | 44 | |
---|
| 45 | namespace orxonox |
---|
| 46 | { |
---|
| 47 | // ############################### |
---|
| 48 | // ### ObjectList ### |
---|
| 49 | // ############################### |
---|
[1747] | 50 | //! The ObjectList contains all objects of the given class. |
---|
[1505] | 51 | /** |
---|
[1747] | 52 | Wraps the ObjectListBase of the corresponding Identifier. |
---|
| 53 | Use ObjectListIterator<class> to iterate through all objects in the list. |
---|
[1505] | 54 | */ |
---|
| 55 | template <class T> |
---|
| 56 | class ObjectList |
---|
| 57 | { |
---|
| 58 | public: |
---|
[1747] | 59 | typedef ObjectListIterator<T> iterator; |
---|
[1505] | 60 | |
---|
[1747] | 61 | /** @brief Returns an Iterator to the first element in the list. @return The Iterator */ |
---|
| 62 | inline static ObjectListElement<T>* begin() |
---|
| 63 | { return ((ObjectListElement<T>*)ClassIdentifier<T>::getIdentifier()->getObjects()->begin().element_); } |
---|
[1505] | 64 | |
---|
[1747] | 65 | /** @brief Returns an Iterator to the element after the last element in the list. @return The Iterator */ |
---|
| 66 | inline static ObjectListElement<T>* end() |
---|
| 67 | { return ((ObjectListElement<T>*)ClassIdentifier<T>::getIdentifier()->getObjects()->end().element_); } |
---|
[1505] | 68 | |
---|
[1747] | 69 | /** @brief Returns an Iterator to the last element in the list. @return The Iterator */ |
---|
| 70 | inline static ObjectListElement<T>* rbegin() |
---|
| 71 | { return ((ObjectListElement<T>*)ClassIdentifier<T>::getIdentifier()->getObjects()->rbegin().element_); } |
---|
[1505] | 72 | |
---|
[1747] | 73 | /** @brief Returns an Iterator to the element before the first element in the list. @return The Iterator */ |
---|
| 74 | inline static ObjectListElement<T>* rend() |
---|
| 75 | { return ((ObjectListElement<T>*)ClassIdentifier<T>::getIdentifier()->getObjects()->rend().element_); } |
---|
[1505] | 76 | }; |
---|
| 77 | } |
---|
| 78 | |
---|
| 79 | #endif /* _ObjectList_H__ */ |
---|