Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/Pickup.h @ 11654

Last change on this file since 11654 was 11071, checked in by landauf, 9 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 7.8 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 Pickup.h
31    @brief Declaration of the Pickup class.
32    @ingroup Pickup
33*/
34
35#ifndef _Pickup_H__
36#define _Pickup_H__
37
38#include "pickup/PickupPrereqs.h"
39
40#include "core/BaseObject.h"
41#include "core/XMLPort.h"
42#include "tools/Timer.h"
43
44#include "CollectiblePickup.h"
45
46namespace orxonox
47{
48
49    /**
50    @brief
51        Enum for the @ref orxonox::Pickup "Pickup" activation type.
52
53    @ingroup Pickup
54    */
55    enum class PickupActivationType
56    {
57        immediate, //!< Means that the @ref orxonox::Pickup "Pickup" will be used immediately after pickup.
58        onUse, //!< Means that the @ref orxonox::Pickup "Pickup" will be used at a later point trough some external influence.
59    };
60
61    /**
62    @brief
63        Enum for the @ref orxonox::Pickup "Pickup" duration type.
64
65    @ingroup Pickup
66    */
67    enum class PickupDurationType
68    {
69        once, //!< Means that the @ref orxonox::Pickup "Pickup" will be used only once at a singular time instant.
70        continuous, //!< Means that the @ref orxonox::Pickup "Pickup" will be used over a continuous timespan.
71    };
72
73    /**
74    @brief
75        The Pickup class offers (useful) base functionality for a wide range of pickups.
76
77        Pickups inheriting from this class can choose an activation type and a duration type.
78        - The <b>activationType</b> deals with what happens to the Pickup as soon as it is picked up. It can either be set to <em>immediate</em>, which means that the Pickup is activated/used immediately upon being picked up. Or to <em>onUse</em>, which means, that the Pickup will be activated/used if some outside entity (most commonly the player through the PickupInventory) decides to use it. Default is <em>immediate</em>.
79        - The <b>durationType</b> deals with whether the Pickup has a continuous effect or whether its effect is focused on a singular instant. It can either be set to <em>once</em>, which means, that the Pickup just has an effect (at a singular instant in time) and is done once that effect has been applied. Or to <em>continuous</em>, which means that the effect of the Pickup unfolds over some timespan. Default is <em>once</em>.
80
81        If it were not an abstract class it could for example be used as follows in XML.
82        @code
83        <Pickup activationType="onUse" durationType="continuous" />
84        @endcode
85        In reality you can (naturally) use the parameters <b>activation type</b> and <b>duration type</b> in any pickup inheriting from Pickup, unless the pickup already specifies one (or both) of the parameters.
86
87    @author
88        Damian 'Mozork' Frick
89
90    @ingroup Pickup
91    */
92    class _PickupExport Pickup : public CollectiblePickup, public BaseObject
93    {
94
95        public:
96            Pickup(Context* context); //!< Constructor.
97            virtual ~Pickup(); //!< Destructor.
98
99            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override;
100
101            virtual const std::string& getRepresentationName() const override
102                { return this->representationName_; }
103
104            /**
105            @brief Get the activation type of the Pickup.
106            @return Returns the activation type of the Pickup.
107            */
108            inline PickupActivationType getActivationType(void) const
109                { return this->activationType_; }
110            /**
111            @brief Get the duration type of the Pickup.
112            @return Returns the duration type of the Pickup.
113            */
114            inline PickupDurationType getDurationType(void) const
115                { return this->durationType_; }
116
117            const std::string& getActivationTypeAsString(void) const; //!< Get the activation type of the Pickup.
118            const std::string& getDurationTypeAsString(void) const; //!< Get the duration type of the Pickup.
119
120            /**
121            @brief Get whether the activation type is 'immediate'.
122            @return Returns true if the activation type is 'immediate'.
123            */
124            inline bool isImmediate(void) const
125                { return this->getActivationType() == PickupActivationType::immediate; }
126            /**
127            @brief Get whether the activation type is 'onUse'.
128            @return Returns true if the activation type is 'onUse'.
129            */
130            inline bool isOnUse(void) const
131                { return this->getActivationType() == PickupActivationType::onUse; }
132            /**
133            @brief Get whether the duration type is 'once'.
134            @return Returns true if the duration type is 'once'.
135            */
136            inline bool isOnce(void) const
137                { return this->getDurationType() == PickupDurationType::once; }
138            /**
139            @brief Get whether the duration type is 'continuous'.
140            @return Returns true if the duration type is 'continuous'.
141            */
142            inline bool isContinuous(void) const
143                { return this->getDurationType() == PickupDurationType::continuous; }
144
145            virtual void changedPickedUp(void) override; //!< Should be called when the pickup has transited from picked up to dropped or the other way around.
146
147        protected:
148            virtual bool createSpawner(void) override; //!< Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.
149
150            /**
151            @brief Sets the representation name which refers to the name of the PickupRepresentation that is used to represent this pickup.
152            */
153            inline void setRepresentationName(const std::string& name)
154                { this->representationName_ = name; }
155
156            /**
157            @brief Set the activation type of the Pickup.
158            @param type The activation type of the Pickup.
159            */
160            inline void setActivationType(PickupActivationType type)
161                { this->activationType_ = type; }
162            /**
163            @brief Set the duration type of the Pickup.
164            @param type The duration type of the Pickup.
165            */
166            inline void setDurationType(PickupDurationType type)
167                { this->durationType_ = type; }
168
169            void setActivationTypeAsString(const std::string& type); //!< Set the activation type of the Pickup.
170            void setDurationTypeAsString(const std::string& type); //!< Set the duration type of the Pickup.
171
172        private:
173            void initialize(void); //!< Initializes the member variables.
174
175            std::string representationName_; //!< The name of the associated PickupRepresentation.
176            PickupActivationType activationType_; //!< The activation type of the Pickup.
177            PickupDurationType durationType_; //!< The duration type of the Pickup.
178
179            //! Strings for the activation and duration types.
180            static const std::string activationTypeImmediate_s;
181            static const std::string activationTypeOnUse_s;
182            static const std::string durationTypeOnce_s;
183            static const std::string durationTypeContinuous_s;
184    };
185
186}
187#endif // _Pickup_H__
Note: See TracBrowser for help on using the repository browser.