Changeset 6521

Timestamp:

Mar 15, 2010, 7:33:11 AM (14 years ago)

Author:

dafrick

Message:

Added changedPickedUp method to Pickupable to solve a problem in PickupCollection, which, for the most part, works now.

Location:

code/branches/pickup3/src

Files:

• libraries/core/Super.h (modified) (3 diffs)
• modules/pickup/Pickup.cc (modified) (1 diff)
• modules/pickup/Pickup.h (modified) (1 diff)
• modules/pickup/PickupCollection.cc (modified) (2 diffs)
• modules/pickup/PickupCollection.h (modified) (1 diff)
• orxonox/interfaces/PickupCarrier.h (modified) (2 diffs)
• orxonox/interfaces/Pickupable.cc (modified) (3 diffs)
• orxonox/interfaces/Pickupable.h (modified) (6 diffs)

code/branches/pickup3/src/libraries/core/Super.h

@@ -277 +277 @@
         SUPER_NOARGS(classname, functionname)
         
+    #define SUPER_changedPickedUp(classname, functionname, ...) \
+        SUPER_NOARGS(classname, functionname)
+        
     // (1/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
 
@@ -537 +540 @@
         
         SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(12, changedCarrier, false)
+            ()
+        SUPER_FUNCTION_GLOBAL_DECLARATION_PART2;
+        
+        SUPER_FUNCTION_GLOBAL_DECLARATION_PART1(13, changedPickedUp, false)
             ()
         SUPER_FUNCTION_GLOBAL_DECLARATION_PART2;
@@ -596 +603 @@
     SUPER_INTRUSIVE_DECLARATION(clone);
     SUPER_INTRUSIVE_DECLARATION(changedCarrier);
+    SUPER_INTRUSIVE_DECLARATION(changedPickedUp);
     // (3/3) --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <-- --> HERE <--
 

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

@@ -182 +182 @@
     @brief
         Should be called when the pickup has transited from picked up to dropped or the other way around.
-        Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedCarrier); to their changedCarrier method.
-    */
-    void Pickup::changedCarrier(void)
-    {
-        SUPER(Pickup, changedCarrier);
+        Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedPickedUp); to their changedPickedUp method.
+    */
+    void Pickup::changedPickedUp(void)
+    {
+        SUPER(Pickup, changedPickedUp);
         
         //! Sets the Pickup to used if the Pickup has activation type 'immediate' and gets picked up.

code/branches/pickup3/src/modules/pickup/Pickup.h

@@ -117 +117 @@
                 { return this->getDurationTypeDirect() == pickupDurationType::continuous; }
             
-            virtual void changedCarrier(void); //!< Should be called when the pickup has transited from picked up to dropped or the other way around.
+            virtual void changedPickedUp(void); //!< Should be called when the pickup has transited from picked up to dropped or the other way around.
                                     
             virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the Pickup.

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

@@ -138 +138 @@
     }
     
-    //TODO: Steal description from Pickupable.
     void PickupCollection::changedUsed(void)
     {
@@ -150 +149 @@
     }
     
-    void PickupCollection::changedCarrier()
+    void PickupCollection::changedCarrier(void)
     {
         SUPER(PickupCollection, changedCarrier);
         
+        //! Change used for all Pickupables this PickupCollection consists of.
+        for(std::vector<Pickupable*>::iterator it = this->pickups_.begin(); it != this->pickups_.end(); it++)
+        {
+            (*it)->setCarrier(this->getCarrier());
+        }
+    }
+    
+    void PickupCollection::changedPickedUp()
+    {
+        SUPER(PickupCollection, changedPickedUp);
+        
         //! Change the carrier for all Pickupables this PickupCollection consists of.
         for(std::vector<Pickupable*>::iterator it = this->pickups_.begin(); it != this->pickups_.end(); it++)
         {
-            (*it)->setCarrier(this->getCarrier());
-        }
-    }
-    
-    //TODO: Steal description from Pickupable.
+            (*it)->setPickedUp(this->isPickedUp());
+        }
+    }
+    
     void PickupCollection::clone(OrxonoxClass*& item)
     {

code/branches/pickup3/src/modules/pickup/PickupCollection.h

@@ -58 +58 @@
 
             virtual void changedUsed(void);
-            
             virtual void changedCarrier(void);
+            virtual void changedPickedUp(void);
             
             virtual void clone(OrxonoxClass*& item);

code/branches/pickup3/src/orxonox/interfaces/PickupCarrier.h

@@ -46 +46 @@
 namespace orxonox
 {
-    
+
     class Pickup;
     class HealthPickup;
@@ -175 +175 @@
             virtual const Vector3& getCarrierPosition(void) = 0;
                             
-            //TODO: Remove.
+            /**
+            @brief Get all Pickupables this PickupCarrier has.
+            @return  Returns the set of all Pickupables this PickupCarrier has.
+            */
             std::set<Pickupable*>& getPickups(void)
                 { return this->pickups_; }

code/branches/pickup3/src/orxonox/interfaces/Pickupable.cc

@@ -172 +172 @@
         
         COUT(4) << "Pickupable (&" << this << ") got picked up by a PickupCarrier (&" << carrier << ")." << std::endl;
+        this->setCarrier(carrier);
         this->setPickedUp(true);
-        this->setCarrier(carrier);
+        return true;
+    }
+    
+    /**
+    @brief
+        Helper method to set the Pickupable to either picked up or not picked up.
+    @param pickedUp
+        The value this->pickedUp_ should be set to.
+    @return
+        Returns true if the pickedUp status was changed, false if not.
+    */
+    bool Pickupable::setPickedUp(bool pickedUp)
+    {
+        if(this->pickedUp_ == pickedUp)
+            return false;
+        
+        COUT(4) << "Pickupable (&" << this << ") set to pickedUp " << pickedUp << "." << std::endl;
+        
+        this->pickedUp_ = pickedUp;
+        this->changedPickedUp();
+        return true;
+    }
+        
+    /**
+    @brief
+        Sets the carrier of the pickup.
+    @param carrier
+        Sets the input PickupCarrier as the carrier of the pickup.
+    */
+    inline bool Pickupable::setCarrier(PickupCarrier* carrier)
+    {
+        if(this->carrier_ == carrier)
+            return false;
+        
+        COUT(4) << "Pickupable (&" << this << ") changed Carrier (& " << carrier << ")." << std::endl;
+        
+        this->carrier_ = carrier;
+        this->changedCarrier();
         return true;
     }
@@ -205 +243 @@
     }
     
-        
-    /**
-    @brief
-        Sets the carrier of the pickup.
-    @param carrier
-        Sets the input PickupCarrier as the carrier of the pickup.
-    @return
-        Returns true if the carrier was changed, false if not.
-    */
-    bool Pickupable::setCarrier(PickupCarrier* carrier)
-    {
-        if(this->getCarrier() == carrier)
-            return false;
-        
-        this->carrier_ = carrier;
-        this->changedCarrier();
-        return true;
-    }
-    
     /**
     @brief
@@ -230 +249 @@
         Returns the clone of this pickup as a pointer to a Pickupable.
     */
-    //TODO: Does this work?
     Pickupable* Pickupable::clone(void)
     {

code/branches/pickup3/src/orxonox/interfaces/Pickupable.h

@@ -70 +70 @@
             */
             virtual void changedUsed(void) {}
-            bool setUsed(bool used); //!< Sets the Pickupable to used or unused, depending on the input.
+            
+            /**
+            @brief Get the carrier of the pickup.
+            @return Returns a pointer to the carrier of the pickup.
+            */
+            inline PickupCarrier* getCarrier(void)
+                { return this->carrier_; }
+            /**
+            @brief Should be called when the pickup has changed its PickupCarrier.
+                   Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedCarrier); to their changedCarrier method.
+            */
+            virtual void changedCarrier(void) {}
             
             /**
@@ -78 +89 @@
             inline bool isPickedUp(void)
                 { return this->pickedUp_; }
+            /**
+            @brief  Should be called when the pickup has transited from picked up to dropped or the other way around.
+                    Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedPickedUp); to their changedPickedUp method.
+            */
+            virtual void changedPickedUp(void) {}    
+            
             //TODO: Better private, or protected?
             bool pickedUp(PickupCarrier* carrier); //!< Sets the Pickupable to picked up.
@@ -86 +103 @@
             bool addTarget(PickupCarrier* target); //!< Add a PickupCarrier as target of this pickup.
             bool addTarget(Identifier* identifier); //!< Add a class, representetd by the input Identifier, as target of this pickup.
-            
-            /**
-            @brief Get the carrier of the pickup.
-            @return Returns a pointer to the carrier of the pickup.
-            */
-            inline PickupCarrier* getCarrier(void)
-                { return this->carrier_; }
-            /**
-            @brief  Should be called when the pickup has transited from picked up to dropped or the other way around.
-                    Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedCarrier); to their changedCarrier method.
-            */
-            virtual void changedCarrier(void) {}
-            //TODO: Maybe private?
-            bool setCarrier(PickupCarrier* carrier); //!< Sets the carrier of the pickup.
             
             Pickupable* clone(void); //!< Creates a duplicate of the Pickupable.
@@ -113 +116 @@
             virtual void destroy(void)
                 { delete this; }
+                
+            //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.
+            bool setCarrier(PickupCarrier* carrier); //!< Sets the carrier of the pickup.
             
         protected:
@@ -134 +142 @@
             
         private:
-            /**
-            @brief Helper method to set the Pickupable to either picked up or not picked up.
-            @param pickedUp The value this->pickedUp_ should be set to.
-            */
-            inline void setPickedUp(bool pickedUp)
-                { this->pickedUp_ = pickedUp; }
             
             bool used_; //!< Whether the pickup is currently in use or not.
@@ -151 +153 @@
     SUPER_FUNCTION(10, Pickupable, changedUsed, false);
     SUPER_FUNCTION(12, Pickupable, changedCarrier, false);
+    SUPER_FUNCTION(13, Pickupable, changedPickedUp, false);
 }