Changeset 6475 for code/branches/pickup3/src/modules/pickup/PickupRepresentation.cc

Timestamp:

Mar 5, 2010, 6:26:54 PM (14 years ago)

Author:

dafrick

Message:

Additional documentation, code niceifying and potential bug fixing. Also: Renamed DroppedItem to DroppedPickup.

File:

• code/branches/pickup3/src/modules/pickup/PickupRepresentation.cc (modified) (8 diffs)

code/branches/pickup3/src/modules/pickup/PickupRepresentation.cc

@@ -30 +30 @@
 
 #include "core/CoreIncludes.h"
+#include "graphics/Billboard.h"
+#include "util/StringUtils.h"
 #include "PickupManager.h"
-#include "graphics/Billboard.h"
 
 namespace orxonox
@@ -38 +39 @@
     CreateFactory(PickupRepresentation);
     
+    /**
+    @brief
+        Constructor. Registers the object and initializes its member variables.
+        This is primarily for use of the PickupManager in creating a default PickupRepresentation.
+    */
     PickupRepresentation::PickupRepresentation() : BaseObject(this)
     {
@@ -45 +51 @@
     }
     
+    /**
+    @brief
+        Default Constructor. Registers the object and initializes its member variables.
+    */
     PickupRepresentation::PickupRepresentation(BaseObject* creator) : BaseObject(creator)
     {
@@ -52 +62 @@
     }
     
+    /**
+    @brief
+        Destructor.
+    */
     PickupRepresentation::~PickupRepresentation()
     {
-        
+        if(this->spawnerRepresentation_ != NULL)
+            this->spawnerRepresentation_->destroy();
     }
     
+    /**
+    @brief
+        Initializes the member variables of this PickupRepresentation.
+    */
     void PickupRepresentation::initialize(void)
     {
@@ -66 +85 @@
     }
     
+    /**
+    @brief
+        Method for creating a PickupRepresentation object through XML.
+    */
     void PickupRepresentation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -76 +99 @@
         XMLPortObject(PickupRepresentation, StaticEntity, "spawner-representation", setSpawnerRepresentation, getSpawnerRepresentationIndex, xmlelement, mode);
         
-        PickupManager::getInstance().registerRepresentation(*this->pickup_->getPickupIdentifier(), this);
+        PickupManager::getInstance().registerRepresentation(this->pickup_->getPickupIdentifier(), this); //!< Registers the PickupRepresentation with the PickupManager through the PickupIdentifier of the Pickupable it represents.
     }
     
+    /**
+    @brief
+        Get a spawnerRepresentation for a specific PickupSpawner.
+    @param spawner
+        A pointer to the PickupSpawner.
+    @return
+        Returns a pointer to the StaticEntity.
+    */
     StaticEntity* PickupRepresentation::getSpawnerRepresentation(PickupSpawner* spawner)
     {
@@ -84 +115 @@
         {
             COUT(4) << "PickupRepresentation: No spawner representation found." << std::endl;
-            if(this->spawnerTemplate_ == "")
+            if(this->spawnerTemplate_ == BLANKSTRING)
             {
                 COUT(4) << "PickupRepresentation: Spawner template is empty." << std::endl;
+                //!< If neither spawnerRepresentation nor spawnerTemplate was specified
                 return this->getDefaultSpawnerRepresentation(spawner);
             }
             this->addTemplate(this->spawnerTemplate_);
         }
+        
         StaticEntity* representation = this->spawnerRepresentation_;
         
@@ -98 +131 @@
     }
     
+    /**
+    @brief
+        Get the default spawnerRepresentation for a specific PickupSpawner.
+        Helper method of internal use.
+    @param spawner
+        A pointer to the PickupSpawner.
+    @return
+        Returns a pointer to the StaticEntity.
+    */
+    //TODO: Think of more elegant solution.
     StaticEntity* PickupRepresentation::getDefaultSpawnerRepresentation(PickupSpawner* spawner)
     {