Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/PickupCollectionIdentifier.h @ 6886

Last change on this file since 6886 was 6538, checked in by dafrick, 15 years ago

Done some (almost final) documenting in pickup module.

File size: 2.4 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 PickupCollectionIdentifier.h
31    @brief Declaration of PickupCollectionIdentifier.
32*/
33
34#ifndef _PickupCollectionIdentifier_H__
35#define _PickupCollectionIdentifier_H_
36
37#include "PickupPrereqs.h"
38
39#include "pickup/PickupIdentifier.h"
40
41#include <set>
42
43namespace orxonox
44{
45
46    /**
47    @brief
48        The PickupCollectionIdentifier is the specialization of the PickupIdentifier for the PickupCollection class.
49        It identifies PickupCollections based on the different Pickupables they consist of.
50        Pickupables can be added to the PickupCollectionIdentifier via the addPickup method.
51    @author
52        Damian 'Mozork' Frick
53    */
54    class _PickupExport PickupCollectionIdentifier : public PickupIdentifier
55    {
56       
57        public:
58            PickupCollectionIdentifier(Pickupable* pickup); //!< Constructor.
59            ~PickupCollectionIdentifier(); //!< Destructor.
60           
61            virtual int compare(const PickupIdentifier* identifier) const; //!< Compares a PickupCollectionIdentifier with a PickupIdentifier.
62           
63            void addPickup(const PickupIdentifier* identifier); //!< Add a Pickupable to the PickupCollectionIdentifier.
64           
65        private:
66            std::set<const PickupIdentifier*, PickupIdentifierCompare> identifiers_; //!< The set of PickupIdentifiers of the Pickupables the PickupCollection with this PickupCollectionIdentifier consists of, ordered by the rule set by PickupIdentifierCompare.
67           
68    };
69   
70}
71
72#endif // _PickupCollectionIdentifier_H_
Note: See TracBrowser for help on using the repository browser.