Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 9330 was 8706, checked in by dafrick, 13 years ago

Merging presentation branch back into trunk.
There are many new features and also a lot of other changes and bugfixes, if you want to know, digg through the svn log.
Not everything is yet working as it should, but it should be fairly stable. If you habe any bug reports, just send me an email.

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