Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/docking/DockingAnimation.h @ 9667

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

merged core6 back to trunk

  • Property svn:eol-style set to native
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 *      Sven Stucki
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file DockingAnimation.h
31    @brief Definition of the DockingAnimation class.
32    @ingroup Docking
33*/
34
35#ifndef _DockingAnimation_H__
36#define _DockingAnimation_H__
37
38#include "core/XMLPort.h"
39
40#include "infos/PlayerInfo.h"
41
42#include "DockingPrereqs.h"
43#include "DockingTarget.h"
44#include "Dock.h"
45
46
47#include <list>
48#include "core/BaseObject.h"
49
50namespace orxonox
51{
52
53    /**
54    @brief
55        Base class for docking animations used by @ref orxonox::Docking "Docks".
56
57    @author
58        Sven Stucki
59
60    @ingroup Docking
61    */
62    class _DockingExport DockingAnimation : public BaseObject
63    {
64        public:
65            DockingAnimation(Context* context);
66            virtual ~DockingAnimation();
67
68            virtual bool docking(PlayerInfo* player) = 0; //!< Called when a player starts docking
69            virtual bool release(PlayerInfo* player) = 0; //!< Called when player wants to undock
70
71            static bool invokeAnimation(bool dock, PlayerInfo* player, std::list<DockingAnimation*> &animations); //!< Invokes calls the docking or release method of all list entries
72            static DockingTarget *findTarget(std::string name); //!< Iterates through all DockingTarget objects to find the one with name=target
73
74            void setParent(Dock *parent) { this->parent_ = parent; }
75
76        protected:
77            Dock *parent_;
78            std::set<PlayerInfo*> animations_; //!< Contains a list of currently running animations
79    };
80
81}
82
83#endif /* _DockingAnimation_H__ */
Note: See TracBrowser for help on using the repository browser.