Changes between Version 4 and Version 5 of code/doc/ModulesDescription

Timestamp:

Mar 29, 2005, 11:43:29 PM (19 years ago)

Author:

bensch

Comment:

added resourceManager

code/doc/ModulesDescription

@@ -4 +4 @@
 Currently we have following modules descriptions here:
  * list (list.h)
-
+ * ResourceManager (resource_manager.h)
 
 == list ==
@@ -80 +80 @@
 
 }}}
+
+== Resource Manager ==
+There is a filehandler, that loades stores and unloades resources, like .obj-models, wav's, ogg's, textures and so on
+
+== usage in a WorldEntity like the Player ==
+{{{
+#include "resource_manager.h"     /* includes the headers of the ResourceManager */
+
+Player::Player()         /* in the initialisation we load the module */
+{
+  .
+  .
+  .
+  /* the following loads an OBJ-file named models/reaplow.obj
+   * The type is OBJ (if no type is specified the model will try to determine it for itself)
+   * RP_CAMPAIGN tells the ResourceManager when, and if it will be allowed to delete the Model
+  */
+  this->model = (Model*)ResourceManager::load("models/reaplow.obj", OBJ, RP_CAMPAIGN);
+}
+
+Player::~Player()
+{
+   /* here we would unload the Resource, that we allocated, but because WorldEntity
+    * is doing it anyway, we do not have to concern ourselves with this.
+    * But one could do something like: ResourceManager::unload(this->model); to do it
+   */
+}
+
+/* and thats it */
+}}}
+
+== settings ==
+As we see in the Player::Player() example, there are some options to be considered when
+allocating a resource:
+
+__RESOURCE TYPES__: different types known to the resourceManager
+{{{
+/**
+   OBJ: a .obj-file
+   PRIM: a Model primitive (CUBE, CYLINDER, SPHERE and so on...)
+   WAV: a wave-file
+   OGG: i think you get it
+*/
+enum ResourceType {OBJ, PRIM, WAV, MP3, OGG, IMAGE};
+}}}
+
+__RESOURCE PRIORITIES__: different unload-stages 
+{{{
+/**
+   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 exiting orxonox)
+*/
+enum ResourcePriority {RP_NO = 0, RP_LEVEL = 1, RP_CAMPAIGN = 2, RP_GAME = 3};
+}}}
+