Changeset 9570 for code/branches/core6/src/libraries/core/object/Destroyable.h

Timestamp:

Mar 24, 2013, 8:51:37 PM (11 years ago)

Author:

landauf

Message:

moved functions and attributes needed to safely destroy objects from OrxonoxClass to Destroyable

File:

• code/branches/core6/src/libraries/core/object/Destroyable.h (copied) (copied from code/branches/core6/src/libraries/core/class/OrxonoxClass.h) (4 diffs)

code/branches/core6/src/libraries/core/object/Destroyable.h

@@ -28 +28 @@
 
 /**
-    @defgroup OrxonoxClass OrxonoxClass
-    @ingroup Class
+    @file
+    @ingroup Object
+    @brief Declaration of Destroyable, the base class of all objects which can be used with SmartPtr and WeakPtr.
 */
 
-/**
-    @file
-    @ingroup Class OrxonoxClass
-    @brief Declaration of OrxonoxClass, the base class of all objects and interfaces in Orxonox.
-*/
-
-#ifndef _OrxonoxClass_H__
-#define _OrxonoxClass_H__
+#ifndef _Destroyable_H__
+#define _Destroyable_H__
 
 #include "core/CorePrereqs.h"
 
 #include <set>
-//#include "Super.h"
-#include "Identifiable.h"
 
 namespace orxonox
 {
     /**
-        @brief The class all objects and interfaces of the game-logic (not the engine) are derived from.
-
-        The BaseObject and Interfaces are derived with @c virtual @c public @c OrxonoxClass from OrxonoxClass.
+        @brief Classes must inherit from this class if they should be used with SmartPtr or WeakPtr.
     */
-    class _CoreExport OrxonoxClass : public Identifiable
+    class _CoreExport Destroyable
     {
         template <class T>
@@ -62 +53 @@
 
         public:
-            OrxonoxClass();
-            virtual ~OrxonoxClass();
+            Destroyable();
+            virtual ~Destroyable();
 
             void destroy();
-
-            /// Function to collect the SetConfigValue-macro calls.
-            void setConfigValues() {};
 
             /// Returns the number of @ref orxonox::SmartPtr "smart pointers" that point to this object.
@@ -103 +91 @@
 
     /**
-        @brief This listener is used to inform weak pointers if an object of type OrxonoxClass gets destroyed.
+        @brief This listener is used to inform weak pointers if an object of type Destroyable gets destroyed.
     */
     class _CoreExport DestructionListener
     {
-        friend class OrxonoxClass;
+        friend class Destroyable;
 
         protected:
             virtual ~DestructionListener() {}
 
-            inline void registerAsDestructionListener(OrxonoxClass* object)
+            inline void registerAsDestructionListener(Destroyable* object)
                 { if (object) { object->registerDestructionListener(this); } }
-            inline void unregisterAsDestructionListener(OrxonoxClass* object)
+            inline void unregisterAsDestructionListener(Destroyable* object)
                 { if (object) { object->unregisterDestructionListener(this); } }
 
@@ -122 +110 @@
 }
 
-#endif /* _OrxonoxClass_H__ */
+#endif /* _Destroyable_H__ */