Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial/src/libraries/core/EventIncludes.h @ 11468

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

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 5.1 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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Event
32    @brief Definition of the XMLPortEventState() macro, as well as some more useful macros.
33*/
34
35#ifndef _EventIncludes_H__
36#define _EventIncludes_H__
37
38#include "CorePrereqs.h"
39#include "XMLPort.h"
40#include "command/Executor.h"
41
42/**
43    @brief Defines a new event state (a state of the object which can be changed by events).
44
45    @param classname    The name of this class
46    @param subclassname Usually BaseObject - if different, only instances of this class can send events to this object
47    @param statename    The name (string) of this state
48    @param function     The function which should be used to set the state
49    @param xmlelement   Argument for XMLPort
50    @param mode         Argument for XMLPort
51*/
52#define XMLPortEventState(classname, subclassname, statename, function, xmlelement, mode) \
53    orxonox::EventState* containername##function = this->getEventState(statename); \
54    if (!containername##function) \
55    { \
56        containername##function = new orxonox::EventState(orxonox::createFunctor(&classname::function, this), orxonox::ClassIdentifier<subclassname>::getIdentifier()); \
57        this->addEventState(statename, containername##function); \
58    } \
59    XMLPortEventStateIntern(xmlportevent##function, classname, statename, xmlelement, mode)
60
61/**
62    @brief Like XMLPortEventState but creates an event sink instead of an event state.
63           The most important destinction between an EventState and an EventSink is, that an EventState only processes events which change the state of the EventState, where as an EventSink is an EventState that processes any Event that reaches it.
64*/
65
66#define XMLPortEventSink(classname, subclassname, statename, function, xmlelement, mode) \
67    orxonox::EventState* containername##function = this->getEventState(statename); \
68    if (!containername##function) \
69    { \
70        containername##function = new orxonox::EventState(orxonox::createFunctor(&classname::function, this), orxonox::ClassIdentifier<subclassname>::getIdentifier(), true); \
71        this->addEventState(statename, containername##function); \
72    } \
73    XMLPortEventStateIntern(xmlportevent##function, classname, statename, xmlelement, mode)
74
75
76#define XMLPortEventStateTemplate(classname, subclassname, statename, function, xmlelement, mode, ...) \
77    orxonox::EventState* containername##function = this->getEventState(statename); \
78    if (!containername##function) \
79    { \
80        containername##function = new orxonox::EventState(orxonox::createFunctor<classname, __VA_ARGS__ >(&classname::function, this), orxonox::ClassIdentifier<subclassname>::getIdentifier()); \
81        this->addEventState(statename, containername##function); \
82    } \
83    XMLPortEventStateIntern(xmlportevent##function, classname, statename, xmlelement, mode)
84
85#define XMLPortEventStateIntern(name, classname, statename, xmlelement, mode) \
86    static orxonox::ExecutorMemberPtr<classname> xmlsetfunctor##name = orxonox::createExecutor(orxonox::createFunctor(&classname::addEventSource), std::string( #classname ) + "::" + "addEventSource" + '(' + statename + ')').cast<orxonox::ExecutorMember<classname> >(); \
87    static orxonox::ExecutorMemberPtr<classname> xmlgetfunctor##name = orxonox::createExecutor(orxonox::createFunctor(&classname::getEventSource), std::string( #classname ) + "::" + "getEventSource" + '(' + statename + ')').cast<orxonox::ExecutorMember<classname> >(); \
88    xmlsetfunctor##name->setDefaultValue(1, statename); \
89    xmlgetfunctor##name->setDefaultValue(1, statename); \
90    XMLPortObjectGeneric(xmlport##name, classname, orxonox::BaseObject, statename, xmlsetfunctor##name, xmlgetfunctor##name, xmlelement, mode, false, true)
91
92
93/**
94    @brief Defines a new event name for a class. Named events can only have names which were defined with this macro.
95
96    @param classname The name of the class
97    @param name      The name of the event
98*/
99#define CreateEventName(classname, name) \
100    static std::string eventname##classname##name = #name
101
102/**
103    @brief This macro is needed to fire an event with this name. The event name must previously be declared with @ref CreateEventName.
104*/
105#define FireEventName(classname, name) \
106    eventname##classname##name
107
108#endif /* _EventIncludes_H__ */
Note: See TracBrowser for help on using the repository browser.