Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/OrxonoxClass.h @ 6122

Last change on this file since 6122 was 6105, checked in by rgrieder, 15 years ago

Merged console branch back to trunk.

  • Property svn:eol-style set to native
File size: 7.1 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    @file
31    @brief Declaration of the OrxonoxClass Class.
32
33    All objects and interfaces of the game-logic (not the engine) are derived from OrxonoxClass.
34    It stores the Identifier and the MetaObjectList and has all needed functions to create and use the class-hierarchy.
35*/
36
37#ifndef _OrxonoxClass_H__
38#define _OrxonoxClass_H__
39
40#include "CorePrereqs.h"
41
42#include <set>
43#include <vector>
44
45/**
46@def CCOUT
47    Acts almost exactly like COUT(x), but prepends "ClassName: "
48*/
49#define CCOUT(level) \
50    COUT(level) << this->getIdentifier()->getName() << ": "
51
52namespace orxonox
53{
54    //! The class all objects and interfaces of the game-logic (not the engine) are derived from.
55    /**
56        The BaseObject and Interfaces are derived with 'virtual public OrxonoxClass' from OrxonoxClass.
57        OrxonoxClass is needed to create the class-hierarchy at startup and to store the Identifier and the MetaObjectList.
58    */
59    class _CoreExport OrxonoxClass
60    {
61        template <class T>
62        friend class ClassIdentifier;
63
64        template <class T>
65        friend class SmartPtr;
66
67        template <class T>
68        friend class WeakPtr;
69
70        public:
71            OrxonoxClass();
72            virtual ~OrxonoxClass();
73
74            void destroy();
75
76            /** @brief Function to collect the SetConfigValue-macro calls. */
77            void setConfigValues() {};
78
79            /** @brief Returns the Identifier of the object. @return The Identifier */
80            inline Identifier* getIdentifier() const { return this->identifier_; }
81
82            bool isA(const Identifier* identifier);
83            bool isExactlyA(const Identifier* identifier);
84            bool isChildOf(const Identifier* identifier);
85            bool isDirectChildOf(const Identifier* identifier);
86            bool isParentOf(const Identifier* identifier);
87            bool isDirectParentOf(const Identifier* identifier);
88
89            template <class B> inline bool isA(const SubclassIdentifier<B>* identifier)
90                { return this->isA(*identifier); }
91            template <class B> inline bool isExactlyA(const SubclassIdentifier<B>* identifier)
92                { return this->isExactlyA(*identifier); }
93            template <class B> inline bool isChildOf(const SubclassIdentifier<B>* identifier)
94                { return this->isChildOf(*identifier); }
95            template <class B> inline bool isDirectChildOf(const SubclassIdentifier<B>* identifier)
96                { return this->isDirectChildOf(*identifier); }
97            template <class B> inline bool isParentOf(const SubclassIdentifier<B>* identifier)
98                { return this->isParentOf(*identifier); }
99            template <class B> inline bool isDirectParentOf(const SubclassIdentifier<B>* identifier)
100                { return this->isDirectParentOf(*identifier); }
101
102            bool isA(const OrxonoxClass* object);
103            bool isExactlyA(const OrxonoxClass* object);
104            bool isChildOf(const OrxonoxClass* object);
105            bool isDirectChildOf(const OrxonoxClass* object);
106            bool isParentOf(const OrxonoxClass* object);
107            bool isDirectParentOf(const OrxonoxClass* object);
108
109            inline unsigned int getReferenceCount() const
110                { return this->referenceCount_; }
111
112            /**
113            @brief
114                Returns a valid pointer of any derived type that is
115                registered in the class hierarchy.
116            @return
117                Returns NULL if the no pointer was found.
118            */
119            FORCEINLINE void* getDerivedPointer(unsigned int classID)
120            {
121                for (int i = this->objectPointers_.size() - 1; i >= 0; --i)
122                {
123                    if (this->objectPointers_[i].first == classID)
124                        return this->objectPointers_[i].second;
125                }
126                return NULL;
127            }
128
129            //! Version of getDerivedPointer with template
130            template <class T> FORCEINLINE T* getDerivedPointer(unsigned int classID)
131            {   return static_cast<T*>(this->getDerivedPointer(classID));   }
132            //! Const version of getDerivedPointer with template
133            template <class T> FORCEINLINE const T* getDerivedPointer(unsigned int classID) const
134            {   return const_cast<OrxonoxClass*>(this)->getDerivedPointer<T>(classID);   }
135
136        private:
137            /** @brief Increments the reference counter (for smart pointers). */
138            inline void incrementReferenceCount()
139                { ++this->referenceCount_; }
140            /** @brief Decrements the reference counter (for smart pointers). */
141            inline void decrementReferenceCount()
142                { --this->referenceCount_; if (this->referenceCount_ == 0 && this->requestedDestruction_) { delete this; } }
143               
144            /** @brief Register a weak pointer which points to this object. */
145            template <class T>
146            inline void registerWeakPtr(WeakPtr<T>* pointer)
147                { this->weakPointers_.insert(reinterpret_cast<WeakPtr<OrxonoxClass>*>(pointer)); }
148            /** @brief Unegister a weak pointer which pointed to this object before. */
149            template <class T>
150            inline void unregisterWeakPtr(WeakPtr<T>* pointer)
151                { this->weakPointers_.erase(reinterpret_cast<WeakPtr<OrxonoxClass>*>(pointer)); }
152
153            Identifier* identifier_;                   //!< The Identifier of the object
154            std::set<const Identifier*>* parents_;     //!< List of all parents of the object
155            MetaObjectList* metaList_;                 //!< MetaObjectList, containing all ObjectLists and ObjectListElements the object is registered in
156            int referenceCount_;                       //!< Counts the references from smart pointers to this object
157            bool requestedDestruction_;                //!< Becomes true after someone called delete on this object
158            std::set<WeakPtr<OrxonoxClass>*> weakPointers_; //!< All weak pointers which point to this object (and like to get notified if it dies)
159
160            //! 'Fast map' that holds this-pointers of all derived types
161            std::vector<std::pair<unsigned int, void*> > objectPointers_;
162    };
163}
164
165#endif /* _OrxonoxClass_H__ */
Note: See TracBrowser for help on using the repository browser.