Changeset 7195 in orxonox.OLD for trunk/src/lib/util/loading/resource.h

Timestamp:

Mar 7, 2006, 11:12:31 PM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: performance issues

File:

• trunk/src/lib/util/loading/resource.h (modified) (3 diffs)

trunk/src/lib/util/loading/resource.h

@@ -1 +1 @@
 /*!
  * @file resource.h
- * @brief Definition of ...
+ * @brief Definition of a Resource.
 */
 
@@ -9 +9 @@
 #include "base_object.h"
 #include "multi_type.h"
-
+#include <string>
 
 // FORWARD DECLARATION
@@ -15 +15 @@
 
 
-//! A class for ...
+//! An enumerator for different (UN)LOAD-types.
+/**
+ * RP_NO:        will be unloaded on request
+ * RP_LEVEL:     will be unloaded at the end of a Level
+ * RP_CAMPAIGN:  will be unloaded at the end of a Campaign
+ * RP_GAME:      will be unloaded at the end of the whole Game (when closing orxonox)
+ */
+typedef enum ResourcePriority
+{
+  RP_NO        =   0,
+  RP_LEVEL     =   1,
+  RP_CAMPAIGN  =   2,
+  RP_GAME      =   3
+};
+
+
+
+//! A Resource is an Object, that can be loaded from Disk
+/**
+ *
+ */
 class Resource : virtual public BaseObject {
 
  public:
-  Resource();
+   Resource(const std::string& fileName);
   virtual ~Resource();
 
-  virtual bool load(const char* fileName, const MultiType& param1, const MultiType& param2);
+  virtual bool load(std::string& fileName, const MultiType& param1, const MultiType& param2);
   virtual bool reload();
   virtual bool unload();
 
  private:
+   std::string       fileName;
 
+   unsigned int      referenceCount;    //!< How many times this Resource has been loaded.
+/// TODO REMOVE THIS:   ResourceType      type;              //!< ResourceType of this Resource.
+   ResourcePriority  prio;              //!< The Priority of this resource. (can only be increased, so noone else will delete this)
+
+   MultiType         param[3];          //!< The Parameters given to this Resource.
 };