Changeset 5947 for code/branches/pickup2/src/orxonox/pickup/DroppedItem.cc

Timestamp:

Oct 14, 2009, 1:44:19 PM (16 years ago)

Author:

rgrieder

Message:

Merged pickup branch revisions to pickup2.

File:

• code/branches/pickup2/src/orxonox/pickup/DroppedItem.cc (modified) (7 diffs)

code/branches/pickup2/src/orxonox/pickup/DroppedItem.cc

@@ -41 +41 @@
     CreateFactory(DroppedItem);
 
+    /**
+    @brief
+        Constructor. Registers object and sets default values.
+    */
     DroppedItem::DroppedItem(BaseObject* creator) : StaticEntity(creator)
     {
@@ -47 +51 @@
         this->triggerDistance_ = 20.0f;
         this->timeToLive_ = 0;
-        this->item_ = 0;
+        this->item_ = NULL;
     }
+
+    /**
+    @brief
+        Default destructor.
+    */
+    //TODO: Destroy something?
     DroppedItem::~DroppedItem()
     {
+        
     }
+
+    /**
+    @brief
+        Checks whether any pawn is in triggerDistance of the Item and calls this->trigger if so.
+    @param dt
+        The  duration of the last time interval.    
+    */
+    //TODO: Replace this with a DistanceTrigger!
     void DroppedItem::tick(float dt)
     {
         if (this->item_)
         {
-            for (ObjectList<Pawn>::iterator it = ObjectList<Pawn>::begin(); it != ObjectList<Pawn>::end(); ++it)
+            for (ObjectList<Pawn>::iterator it = ObjectList<Pawn>::begin(); it != ObjectList<Pawn>::end(); ++it) //!< Iterate through all Pawns.
             {
                 Vector3 distance = it->getWorldPosition() - this->getWorldPosition();
@@ -64 +83 @@
         }
     }
+
+    /**
+    @brief
+        Called when the DroppedItem is triggered. Adds the item to the triggering pawn.
+    */
     void DroppedItem::trigger(Pawn* pawn)
     {
-        if (this->item_->pickedUp(pawn))
+        if (this->item_->pickedUp(pawn)) //If pickup was successful.
         {
             COUT(3) << "DroppedItem '" << this->item_->getPickupIdentifier() << "' picked up." << std::endl;
@@ -72 +96 @@
         }
     }
+
+    /**
+    @brief
+        Creates a timer to call this->timerCallback() at expiration of timeToLive.
+    */
+    //TODO: Better Comments.
     void DroppedItem::createTimer()
     {
@@ -79 +109 @@
         }
     }
+    
+    /**
+    @brief
+        Destroys the item. Called by the set timer upon its expiration.
+    */
+    //TODO: Choose better function name if this doesn't create dependency inconsistencies. e.g. this->destroy() or this->timeOut()
+    //Make certain that only one pawn has the same item, because if not, deliting the item would lead to a possible segfault.
+    //If the item is destroyed here, shouldn't it be destroyed in the destructor as well?
     void DroppedItem::timerCallback()
     {
@@ -90 +128 @@
     }
 
-    DroppedItem* DroppedItem::createDefaultDrop(BaseItem* item, const Vector3& position, const ColourValue& flareColour, float timeToLive)
+    /**
+    @brief
+        
+    */
+    //TODO: Comment.
+    //This is for pawns dropping items they have...
+    //Probably better to create a spawner with only 1 item in it.
+    //Various different thigs are done here, which in my opinion should eighter be done in XML or some where else, preferably in XML.
+    //Each pickup should have a XML template where the Model and Billboard, and so on, is specified.
+    //The position, item and timetoLive should be specified by this Classes XMLPort function.
+    //These adjustments above, will very likely create inkonsistencies in the level files, possibly templates.
+    /*static*/ DroppedItem* DroppedItem::createDefaultDrop(BaseItem* item, const Vector3& position, const ColourValue& flareColour, float timeToLive)
     {
         DroppedItem* drop = new DroppedItem(item);
@@ -116 +165 @@
         return drop;
     }
+
+    /**
+    @brief
+
+    */
+    //TODO: See one function above.
     DroppedItem* DroppedItem::createDefaultDrop(BaseItem* item, Pawn* pawn, const ColourValue& flareColour, float timeToLive)
     {