Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/interfaces/Pickupable.h @ 6774

Last change on this file since 6774 was 6731, checked in by dafrick, 15 years ago

PickupCollection is broken for now because to make it work drastic changes would have to be made. I wil fix it at a later date, though.

File size: 6.4 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/**
[6538]30    @file Pickupable.h
[6405]31    @brief Definition of the Pickupable class.
32*/
33
34#ifndef _Pickupable_H__
35#define _Pickupable_H__
36
37#include "OrxonoxPrereqs.h"
38
[6474]39#include <list>
[6405]40#include "core/Super.h"
41
[6474]42#include "core/OrxonoxClass.h"
43
[6405]44namespace orxonox
45{
46   
47    /**
48    @brief
[6474]49        An Interface (or more precisely an abstract class) to model and represent different (all kinds of) pickups.
[6405]50    @author
51        Damian 'Mozork' Frick
52    */
53    class _OrxonoxExport Pickupable : virtual public OrxonoxClass
54    {
[6540]55        protected:
56            Pickupable(); //!< Default constructor.
[6466]57       
[6405]58        public:
[6474]59            virtual ~Pickupable(); //!< Default destructor.
60           
[6405]61            /**
62            @brief Get whether the pickup is currently in use or not.
63            @return Returns true if the pickup is currently in use.
64            */
65            inline bool isUsed(void)
66                { return this->used_; }
[6474]67            /**
68            @brief  Should be called when the pickup has transited from used to unused or the other way around.
69                    Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedUsed); to their changdeUsed method.
70            */
71            virtual void changedUsed(void) {}
[6405]72           
[6474]73            /**
[6521]74            @brief Get the carrier of the pickup.
75            @return Returns a pointer to the carrier of the pickup.
76            */
77            inline PickupCarrier* getCarrier(void)
78                { return this->carrier_; }
79            /**
80            @brief Should be called when the pickup has changed its PickupCarrier.
81                   Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedCarrier); to their changedCarrier method.
82            */
83            virtual void changedCarrier(void) {}
84           
85            /**
[6474]86            @brief Returns whether the Pickupable is currently picked up.
87            @return Returns true if the Pickupable is currently picked up, false if not.
88            */
[6466]89            inline bool isPickedUp(void)
90                { return this->pickedUp_; }
[6521]91            /**
92            @brief  Should be called when the pickup has transited from picked up to dropped or the other way around.
93                    Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedPickedUp); to their changedPickedUp method.
94            */
[6523]95            virtual void changedPickedUp(void) {}
[6521]96           
[6474]97            bool pickedUp(PickupCarrier* carrier); //!< Sets the Pickupable to picked up.
98            bool dropped(void); //!< Sets the Pickupable to not picked up or dropped.
[6466]99           
[6731]100            virtual bool isTarget(const PickupCarrier* carrier) const; //!< Get whether the given PickupCarrier is a target of this pickup.
101            bool isTarget(const Identifier* identifier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this Pickupable.
[6474]102            bool addTarget(PickupCarrier* target); //!< Add a PickupCarrier as target of this pickup.
[6490]103            bool addTarget(Identifier* identifier); //!< Add a class, representetd by the input Identifier, as target of this pickup.
[6466]104           
[6474]105            Pickupable* clone(void); //!< Creates a duplicate of the Pickupable.
[6497]106            virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass.
[6466]107           
[6474]108            /**
109            @brief Get the PickupIdentifier of this Pickupable.
110            @return Returns a pointer to the PickupIdentifier of this Pickupable.
111            */
112            virtual const PickupIdentifier* getPickupIdentifier(void)
[6475]113                { return this->pickupIdentifier_; }
[6474]114               
[6521]115            bool setUsed(bool used); //!< Sets the Pickupable to used or unused, depending on the input.
116            bool setPickedUp(bool pickedUp); //!< Helper method to set the Pickupable to either picked up or not picked up.
117            bool setCarrier(PickupCarrier* carrier); //!< Sets the carrier of the pickup.
[6474]118           
[6466]119        protected:
[6474]120            /**
121            @brief Helper method to initialize the PickupIdentifier.
122            */
[6466]123            void initializeIdentifier(void) {}
124           
[6475]125            /**
126            @brief Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.
127                   This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
128                   DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position, float triggerDistance);
129            @param position The position at which the PickupSpawner should be placed.
130            @return Returns true if a spawner was created, false if not.
131            */
[6540]132            virtual bool createSpawner(void) = 0;
[6475]133           
134            PickupIdentifier* pickupIdentifier_; //!< The PickupIdentifier of this Pickupable.
[6466]135           
[6405]136        private:
137           
138            bool used_; //!< Whether the pickup is currently in use or not.
[6466]139            bool pickedUp_; //!< Whether the pickup is currently picked up or not.
[6405]140           
[6474]141            PickupCarrier* carrier_; //!< The carrier of the pickup.
[6405]142            std::list<Identifier*> targets_; //!< The possible targets of this pickup.
143
144    };
145   
[6466]146    SUPER_FUNCTION(10, Pickupable, changedUsed, false);
147    SUPER_FUNCTION(12, Pickupable, changedCarrier, false);
[6521]148    SUPER_FUNCTION(13, Pickupable, changedPickedUp, false);
[6405]149}
150
151#endif /* _Pickupable_H__ */
Note: See TracBrowser for help on using the repository browser.