Changeset 6519 for code/branches/pickup3/src

Timestamp:

Mar 13, 2010, 3:32:34 PM (15 years ago)

Author:

dafrick

Message:

Started documenting MetaPcikup, resolved some bugs in PickupCollection and PickupCollectionIdentifier.

Location:

code/branches/pickup3/src

Files:

• modules/pickup/PickupCollection.cc (modified) (4 diffs)
• modules/pickup/PickupCollection.h (modified) (2 diffs)
• modules/pickup/PickupCollectionIdentifier.cc (modified) (1 diff)
• modules/pickup/PickupCollectionIdentifier.h (modified) (1 diff)
• modules/pickup/items/MetaPickup.cc (modified) (2 diffs)
• modules/pickup/items/MetaPickup.h (modified) (3 diffs)
• orxonox/interfaces/Pickupable.h (modified) (1 diff)

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

@@ -45 +45 @@
 {
  
+    CreateFactory(PickupCollection);
+
     /**
     @brief
@@ -77 +79 @@
         SUPER(PickupCollection, XMLPort, xmlelement, mode);
         
-        //TODO: Does this work? Problem could be, that Pickupable itself cannot be instantiated through XML, doubt that, though.
-        XMLPortObject(PickupCollection, PickupCollection, "pickupables", addPickupable, getPickupable, xmlelement, mode);
+        XMLPortObject(PickupCollection, Pickupable, "pickupables", addPickupable, getPickupable, xmlelement, mode);
         
         this->initializeIdentifier();
@@ -103 +104 @@
     bool PickupCollection::createSpawner(const Vector3& position)
     {
-        DroppedPickup::DroppedPickup(this, this, position);
+        new DroppedPickup(this, this, position);
         return true;
     }
@@ -178 +179 @@
     }
     
+    bool PickupCollection::isTarget(Identifier* identifier) const
+    {
+        for(std::vector<Pickupable*>::const_iterator it = this->pickups_.begin(); it != this->pickups_.end(); it++)
+        {
+            if(!(*it)->isTarget(identifier))
+                return false;
+        }
+        
+        return true;
+    }
+    
     const PickupIdentifier* PickupCollection::getPickupIdentifier(void)
     {

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

@@ -47 +47 @@
         Damian 'Mozork' Frick
     */
-    //TODO: Isn't private inheritance sufficient?
     class _PickupExport PickupCollection : public Pickupable, public BaseObject
     {
@@ -63 +62 @@
             
             virtual void clone(OrxonoxClass*& item);
+            
+            virtual bool isTarget(Identifier* identifier) const;
             
             virtual const PickupIdentifier* getPickupIdentifier(void);

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

@@ -50 +50 @@
         if(collectionIdentifier == NULL)
         {
-            return this->compare(identifier);
+            return this->PickupIdentifier::compare(identifier);
         }
         

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

@@ -38 +38 @@
 {
 
-    class PickupCollectionIdentifier : public PickupIdentifier
+    class _PickupExport PickupCollectionIdentifier : public PickupIdentifier
     {
         

code/branches/pickup3/src/modules/pickup/items/MetaPickup.cc

@@ -27 +27 @@
 */
 
+/**
+    @file
+    @brief Implementation of the MetaPickup class.
+*/
+
 #include "core/CoreIncludes.h"
 #include "core/XMLPort.h"
@@ -42 +47 @@
     /*static*/ const std::string MetaPickup::metaTypeDrop_s = "drop";
     
+    /**
+    @brief
+        Constructor. 
+    */
     MetaPickup::MetaPickup(BaseObject* creator) : Pickup(creator)
     {

code/branches/pickup3/src/modules/pickup/items/MetaPickup.h

@@ -27 +27 @@
 */
 
+/**
+    @file
+    @brief Definition of the MetaPickup class.
+*/
+
 #ifndef _MetaPickup_H__
 #define _MetaPickup_H__
@@ -36 +41 @@
 namespace orxonox {
 
+    //! The meta type, deciding what the pickup does exactly.
     namespace pickupMetaType
     {
@@ -46 +52 @@
     }
     
+    /**
+    @brief
+        The MetaPickup is a pickup that can, depending on the parameters, either drop all pickups of the PickupCarrier that picks it up, or use all the unused pickups of the PickupCarrier, that picks it up. The parameter to set for this is the metaType and it can be used with the values 'none', 'drop' and 'use'.
+    @author
+        Damian 'Mozork' Frick
+    */
     class _PickupExport MetaPickup : public Pickup
     {
-        friend class PickupCarrier;
         
         public:

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

@@ -83 +83 @@
             
             bool isTarget(const PickupCarrier* carrier) const; //!< Get whether the given PickupCarrier is a target of this pickup.
-            bool isTarget(Identifier* identifier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this pickup.
+            virtual bool isTarget(Identifier* identifier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this pickup.
             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.