Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/interfaces/PickupCarrier.h @ 7219

Last change on this file since 7219 was 7163, checked in by dafrick, 14 years ago

Merged presentation3 branch into trunk.

  • Property svn:eol-style set to native
File size: 7.0 KB
RevLine 
[6405]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/**
[6540]30    @file PickupCarrier.h
[6405]31    @brief Definition of the PickupCarrier class.
32*/
33
34#ifndef _PickupCarrier_H__
35#define _PickupCarrier_H__
36
37#include "OrxonoxPrereqs.h"
38
[6474]39#include <list>
[6405]40#include <set>
[6474]41#include "Pickupable.h"
[6512]42#include "core/Identifier.h"
[6533]43#include "core/WeakPtr.h"
[6405]44
[6474]45#include "core/OrxonoxClass.h"
46
[7163]47namespace orxonox
48{
[6521]49
[6710]50    //! Forward-declarations.
[6711]51    class PickupManager;
[6710]52    class Pickup;
53    class HealthPickup;
54    class InvisiblePickup;
55    class MetaPickup;
[7163]56    class DronePickup;
[6710]57    class SpeedPickup;
58
[6474]59    /**
60    @brief
61        The PickupCarrier interface provides the means, for any class implementing it, to possess Pickupables.
62    @author
63        Damian 'Mozork' Frick
64    */
[7163]65    class _OrxonoxExport PickupCarrier : virtual public OrxonoxClass
66    {
[6563]67        //! So that the different Pickupables have full access to their PickupCarrier.
[6711]68        friend class Pickupable;
69        friend class PickupManager;
[7163]70        //! Friends.
[6512]71        friend class Pickup;
72        friend class HealthPickup;
[6710]73        friend class InvisiblePickup;
74        friend class MetaPickup;
[7163]75        friend class DronePickup;
[6709]76        friend class SpeedPickup;
77
[6405]78        public:
[6474]79            PickupCarrier(); //!< Constructor.
80            virtual ~PickupCarrier(); //!< Destructor.
[7163]81            void preDestroy(void);
[6709]82
[6474]83            /**
[6475]84            @brief Can be used to check whether the PickupCarrier or a child of his is a target ot the input Pickupable.
85            @param pickup A pointer to the Pickupable.
86            @return Returns true if the PickupCarrier or one of its children is a target, false if not.
87            */
88            bool isTarget(const Pickupable* pickup)
[6466]89                {
[6475]90                    if(pickup->isTarget(this)) //!< If the PickupCarrier itself is a target.
[6466]91                        return true;
[6709]92
[6475]93                    //! Go recursively through all children to check whether they are a target.
[6711]94                    std::vector<PickupCarrier*>* children = this->getCarrierChildren();
95                    for(std::vector<PickupCarrier*>::const_iterator it = children->begin(); it != children->end(); it++)
[6466]96                    {
97                        if((*it)->isTarget(pickup))
98                            return true;
99                    }
[6709]100
[6475]101                    children->clear();
102                    delete children;
[6709]103
[6466]104                    return false;
105                }
[6709]106
[6475]107            /**
108            @brief Get the carrier that is both a child of the PickupCarrier (or the PickupCarrier itself) and a target of the input Pickupable.
109            @param pickup A pounter to the Pickupable.
110            @return Returns a pointer to the PickupCarrier that is the target of the input Pickupable.
111            */
112            PickupCarrier* getTarget(const Pickupable* pickup)
113                {
114                    if(!this->isTarget(pickup))
115                        return NULL;
[6709]116
[6475]117                    if(pickup->isTarget(this)) //!< If the PickupCarrier itself is a target.
118                        return this;
[6709]119
[6475]120                    //! Go recursively through all children to check whether they are the target.
[6711]121                    std::vector<PickupCarrier*>* children = this->getCarrierChildren();
122                    for(std::vector<PickupCarrier*>::iterator it = children->begin(); it != children->end(); it++)
[6475]123                    {
124                        if(pickup->isTarget(*it))
125                            return *it;
126                    }
[6709]127
[6475]128                    children->clear();
129                    delete children;
[6709]130
[6475]131                    return NULL;
132                }
[6709]133
[6540]134            /**
135            @brief Get the (absolute) position of the PickupCarrier.
136                   This method needs to be implemented by any direct derivative class of PickupCarrier.
137            @return Returns the position as a Vector3.
138            */
139            virtual const Vector3& getCarrierPosition(void) = 0;
[7163]140
141        protected:
[6475]142            /**
143            @brief Get all direct children of this PickupSpawner.
144                   This method needs to be implemented by any direct derivative class of PickupCarrier.
[6540]145                   The returned list will be deleted by the methods calling this function.
[6709]146            @return Returns a pointer to a list of all direct children.
[6475]147            */
[6711]148            virtual std::vector<PickupCarrier*>* getCarrierChildren(void) = 0;
[6475]149            /**
150            @brief Get the parent of this PickupSpawner
151                   This method needs to be implemented by any direct derivative class of PickupCarrier.
152            @return Returns a pointer to the parent.
153            */
154            virtual PickupCarrier* getCarrierParent(void) = 0;
[6709]155
[6521]156            /**
157            @brief Get all Pickupables this PickupCarrier has.
158            @return  Returns the set of all Pickupables this PickupCarrier has.
159            */
[6512]160            std::set<Pickupable*>& getPickups(void)
161                { return this->pickups_; }
[7163]162
[6405]163        private:
[6475]164            std::set<Pickupable*> pickups_; //!< The list of Pickupables carried by this PickupCarrier.
[7163]165
[6711]166            /**
[7163]167            @brief Adds a Pickupable to the list of pickups that are carried by this PickupCarrier.
168            @param pickup A pointer to the pickup to be added.
169            @return Returns true if successfull, false if the Pickupable was already present.
[6711]170            */
[7163]171            bool addPickup(Pickupable* pickup)
[6711]172                {
[7163]173                    COUT(4) << "Adding Pickupable (&" << pickup << ") to PickupCarrier (&" << this << ")" << std::endl;
174                    return this->pickups_.insert(pickup).second;
[6711]175                }
[7163]176
[6711]177            /**
[7163]178            @brief Removes a Pickupable from the list of pickups that are carried by thsi PickupCarrier.
179            @param pickup A pointer to the pickup to be removed.
180            @return Returns true if successfull, false if the Pickupable was not present in the list.
[6711]181            */
[7163]182            bool removePickup(Pickupable* pickup)
[6711]183                {
[7163]184                    COUT(4) << "Removing Pickupable (&" << pickup << ") from PickupCarrier (&" << this << ")" << std::endl;
185                    return this->pickups_.erase(pickup) == 1;
[6711]186                }
[6709]187
[7163]188    };
189}
190
[6405]191#endif /* _PickupCarrier_H__ */
Note: See TracBrowser for help on using the repository browser.