Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/eventsystem/EventFilter.cc @ 8858

Last change on this file since 8858 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 3.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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "EventFilter.h"
30
31#include "core/CoreIncludes.h"
32#include "core/Event.h"
33#include "core/XMLPort.h"
34#include "EventName.h"
35
36namespace orxonox
37{
38    CreateFactory(EventFilter);
39
40    EventFilter::EventFilter(BaseObject* creator) : BaseObject(creator)
41    {
42        RegisterObject(EventFilter);
43
44        this->bActive_ = false;
45    }
46
47    EventFilter::~EventFilter()
48    {
49        for (std::list<EventName*>::const_iterator it = this->names_.begin(); it != this->names_.end(); )
50            (*(it++))->destroy();
51    }
52
53    void EventFilter::XMLPort(Element& xmlelement, XMLPort::Mode mode)
54    {
55        SUPER(EventFilter, XMLPort, xmlelement, mode);
56
57        XMLPortObject(EventFilter, BaseObject, "", addFilterSource, getFilterSource, xmlelement, mode);
58        XMLPortObject(EventFilter, EventName, "names", addEventName, getEventName, xmlelement, mode);
59    }
60
61    void EventFilter::processEvent(Event& event)
62    {
63        if (this->bActive_)
64        {
65            orxout(internal_warning, context::events) << "Detected Event loop in EventFilter \"" << this->getName() << '"' << endl;
66            return;
67        }
68
69        if (this->names_.size() > 0)
70        {
71            bool success = false;
72            for (std::list<EventName*>::const_iterator it = this->names_.begin(); it != this->names_.end(); ++it)
73            {
74                if ((*it)->getName() == event.name_)
75                {
76                    success = true;
77                    break;
78                }
79            }
80            if (!success)
81                return;
82        }
83
84        this->bActive_ = true;
85        this->fireEvent(event.activate_, event.originator_, event.name_);
86        this->bActive_ = false;
87    }
88
89    void EventFilter::addFilterSource(BaseObject* source)
90    {
91        this->sources_.push_back(source);
92        this->addEventSource(source, "");
93    }
94
95    BaseObject* EventFilter::getFilterSource(unsigned int index) const
96    {
97        unsigned int i = 0;
98        for (std::list<BaseObject*>::const_iterator it = this->sources_.begin(); it != this->sources_.end(); ++it)
99        {
100            if (i == index)
101                return (*it);
102            ++i;
103        }
104        return 0;
105    }
106
107    void EventFilter::addEventName(EventName* eventname)
108    {
109        this->names_.push_back(eventname);
110    }
111
112    EventName* EventFilter::getEventName(unsigned int index) const
113    {
114        unsigned int i = 0;
115        for (std::list<EventName*>::const_iterator it = this->names_.begin(); it != this->names_.end(); ++it)
116        {
117            if (i == index)
118                return (*it);
119            ++i;
120        }
121        return 0;
122    }
123}
Note: See TracBrowser for help on using the repository browser.