Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/Event.h @ 10095

Last change on this file since 10095 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 3.9 KB
RevLine 
[2063]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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
[7401]29/**
30    @defgroup Event Events
31    @ingroup Core
32*/
33
34/**
35    @file
36    @ingroup Event
37    @brief Declaration of the classes Event and EventState.
38*/
39
[2063]40#ifndef _Event_H__
41#define _Event_H__
42
43#include "CorePrereqs.h"
[3196]44#include <string>
[2063]45
46namespace orxonox
47{
[5929]48    /**
49        @brief The Event struct contains information about a fired Event.
50    */
[2063]51    struct _CoreExport Event
52    {
[5929]53        Event(bool activate, BaseObject* originator, const std::string& name) : activate_(activate), originator_(originator), name_(name) {}
[2063]54
[5929]55        bool        activate_;   //!< True if this is an activating event (the event source was inactive before and just triggered the event) - false otherwise
56        std::string statename_;  //!< The name of the state this event affects
57        BaseObject* originator_; //!< The object which triggered this event
58        std::string name_;       //!< The name of this event
[6800]59
[2063]60    };
61
[5929]62    /**
63        @brief The EventState contains information about an event state.
[6417]64
[5929]65        An event state is a state of an object, which can be changed by events.
66        Event states are changed through functions. Possible functions headers for set event states are:
[7401]67         - memoryless state: <tt>function()</tt>
68         - boolean state:    <tt>function(bool state)</tt>
69         - individual state: <tt>function(bool state, SomeClass originator)</tt>
[6417]70
[5929]71        Note that SomeClass may be any class deriving from BaseObject. You will not receive events from originators of other classes.
[7401]72        The actual class for SomeClass must be specified as the second argument of the XMLPortEventState() macro.
[6417]73
[5929]74        The this pointer of the affected object is hidden in the functors, because the events are processed in the BaseObject, but some
75        statefunctions may be from child-classes.
76    */
77    class _CoreExport EventState
[2072]78    {
79        public:
[7284]80            EventState(const FunctorPtr& statefunction, Identifier* subclass, bool bSink = false) : bProcessingEvent_(false), activeEvents_(0), statefunction_(statefunction), subclass_(subclass), bSink_(bSink) {}
[2072]81
[5929]82            void process(const Event& event, BaseObject* object);
[6417]83
[7284]84            const FunctorPtr& getFunctor() const
[5929]85                { return this->statefunction_; }
[2072]86
87        private:
[5929]88            bool        bProcessingEvent_;  //!< This becomes true while the container processes an event (used to prevent loops)
89            int         activeEvents_;      //!< The number of events which affect this state and are currently active
[7284]90            FunctorPtr  statefunction_;     //!< A functor to set the state
[5929]91            Identifier* subclass_;          //!< Originators must be an instance of this class (usually BaseObject, but some statefunctions allow a second argument with an originator of a specific class)
[6800]92            bool        bSink_;             //!< Determines whether the EventState acts as an EventSink forwarding any Event (even if the state didn't change) or in the normal manner, only processing Events that change the state.
[2072]93    };
[2063]94}
95
96#endif /* _Event_H__ */
Note: See TracBrowser for help on using the repository browser.