Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/release2012/src/libraries/core/OrxonoxClass.h @ 11753

Last change on this file since 11753 was 8866, checked in by dafrick, 13 years ago

Moved clone base method into Pickupable to avoid ambiguity.

  • Property svn:eol-style set to native
File size: 8.7 KB
Line 
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 OrxonoxClass OrxonoxClass
31    @ingroup Class
32*/
33
34/**
35    @file
36    @ingroup Class OrxonoxClass
37    @brief Declaration of OrxonoxClass, the base class of all objects and interfaces in Orxonox.
38
39    All objects and interfaces of the game-logic (not the engine) are derived from OrxonoxClass.
40    It stores the Identifier and the MetaObjectList and has all needed functions to create and use the class-hierarchy.
41*/
42
43#ifndef _OrxonoxClass_H__
44#define _OrxonoxClass_H__
45
46#include "CorePrereqs.h"
47
48#include <set>
49#include <vector>
50#include "Super.h"
51
52namespace orxonox
53{
54    /**
55        @brief The class all objects and interfaces of the game-logic (not the engine) are derived from.
56
57        The BaseObject and Interfaces are derived with @c virtual @c public @c OrxonoxClass from OrxonoxClass.
58        OrxonoxClass is needed to create the class-hierarchy at startup and to store the Identifier and the
59        MetaObjectList, as well as to provide an interface for SmartPtr and WeakPtr.
60    */
61    class _CoreExport OrxonoxClass
62    {
63        template <class T>
64        friend class ClassIdentifier;
65
66        template <class T>
67        friend class SmartPtr;
68
69        friend class DestructionListener;
70
71        public:
72            OrxonoxClass();
73            virtual ~OrxonoxClass();
74
75            void destroy();
76            void unregisterObject();
77
78            /// Function to collect the SetConfigValue-macro calls.
79            void setConfigValues() {};
80
81            /// Returns the Identifier of the object.
82            inline Identifier* getIdentifier() const { return this->identifier_; }
83
84            bool isA(const Identifier* identifier);
85            bool isExactlyA(const Identifier* identifier);
86            bool isChildOf(const Identifier* identifier);
87            bool isDirectChildOf(const Identifier* identifier);
88            bool isParentOf(const Identifier* identifier);
89            bool isDirectParentOf(const Identifier* identifier);
90
91            /// Returns true if the object's class is of the given type or a derivative.
92            template <class B> inline bool isA(const SubclassIdentifier<B>* identifier)
93                { return this->isA(*identifier); }
94            /// Returns true if the object's class is exactly of the given type.
95            template <class B> inline bool isExactlyA(const SubclassIdentifier<B>* identifier)
96                { return this->isExactlyA(*identifier); }
97            /// Returns true if the object's class is a child of the given type.
98            template <class B> inline bool isChildOf(const SubclassIdentifier<B>* identifier)
99                { return this->isChildOf(*identifier); }
100            /// Returns true if the object's class is a direct child of the given type.
101            template <class B> inline bool isDirectChildOf(const SubclassIdentifier<B>* identifier)
102                { return this->isDirectChildOf(*identifier); }
103            /// Returns true if the object's class is a parent of the given type.
104            template <class B> inline bool isParentOf(const SubclassIdentifier<B>* identifier)
105                { return this->isParentOf(*identifier); }
106            /// Returns true if the object's class is a direct parent of the given type.
107            template <class B> inline bool isDirectParentOf(const SubclassIdentifier<B>* identifier)
108                { return this->isDirectParentOf(*identifier); }
109
110            bool isA(const OrxonoxClass* object);
111            bool isExactlyA(const OrxonoxClass* object);
112            bool isChildOf(const OrxonoxClass* object);
113            bool isDirectChildOf(const OrxonoxClass* object);
114            bool isParentOf(const OrxonoxClass* object);
115            bool isDirectParentOf(const OrxonoxClass* object);
116
117            /// Returns the number of @ref orxonox::SmartPtr "smart pointers" that point to this object.
118            inline unsigned int getReferenceCount() const
119                { return this->referenceCount_; }
120
121            /**
122            @brief
123                Returns a valid pointer of any derived type that is
124                registered in the class hierarchy.
125            @return
126                Returns NULL if the no pointer was found.
127            */
128            ORX_FORCEINLINE void* getDerivedPointer(unsigned int classID)
129            {
130                for (int i = this->objectPointers_.size() - 1; i >= 0; --i)
131                {
132                    if (this->objectPointers_[i].first == classID)
133                        return this->objectPointers_[i].second;
134                }
135                return NULL;
136            }
137
138            /// Version of getDerivedPointer with template
139            template <class T> ORX_FORCEINLINE T* getDerivedPointer(unsigned int classID)
140            {   return static_cast<T*>(this->getDerivedPointer(classID));   }
141            /// Const version of getDerivedPointer with template
142            template <class T> ORX_FORCEINLINE const T* getDerivedPointer(unsigned int classID) const
143            {   return const_cast<OrxonoxClass*>(this)->getDerivedPointer<T>(classID);   }
144
145        protected:
146            /// This virtual function is called if destroy() is called and no SmartPtr points to this object. Used in some cases to create a new SmartPtr to prevent destruction.
147            virtual void preDestroy() {}
148
149        private:
150            /// Increments the reference counter (for smart pointers).
151            inline void incrementReferenceCount()
152                { ++this->referenceCount_; }
153            /// Decrements the reference counter (for smart pointers).
154            inline void decrementReferenceCount()
155            {
156                --this->referenceCount_;
157                if (this->referenceCount_ == 0 && this->requestedDestruction_)
158                    this->destroy();
159            }
160
161            /// Register a destruction listener (for example a weak pointer which points to this object).
162            inline void registerDestructionListener(DestructionListener* pointer)
163                { this->destructionListeners_.insert(pointer); }
164            /// Unegister a destruction listener (for example a weak pointer which pointed to this object before).
165            inline void unregisterDestructionListener(DestructionListener* pointer)
166                { this->destructionListeners_.erase(pointer); }
167
168            Identifier* identifier_;                                //!< The Identifier of the object
169            std::set<const Identifier*>* parents_;                  //!< List of all parents of the object
170            MetaObjectList* metaList_;                              //!< MetaObjectList, containing all ObjectLists and ObjectListElements the object is registered in
171            int referenceCount_;                                    //!< Counts the references from smart pointers to this object
172            bool requestedDestruction_;                             //!< Becomes true after someone called delete on this object
173            std::set<DestructionListener*> destructionListeners_;   //!< All destruction listeners (for example weak pointers which point to this object and like to get notified if it dies)
174
175            /// 'Fast map' that holds this-pointers of all derived types
176            std::vector<std::pair<unsigned int, void*> > objectPointers_;
177    };
178
179    /**
180        @brief This listener is used to inform weak pointers if an object of type OrxonoxClass gets destroyed.
181    */
182    class _CoreExport DestructionListener
183    {
184        friend class OrxonoxClass;
185
186        protected:
187            virtual ~DestructionListener() {}
188
189            inline void registerAsDestructionListener(OrxonoxClass* object)
190                { if (object) { object->registerDestructionListener(this); } }
191            inline void unregisterAsDestructionListener(OrxonoxClass* object)
192                { if (object) { object->unregisterDestructionListener(this); } }
193
194            virtual void objectDeleted() = 0;
195    };
196
197}
198
199#endif /* _OrxonoxClass_H__ */
Note: See TracBrowser for help on using the repository browser.