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

Timestamp:

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

Author:

rgrieder

Message:

Merged pickup branch revisions to pickup2.

File:

• code/branches/pickup2/src/orxonox/pickup/PickupInventory.cc (modified) (17 diffs)

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

@@ -52 +52 @@
 
     PickupInventory* PickupInventory::pickupInventory_s = NULL;
+
+    //TODO: Comment.
+
+    /**
+    @brief
+        Get a Pointer to the PickupInventory Singleton.
+    @return
+        A Pointer to the PickupInventory.
+    */
+    //TODO: Make SingeltonPtr?
     PickupInventory* PickupInventory::getSingleton()
     {
@@ -60 +70 @@
     }
 
+    /**
+    @brief
+        Constructor. 
+    */
     PickupInventory::PickupInventory()
     {
-        this->bInventoryVisible_ = false;
-        this->visibleEquipmentWindows_ = this->visibleUsableWIndows_ = 0;
+        //TODO: Maybe some abstraction for the usableWindows, e.g. push and pop...
+        //RegisterObject() ? In some other Class, too. Which?
+        this->bInventoryVisible_ = false; //TODO: If OrxonoxClass, this should already be there...
+        this->visibleEquipmentWindows_ = this->visibleUsableWindows_ = 0;
 
         // Create some windows to avoid creating them while playing
@@ -77 +93 @@
         this->createdEquipmentWindows_ = this->createdUsableWindows_ = 10;
     }
+
+    /**
+    @brief
+        Destructor.
+    */
+    //TODO: Destroy something?
     PickupInventory::~PickupInventory()
     {
     }
 
-
-
-    void PickupInventory::toggleInventory()
+    /**
+    @brief
+        Toggles the visibility of the inventory.
+    */
+    /*static*/ void PickupInventory::toggleInventory()
     {
         if(PickupInventory::getSingleton()->isVisible()) {
@@ -99 +123 @@
     }
 
+    /**
+    @brief
+        
+    */
     unsigned int PickupInventory::getCurrentUsableIndex()
     {
@@ -115 +143 @@
         return 0;
     }
+
     bool PickupInventory::isCurrentUsable(const BaseItem* item)
     {
@@ -123 +152 @@
             return false;
     }
+
     void PickupInventory::selectUsable(unsigned int i)
     {
@@ -142 +172 @@
             return 0;
     }
+
     unsigned int PickupInventory::getUsableCount()
     {
@@ -150 +181 @@
             return 0;
     }
+
     unsigned int PickupInventory::getPassiveCount()
     {
@@ -158 +190 @@
             return 0;
     }
+
     BaseItem* PickupInventory::getEquipmentItem(unsigned int i)
     {
@@ -170 +203 @@
             return NULL;
     }
+
     BaseItem* PickupInventory::getUsableItem(unsigned int i)
     {
@@ -182 +216 @@
             return NULL;
     }
+
     BaseItem* PickupInventory::getPassiveItem(unsigned int i)
     {
@@ -225 +260 @@
             equipPane->removeChildWindow("orxonox/Inventory/Items/equ/" + id.str());*/
         }
-        for(unsigned int i = 0; i < this->visibleUsableWIndows_; i++)
+        for(unsigned int i = 0; i < this->visibleUsableWindows_; i++)
         {
             std::ostringstream id;
@@ -239 +274 @@
         }
     }
+
     void PickupInventory::updateTabs(CEGUI::WindowManager *winMgr, CEGUI::Window *equipWindow, CEGUI::Window *usableWindow)
     {
@@ -269 +305 @@
         }
     }
+
     void PickupInventory::updateUsable(CEGUI::WindowManager* winMgr, CEGUI::Window* target)
     {
@@ -296 +333 @@
                 PickupInventory::setWindowProperties(winMgr, target, id.str(), item, colour);
             }
-            this->visibleUsableWIndows_ = items.size();
+            this->visibleUsableWindows_ = items.size();
         }
     }
@@ -326 +363 @@
         btn->setVisible(false);
     }
+
     void PickupInventory::setWindowProperties(CEGUI::WindowManager* winMgr, CEGUI::Window* target, const std::string& id, const BaseItem* item, const std::string& textColour)
     {
@@ -350 +388 @@
         target->addChildWindow(btn);
     }
+
 }