Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/CollectiblePickup.h @ 7275

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

Merged presentation3 branch into trunk.

File size: 3.0 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 CollectiblePickup.h
31    @brief Definition of the CollectiblePickup class.
32*/
33
34#ifndef _CollectiblePickup_H__
35#define _CollectiblePickup_H__
36
37#include "pickup/PickupPrereqs.h"
38
39#include "interfaces/Pickupable.h"
40
41namespace orxonox {
42
43    /**
44    @brief
45        Collectible Pickup class. Any pickup inheriting from this class can be added to a PickupCollection and thus be part uf such.
46    @author
47        Damian 'Mozork' Frick
48    */
49    class _PickupExport CollectiblePickup : public Pickupable
50    {
51
52        public:
53            CollectiblePickup(); //!< Constructor.
54            virtual ~CollectiblePickup(); //! Destructor.
55
56            virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around.
57            virtual void changedPickedUp(void); //!< Is called when the pickup has transited from picked up to dropped or the other way around.
58
59            /**
60            @brief Check whether the given CollectiblePickup is par of a PickupCollection.
61            @return Returns true if the ColelctiblePickup is part of a PickupCollection.
62            */
63            bool isInCollection(void)
64                { return this->isInCollection_; }
65           
66            bool addToCollection(PickupCollection* collection); //!< Adds this CollectiblePickup to the input PickupCollection.
67            bool removeFromCollection(void); //!< Removes this CollectiblePickup from its PickupCollection.
68
69            void carrierDestroyed(void); //!< Is called by the PickupCarrier when it is being destroyed.
70
71        protected:
72            virtual void preDestroy(void); //!< Is called by OrxonoxClass::destroy() before the object is actually destroyed.
73            virtual void destroyPickup(void); //!< //!< Destroys a Pickupable.
74
75        private:
76            bool isInCollection_; //!< True if the CollectiblePickup is in a PickupCollection.
77            PickupCollection* collection_; //!< A pointer to the PickupCollection this CollectiblePickup is in.
78
79    };
80}
81
82#endif // _CollectiblePickup_H__
Note: See TracBrowser for help on using the repository browser.