Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 7131 was 6856, checked in by dafrick, 15 years ago

Documented and simplified MultiTriggerContainer.

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