Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/items/ShrinkPickup.h @ 11477

Last change on this file since 11477 was 9667, checked in by landauf, 11 years ago

merged core6 back to trunk

  • Property svn:eol-style set to native
File size: 4.2 KB
RevLine 
[8489]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:
[8713]23 *      Sandro Sgier
[8489]24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file ShrinkPickup.h
31    @brief Declaration of the ShrinkPickup class.
32    @ingroup PickupItems
33*/
34
35
[8375]36#ifndef _ShrinkPickup_H__
37#define _ShrinkPickup_H__
38
39#include "pickup/PickupPrereqs.h"
40
41#include <string>
[8381]42#include <vector>
[8375]43
44#include "pickup/Pickup.h"
45#include "tools/interfaces/Tickable.h"
46
47namespace orxonox {
48
49    /**
[8536]50    @brief
51        The ShrinkPickup is a Pickupable that causes the pawn to shrink to a certain size for a certain time with a certain speed, all of them specified in the following variables:
52        - The @b shrinkFactor It determines how much the ship is going to shrink (e.g. the factor 2 would make the ship shrinking to half its size).
[8713]53        - The @b duration Specifies how long the ship will stay small.
54        - The @b shrinkDuration Defines how fast the ship shrinks and grows in seconds.
[8536]55
[8713]56        An example of a XML implementation of a ShrinkPickup would be:
[8536]57        @code
[8713]58        <ShrinkPickup
[8536]59            shrinkFactor = "5.0"
60            duration = "5.0"
61            shrinkSpeed = "5.0"
62        />
63        @endcode
64
65    @author
66        Sandro Sgier
67
68    @ingroup PickupItems
69    */
70
[8375]71    class _PickupExport ShrinkPickup : public Pickup, public Tickable
72    {
73        public:
[9667]74            ShrinkPickup(Context* context); // Constructor.
[8713]75            virtual ~ShrinkPickup(); // Destructor.
76
[8534]77            virtual void XMLPort(Element& xmlelement, orxonox::XMLPort::Mode mode);
[8713]78            virtual void tick(float dt);
79
80            virtual void changedUsed(void); // Is called when the pickup has transited from used to unused or the other way around.
81            virtual void changedPickedUp(void);
82
83            /**
84            @brief Get the shrinking factor.
85            @return Returns the shrinking factor,
86            */
[8534]87            inline float getShrinkFactor(void) const
88                { return this->shrinkFactor_; }
[9348]89            void setShrinkFactor(float factor);
90
[8713]91            /**
92            @brief Get the duration for which the ship remains shrunken.
93            @return Returns the duration.
94            */
[8534]95            inline float getDuration(void) const
96                { return this->duration_; }
[9348]97            void setDuration(float duration);
98
[8713]99            /**
100            @brief Get the shrink speed.
101            @return Returns the shrink speed.
102            */
103            inline float getShrinkDuration(void) const
104                { return this->shrinkDuration_; }
[9348]105            void setShrinkDuration(float speed);
[8375]106
107        private:
108            void initialize(void);
[8713]109
110            float duration_;            //!< Determines how long the pickup will be active
111            float shrinkFactor_;        //!< Shrink factor of the space ship
112            float shrinkDuration_;      //!< Duration of shrinking
113
114            bool isActive_;             //!< True if ship is shrinking, small, or growing back.
115            bool isShrinking_;          //!< True if ship is shrinking
116            bool isTerminating_;        //!< True if ship is growing back to the original size
117
118            float currentFactor_;       //!< The shrink factor that is currently applied.
119            float timeRemainig_;        //!< The remaining shrink time.
[9348]120
[8534]121            Pawn* carrierToPawnHelper(void);
[8554]122            Timer durationTimer_;
[8534]123            void terminate(void);
[8375]124    };
125}
126
[8502]127#endif
Note: See TracBrowser for help on using the repository browser.