Changeset 6540 for code/trunk/src/orxonox

Timestamp:

Mar 16, 2010, 9:35:11 PM (15 years ago)

Author:

dafrick

Message:

Removed some TODO's. Finished up documenting pickup module.

Location:

code/trunk/src/orxonox

Files:

• interfaces/PickupCarrier.h (modified) (7 diffs)
• interfaces/Pickupable.cc (modified) (3 diffs)
• interfaces/Pickupable.h (modified) (3 diffs)
• items/Engine.cc (modified) (2 diffs)
• pickup/PickupIdentifier.cc (modified) (1 diff)
• pickup/PickupIdentifier.h (modified) (1 diff)
• worldentities/pawns/Pawn.cc (modified) (2 diffs)
• worldentities/pawns/Pawn.h (modified) (3 diffs)

code/trunk/src/orxonox/interfaces/PickupCarrier.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file PickupCarrier.h
     @brief Definition of the PickupCarrier class.
 */
@@ -48 +48 @@
 {
 
+    //! Pre-declarations.
     class Pickup;
     class HealthPickup;
@@ -60 +61 @@
     class _OrxonoxExport PickupCarrier : virtual public OrxonoxClass
     {
-        friend class Pickupable; //!< The Pickupable has full acces to its PickupCarrier.
-        //TODO: Ugly workaround.
+         //! So that the different Pickupables have full access to their PickupCarrier.
+        friend class Pickupable;
         friend class Pickup;
         friend class HealthPickup;
@@ -108 +109 @@
             @return Returns true if the PickupCarrier or one of its children is a target, false if not.
             */
-            //TODO: Use?
             bool isTarget(const Pickupable* pickup)
                 {
@@ -154 +154 @@
                     return NULL;
                 }
+                
+            /**
+            @brief Get the (absolute) position of the PickupCarrier.
+                   This method needs to be implemented by any direct derivative class of PickupCarrier.
+            @return Returns the position as a Vector3.
+            */
+            virtual const Vector3& getCarrierPosition(void) = 0;
             
         protected:        
@@ -159 +166 @@
             @brief Get all direct children of this PickupSpawner.
                    This method needs to be implemented by any direct derivative class of PickupCarrier.
+                   The returned list will be deleted by the methods calling this function.
             @return Returns a pointer to a list of all direct children. 
             */
-            //TODO: Good return type? Maybe not const and destroyed in isTarget...
             virtual std::list<PickupCarrier*>* getCarrierChildren(void) = 0;
             /**
@@ -169 +176 @@
             */
             virtual PickupCarrier* getCarrierParent(void) = 0;
-            /**
-            @brief Get the (absolute) position of the PickupCarrier.
-                   This method needs to be implemented by any direct derivative class of PickupCarrier.
-            @return Returns the position as a Vector3.
-            */
-            virtual const Vector3& getCarrierPosition(void) = 0;
                             
             /**

code/trunk/src/orxonox/interfaces/Pickupable.cc

@@ -46 +46 @@
         Constructor. Registers the objects and initializes its member variables.
     */
-    Pickupable::Pickupable()
-    {
-        this->used_ = false;
-        this->pickedUp_ = false;
-        
+    Pickupable::Pickupable() : used_(false), pickedUp_(false)
+    {        
         RegisterRootObject(Pickupable);
         
@@ -231 +228 @@
         this->setPickedUp(false);
         
-        bool created = this->createSpawner(this->getCarrier()->getCarrierPosition());
+        bool created = this->createSpawner();
         
         this->setCarrier(NULL);
-        //TODO: possible problem.
+        
         if(!created)
         {
@@ -267 +264 @@
         A reference to a pointer to the OrxonoxClass that is to be duplicated.
     */
-    //TODO: Specify how the implementation must be done in detail.
     void Pickupable::clone(OrxonoxClass*& item)
     {

code/trunk/src/orxonox/interfaces/Pickupable.h

@@ -51 +51 @@
         Damian 'Mozork' Frick
     */
-    //TODO: Add stuff like weight/space ?
     class _OrxonoxExport Pickupable : virtual public OrxonoxClass
     {
+        protected:
+            Pickupable(); //!< Default constructor.
         
         public:
-            Pickupable(); //!< Default constructor.
             virtual ~Pickupable(); //!< Default destructor.
             
@@ -113 +113 @@
                 { return this->pickupIdentifier_; }
                 
-            //TODO: Make them work as protected.
             bool setUsed(bool used); //!< Sets the Pickupable to used or unused, depending on the input.
             bool setPickedUp(bool pickedUp); //!< Helper method to set the Pickupable to either picked up or not picked up.
@@ -131 +130 @@
             @return Returns true if a spawner was created, false if not.
             */
-            virtual bool createSpawner(const Vector3& position) = 0;
+            virtual bool createSpawner(void) = 0;
             
-            //TODO: Move to private and create get method in protected.
             PickupIdentifier* pickupIdentifier_; //!< The PickupIdentifier of this Pickupable.
             

code/trunk/src/orxonox/items/Engine.cc

@@ -35 +35 @@
 #include "Scene.h"
 #include "worldentities/pawns/SpaceShip.h"
-//TODO: Remove.
-//#include "pickup/ModifierType.h"
 #include "tools/Shader.h"
 
@@ -194 +192 @@
         }
 
-        //TODO: Correct?
         this->ship_->setAcceleration(this->ship_->getOrientation() * acceleration);
 

code/trunk/src/orxonox/pickup/PickupIdentifier.cc

@@ -26 +26 @@
  *
  */
+
+/**
+    @file PickupIdentifier.cc
+    @brief Implementation of the PickupIdentifier class.
+*/
 
 #include "PickupIdentifier.h"

code/trunk/src/orxonox/pickup/PickupIdentifier.h

@@ -26 +26 @@
  *
  */
+
+/**
+    @file PickupIdentifier.h
+    @brief Definition of the PickupIdentifier class.
+*/
 
 #ifndef _PickupIdentifier_H__

code/trunk/src/orxonox/worldentities/pawns/Pawn.cc

@@ -71 +71 @@
         this->aimPosition_ = Vector3::ZERO;
 
-        //TODO: Remove.
-        //this->getPickups().setOwner(this);
-
         if (GameMode::isMaster())
         {
@@ -297 +294 @@
     }
 
-//TODO: Remove.
-//     void Pawn::dropItems()
-//     {
-//         this->getPickups().clear();
-//     }
-
-
     /* WeaponSystem:
     *   functions load Slot, Set, Pack from XML and make sure all parent-pointers are set.

code/trunk/src/orxonox/worldentities/pawns/Pawn.h

@@ -109 +109 @@
                 { return this->numexplosionchunks_; }
 
-//TODO: Remove.
-//             virtual void dropItems();
-//             inline PickupCollection& getPickups()
-//                 { return this->pickups_; }
-//             virtual void useItem()
-//                 { this->pickups_.useItem(); }
-
             virtual void startLocalHumanControl();
 
@@ -122 +115 @@
             Vector3 getAimPosition()
                 { return this->aimPosition_; }
+                
+            virtual const Vector3& getCarrierPosition(void)
+                { return this->getWorldPosition(); };
 
         protected:
@@ -136 +132 @@
             bool bAlive_;
 
-            //TODO: Remove.
-            //PickupCollection pickups_;
             virtual std::list<PickupCarrier*>* getCarrierChildren(void)
                 { return new std::list<PickupCarrier*>(); }
             virtual PickupCarrier* getCarrierParent(void)
                 { return NULL; }
-            virtual const Vector3& getCarrierPosition(void)
-                { return this->getWorldPosition(); };
 
             float health_;