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

Timestamp:

Mar 5, 2010, 6:26:54 PM (15 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/DroppedPickup.cc (moved) (moved from code/branches/pickup3/src/modules/pickup/DroppedItem.cc) (3 diffs)

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

@@ -23 +23 @@
  *      Daniel 'Huty' Haggenmueller
  *   Co-authors:
- *      ...
+ *      Damian 'Mozork' Frick
  *
  */
 
-#include "DroppedItem.h"
+/**
+    @file
+    @brief Implementation of the DroppedPickup class.
+*/
+
+#include "DroppedPickup.h"
 
 #include "core/CoreIncludes.h"
@@ -37 +42 @@
     /**
     @brief
-        Constructor. Registers object and sets default values.
+        Default constructor. Registers object and sets default values.
     */
-    DroppedItem::DroppedItem(BaseObject* creator) : PickupSpawner(creator)
+    DroppedPickup::DroppedPickup(BaseObject* creator) : PickupSpawner(creator)
     {
+        RegisterObject(DroppedPickup);
+        
         this->initialize();
-    }
-
-    DroppedItem::DroppedItem(BaseObject* creator, Pickupable* item, const Vector3& position, float triggerDistance) : PickupSpawner(creator, item, triggerDistance, 0, 1)
-    {   
-        this->initialize();
-        
-        this->createDrop(position);
-    }
-    
-    void DroppedItem::initialize(void)
-    {
-        RegisterObject(DroppedItem);
-        
-        this->gotPickedUp_ = false;
     }
 
     /**
     @brief
-        Default destructor.
+        Constructor. Registers the object and sets values.
+    @param creator
+        The creator of the DroppedPickup.
+    @param pickup
+        The Pickupable that was dropped.
+    @param position
+        The position at which the DroppedPickup should be created.
+    @param triggerDistance
+        The distance at which the PickupSpawner triggers. Default is 10.
     */
-    DroppedItem::~DroppedItem()
+    DroppedPickup::DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position, float triggerDistance) : PickupSpawner(creator, pickup, triggerDistance, 0, 1)
+    {   
+        RegisterObject(DroppedPickup);
+        
+        this->initialize();
+        
+        this->setPosition(position);
+    }
+
+    /**
+    @brief
+        Destructor.
+    */
+    DroppedPickup::~DroppedPickup()
     {
         if(this->gotPickedUp_ && this->pickup_ != NULL)
@@ -69 +83 @@
         }
     }
+    
+    /**
+    @brief
+        Initializes the member variables of the object.
+    */
+    void DroppedPickup::initialize(void)
+    {
+        this->gotPickedUp_ = false;
+    }
 
-    Pickupable* DroppedItem::getPickup(void)
+    /**
+    @brief
+        Creates the Pickupable that is going to get picked up.
+        In the case of the DroppedItem it is the one and only Pickupable that was dropped. No additional Pickupables of the same type are created.
+    */
+    Pickupable* DroppedPickup::getPickup(void)
     {
         return this->pickup_;
     }
-    
-    //TODO; Doesn't seem to be needed anymore, just put setPosition in the constructor.
-    void DroppedItem::createDrop(const Vector3& position)
-    {
-        this->setPosition(position);
-        
-        //TODO: Make this work.
-        //const Model& model = PickupManager::getModel(item->getPickupIdentifier());
-        //this->attach(model);
-    }
 
-//TODO: Remove.
-    //TODO: Comment.
-    //Each pickup should have a XML template where the Model and Billboard, and so on, is specified.
-//    /*static*/ DroppedItem* DroppedItem::createDefaultDrop(BaseItem* item, const Vector3& position, const ColourValue& flareColour, float timeToLive)
-//     {
-//         //TODO: triggerDistance?
-//         float triggerDistance = 20.0;
-//         DroppedItem* droppedItem = new DroppedItem(item, item, triggerDistance, 0, 1);
-//         
-//         //TODO: Do this somehwere else?
-//         Model* model = new Model(item);
-//         Billboard* billboard = new Billboard(item);
-// 
-//         model->setMeshSource("sphere.mesh");
-//         model->setScale(3.0f);
-// 
-//         billboard->setMaterial("Examples/Flare");
-//         billboard->setColour(flareColour);
-//         billboard->setScale(0.5f);
-// 
-//         droppedItem->setPosition(position);
-//         droppedItem->attach(model);
-//         droppedItem->attach(billboard);
-// 
-//         COUT(3) << "Created DroppedItem for '" << item->getPickupIdentifier() << "' at (" << position.x << "," << position.y << "," << position.z << ")." << std::endl;
-// 
-//         return droppedItem;
-//     }
-
-    //TODO: See one function above.
-//     DroppedItem* DroppedItem::createDefaultDrop(BaseItem* item, Pawn* pawn, const ColourValue& flareColour, float timeToLive)
-//     {
-//         Vector3 after = pawn->getPosition() + pawn->getOrientation() * Vector3(0.0f, 0.0f, 50.0f);
-//         return DroppedItem::createDefaultDrop(item, after, flareColour, timeToLive);
-//     }
 }