Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/triggers/MultiTriggerContainer.h @ 8577

Last change on this file since 8577 was 7601, checked in by dafrick, 14 years ago

Adding all classes in modules/objects to Objects module (in doxygen).
Created TriggerBase which is the base class of Trigger and MultiTrigger and now provides the shared functionality and data.
Updated some of the documentation in MultiTrigger and Script.

  • Property svn:eol-style set to native
File size: 2.6 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 MultiTriggerContainer.h
31    @brief Definition of the MultiTriggerContainer class.
32    @ingroup MultiTrigger
33*/
34
35#ifndef _MultiTriggerContainer_H__
36#define _MultiTriggerContainer_H__
37
38#include "objects/ObjectsPrereqs.h"
39
40#include "core/BaseObject.h"
41
42#include "interfaces/PlayerTrigger.h"
43
44namespace orxonox
45{
46
47    /**
48    @brief
49        This class is used by the MultiTrigger class to transport additional data via @ref orxonox::Event "Events".
50
51    @author
52        Damian 'Mozork' Frick
53
54    @ingroup MultiTrigger
55    */
56    class _ObjectsExport MultiTriggerContainer : public BaseObject, public PlayerTrigger
57    {
58
59        public:
60            MultiTriggerContainer(BaseObject* creator); //!< Default constructor. Registers the object and creates an empty container.
61            MultiTriggerContainer(BaseObject* creator, MultiTrigger* originator, BaseObject* data); //!< Constructor. Registers the object and sets the input values.
62            virtual ~MultiTriggerContainer(); //!< Destructor.
63
64            /**
65            @brief Get the originator of the Event. (The MultiTrigger that fired the Event)
66            @return Returns a pointer to the originator.
67            */
68            inline MultiTrigger* getOriginator(void)
69                { return this->originator_; }
70            /**
71            @brief Get the data of this container.
72            @return Returns a pointer ot the data.
73            */
74            inline BaseObject* getData(void)
75                { return this->data_; }
76
77        private:
78            MultiTrigger* originator_; //!< The originator.
79            BaseObject* data_; //!< The data.
80
81    };
82
83}
84
85#endif // _MultiTriggerContainer_H__
Note: See TracBrowser for help on using the repository browser.