Changeset 6475 for code/branches/pickup3/src/orxonox/interfaces/PickupCarrier.h

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/orxonox/interfaces/PickupCarrier.h (modified) (4 diffs)

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

@@ -65 +65 @@
             @return Returns true if the Pickupable was picked up, false if not.
             */
-            inline bool pickup(Pickupable* pickup)
+            bool pickup(Pickupable* pickup)
                 {
                     bool pickedUp = this->pickups_.insert(pickup).second;
@@ -78 +78 @@
             @return Returns true if the Pickupable has been dropped, false if not.
             */
-            inline bool drop(Pickupable* pickup)
+            bool drop(Pickupable* pickup)
                 { 
                    bool dropped = this->pickups_.erase(pickup) == 1;
@@ -84 +84 @@
                    {
                        pickup->dropped();
-                        //TODO: Create Spawner.
                    }
                    return dropped;
                 }
                 
-            inline bool isTarget(Pickupable* pickup)
+            /**
+            @brief Can be used to check whether the PickupCarrier or a child of his is a target ot the input Pickupable.
+            @param pickup A pointer to the Pickupable.
+            @return Returns true if the PickupCarrier or one of its children is a target, false if not.
+            */
+            //TODO: Use?
+            bool isTarget(const Pickupable* pickup)
                 {
-                    if(pickup->isTarget(this))
+                    if(pickup->isTarget(this)) //!< If the PickupCarrier itself is a target.
                         return true;
-                    const std::list<PickupCarrier*>* children = this->getChildren();
+                    
+                    //! Go recursively through all children to check whether they are a target.
+                    std::list<PickupCarrier*>* children = this->getCarrierChildren();
                     for(std::list<PickupCarrier*>::const_iterator it = children->begin(); it != children->end(); it++)
                     {
@@ -100 +107 @@
                     }
                     
+                    children->clear();
+                    delete children;
+                    
                     return false;
                 }
+                
+            /**
+            @brief Get the carrier that is both a child of the PickupCarrier (or the PickupCarrier itself) and a target of the input Pickupable.
+            @param pickup A pounter to the Pickupable.
+            @return Returns a pointer to the PickupCarrier that is the target of the input Pickupable.
+            */
+            PickupCarrier* getTarget(const Pickupable* pickup)
+                {
+                    if(!this->isTarget(pickup))
+                        return NULL;
+                    
+                    if(pickup->isTarget(this)) //!< If the PickupCarrier itself is a target.
+                        return this;
+                    
+                    //! Go recursively through all children to check whether they are the target.
+                    std::list<PickupCarrier*>* children = this->getCarrierChildren();
+                    for(std::list<PickupCarrier*>::iterator it = children->begin(); it != children->end(); it++)
+                    {
+                        if(pickup->isTarget(*it))
+                            return *it;
+                    }
+                    
+                    children->clear();
+                    delete children;
+                    
+                    return NULL;
+                }
             
-        protected:            
-            //TODO: Good return type?
-            virtual const std::list<PickupCarrier*>* getChildren(void) = 0;
-            virtual PickupCarrier* getParent(void) = 0;
+        protected:        
+            /**
+            @brief Get all direct children of this PickupSpawner.
+                   This method needs to be implemented by any direct derivative class of PickupCarrier.
+            @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;
+            /**
+            @brief Get the parent of this PickupSpawner
+                   This method needs to be implemented by any direct derivative class of PickupCarrier.
+            @return Returns a pointer to the parent.
+            */
+            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;
         
         private:
-            std::set<Pickupable*> pickups_;
+            std::set<Pickupable*> pickups_; //!< The list of Pickupables carried by this PickupCarrier.
             
-        
     };
-    
 }