[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 | |
---|
[6538] | 29 | /** |
---|
| 30 | @file PickupCollection.h |
---|
| 31 | @brief Declaration of PickupCollection. |
---|
[7456] | 32 | @ingroup Pickup |
---|
[6538] | 33 | */ |
---|
| 34 | |
---|
[6405] | 35 | #ifndef _PickupCollection_H__ |
---|
| 36 | #define _PickupCollection_H__ |
---|
| 37 | |
---|
[6466] | 38 | #include "PickupPrereqs.h" |
---|
[6405] | 39 | |
---|
| 40 | #include "core/BaseObject.h" |
---|
[7163] | 41 | #include "CollectiblePickup.h" |
---|
[6405] | 42 | |
---|
| 43 | #include <list> |
---|
| 44 | |
---|
| 45 | namespace orxonox |
---|
| 46 | { |
---|
| 47 | |
---|
| 48 | /** |
---|
| 49 | @brief |
---|
[7163] | 50 | The PickupCollection combines different Pickupables to a coherent, single pickup and makes them seem (from the outside looking in) just as if they were just one Pickupable. |
---|
[6405] | 51 | @author |
---|
| 52 | Damian 'Mozork' Frick |
---|
| 53 | */ |
---|
[7163] | 54 | class _PickupExport PickupCollection : public CollectiblePickup, public BaseObject |
---|
[6405] | 55 | { |
---|
[7163] | 56 | |
---|
[6405] | 57 | public: |
---|
[6538] | 58 | PickupCollection(BaseObject* creator); //!< Default Constructor. |
---|
| 59 | virtual ~PickupCollection(); //!< Destructor. |
---|
[7163] | 60 | |
---|
[6538] | 61 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Creates an instance of this Class through XML. |
---|
[6405] | 62 | |
---|
[6538] | 63 | virtual void changedUsed(void); //!< Is called when the pickup has transited from used to unused or the other way around. |
---|
| 64 | virtual void changedCarrier(void); //!< Is called when the pickup has changed its PickupCarrier. |
---|
| 65 | virtual void changedPickedUp(void); //!< Is called when the pickup has transited from picked up to dropped or the other way around. |
---|
[7163] | 66 | |
---|
[6538] | 67 | virtual void clone(OrxonoxClass*& item); //!< Creates a duplicate of the input OrxonoxClass. |
---|
[7163] | 68 | |
---|
[6731] | 69 | virtual bool isTarget(PickupCarrier* carrier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this PickupCollection. |
---|
[7163] | 70 | |
---|
[6538] | 71 | virtual const PickupIdentifier* getPickupIdentifier(void); //!< Get the PickupIdentifier of this PickupCollection. |
---|
[7163] | 72 | |
---|
| 73 | bool addPickupable(CollectiblePickup* pickup); //!< Add the input Pickupable to list of Pickupables combined by this PickupCollection. |
---|
[6538] | 74 | const Pickupable* getPickupable(unsigned int index); //!< Get the Pickupable at the given index. |
---|
[7163] | 75 | |
---|
| 76 | void pickupChangedUsed(bool changed); //!< Informs the PickupCollection, that one of its pickups has changed its used status to the input value. |
---|
| 77 | void pickupChangedPickedUp(bool changed); //!< Informs the PickupCollection, that one of its pickups has changed its picked up status to the input value. |
---|
| 78 | void pickupDisabled(void); //!< Informs the PickupCollection, that one of its pickups has been disabled. |
---|
| 79 | |
---|
[6466] | 80 | protected: |
---|
[6538] | 81 | void initializeIdentifier(void); //!< Initializes the PickupIdentifier for this pickup. |
---|
[7163] | 82 | |
---|
[6540] | 83 | virtual bool createSpawner(void); //!< Facilitates the creation of a PickupSpawner upon dropping of the Pickupable. |
---|
[7163] | 84 | |
---|
[6538] | 85 | PickupCollectionIdentifier* pickupCollectionIdentifier_; //!< The PickupCollectionIdentifier of this PickupCollection. Is used to distinguish different PickupCollections amongst themselves. |
---|
[7163] | 86 | |
---|
[6405] | 87 | private: |
---|
[7163] | 88 | void changedUsedAction(void); //!< Helper method. |
---|
| 89 | void changedPickedUpAction(void); //!< Helper method. |
---|
[6405] | 90 | |
---|
[7163] | 91 | std::vector<CollectiblePickup*> pickups_; //!< The list of the pointers of all the Pickupables this PickupCollection consists of. They are weak pointers to facilitate testing, whether the pointers are still valid. |
---|
| 92 | |
---|
| 93 | unsigned int usedCounter_; //!< Keeps track of the number of pickups of this PickupCollection, that are in use. |
---|
| 94 | unsigned int pickedUpCounter_; //!< Keeps track of the number of pickups of this PickupCollection, that are picked up. |
---|
| 95 | unsigned int disabledCounter_; //!< Keeps track of the number of pickups of this PickupCollection, that are disabled. |
---|
| 96 | |
---|
| 97 | bool processingUsed_; //!< Boolean to ensure, that the PickupCollection doesn't update its used status while its internal state is inconsistent. |
---|
| 98 | bool processingPickedUp_; //!< Boolean to ensure, that the PickupCollection doesn't update its picked upp status while its internal state is inconsistent. |
---|
| 99 | |
---|
[6405] | 100 | }; |
---|
[7163] | 101 | |
---|
[6405] | 102 | } |
---|
| 103 | |
---|
| 104 | #endif /* _PickupCollection_H__ */ |
---|