Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/dockingsystem2/src/orxonox/interfaces/PickupCarrier.cc @ 8403

Last change on this file since 8403 was 7547, checked in by dafrick, 14 years ago

Documenting and cleanup.

File size: 5.1 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file PickupCarrier.cc
31    @brief Implementation of the PickupCarrier class.
32*/
33
34#include "PickupCarrier.h"
35
36#include "core/CoreIncludes.h"
37#include "core/Identifier.h"
38
39#include "Pickupable.h"
40
41namespace orxonox {
42
43    /**
44    @brief
45        Constructor. Registers the object.
46    */
47    PickupCarrier::PickupCarrier()
48    {
49        RegisterRootObject(PickupCarrier);
50    }
51
52    /**
53    @brief
54        Destructor.
55    */
56    PickupCarrier::~PickupCarrier()
57    {
58
59    }
60
61    /**
62    @brief
63        Is called before the PickupCarrier is effectively destroyed.
64    */
65    void PickupCarrier::preDestroy(void)
66    {
67        std::set<Pickupable*>::iterator it = this->pickups_.begin();
68        std::set<Pickupable*>::iterator temp;
69        while(it != this->pickups_.end())
70        {
71            (*it)->carrierDestroyed();
72            temp = it;
73            it = this->pickups_.begin();
74            if(it == temp) // Infinite loop avoidance, in case the pickup wasn't removed from the carrier somewhere in the carrierDestroy() procedure.
75            {
76                COUT(2) << "Oops. In a PickupCarrier, while cleaning up, a Pickupable (&" << (*temp) << ") didn't unregister itself as it should have." << std::endl;;
77                it++;
78            }
79        }
80
81        this->pickups_.clear();
82    }
83
84    /**
85    @brief
86        Can be used to check whether the PickupCarrier or a child of his is a target ot the input Pickupable.
87    @param pickup
88        A pointer to the Pickupable.
89    @return
90        Returns true if the PickupCarrier or one of its children is a target, false if not.
91    */
92    bool PickupCarrier::isTarget(const Pickupable* pickup) const
93    {
94        if(pickup->isTarget(this)) // If the PickupCarrier itself is a target.
95            return true;
96
97        // Go recursively through all children to check whether they are a target.
98        std::vector<PickupCarrier*>* children = this->getCarrierChildren();
99        for(std::vector<PickupCarrier*>::const_iterator it = children->begin(); it != children->end(); it++)
100        {
101            if((*it)->isTarget(pickup))
102                return true;
103        }
104
105        children->clear();
106        delete children;
107
108        return false;
109    }
110
111    /**
112    @brief
113        Get the carrier that is both a child of the PickupCarrier (or the PickupCarrier itself) and a target of the input Pickupable.
114    @param pickup
115        A pounter to the Pickupable.
116    @return
117        Returns a pointer to the PickupCarrier that is the target of the input Pickupable.
118    */
119    PickupCarrier* PickupCarrier::getTarget(const Pickupable* pickup)
120    {
121        if(!this->isTarget(pickup))
122            return NULL;
123
124        if(pickup->isTarget(this)) // If the PickupCarrier itself is a target.
125            return this;
126
127        // Go recursively through all children to check whether they are the target.
128        std::vector<PickupCarrier*>* children = this->getCarrierChildren();
129        for(std::vector<PickupCarrier*>::iterator it = children->begin(); it != children->end(); it++)
130        {
131            if(pickup->isTarget(*it))
132                return *it;
133        }
134
135        children->clear();
136        delete children;
137
138        return NULL;
139    }
140
141    /**
142    @brief
143        Adds a Pickupable to the list of pickups that are carried by this PickupCarrier.
144    @param pickup
145        A pointer to the pickup to be added.
146    @return
147        Returns true if successfull, false if the Pickupable was already present.
148    */
149    bool PickupCarrier::addPickup(Pickupable* pickup)
150    {
151        COUT(4) << "Adding Pickupable (&" << pickup << ") to PickupCarrier (&" << this << ")" << std::endl;
152        return this->pickups_.insert(pickup).second;
153    }
154
155    /**
156    @brief
157        Removes a Pickupable from the list of pickups that are carried by this PickupCarrier.
158    @param pickup
159        A pointer to the pickup to be removed.
160    @return
161        Returns true if successfull, false if the Pickupable was not present in the list.
162    */
163    bool PickupCarrier::removePickup(Pickupable* pickup)
164    {
165        COUT(4) << "Removing Pickupable (&" << pickup << ") from PickupCarrier (&" << this << ")" << std::endl;
166        return this->pickups_.erase(pickup) == 1;
167    }
168
169}
Note: See TracBrowser for help on using the repository browser.