Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/triggers/EventTrigger.h @ 12203

Last change on this file since 12203 was 11083, checked in by muemart, 9 years ago

Fix some clang-tidy warnings.
Also, Serialise.h was doing some C-style casts that ended up being const casts. I moved those const casts as close to the source as possible and changed the loadAndIncrease functions to not do that.

  • Property svn:eol-style set to native
File size: 2.7 KB
RevLine 
[2071]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
[7601]29/**
30    @file EventTrigger.h
31    @brief Definition of the EventTrigger class.
32    @ingroup NormalTrigger
33*/
34
[2071]35#ifndef _EventTrigger_H__
36#define _EventTrigger_H__
37
[5730]38#include "objects/ObjectsPrereqs.h"
[8213]39
[2071]40#include "Trigger.h"
41
42namespace orxonox
43{
[7601]44
45    /**
46    @brief
[8213]47        The EventTrigger class provides a way to have a Trigger triggered by any kinds of @ref orxonox::Event "Events".
[7601]48
[8213]49        Example:
50        @code
51        <EventTrigger invert="true">
52            <events>
53                <trigger>
54                    <TriggerBase ... />
55                    <EventListener ... />
56                </trigger>
57            </events>
58        </EventTrigger>
59        @endcode
60
61    @see Trigger
[8706]62        For more information on @ref orxonox::Trigger "Triggers".
[8213]63
[7601]64    @author
65        Fabian 'x3n' Landau
66
67    @ingroup NormalTrigger
68    */
[5730]69    class _ObjectsExport EventTrigger : public Trigger
[2071]70    {
71        public:
[9667]72            EventTrigger(Context* context); // Constructor. Registers and initializes the object.
[2071]73            virtual ~EventTrigger();
74
[11083]75            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode) override; // Creates an event port.
[2071]76
[8213]77            /**
78            @brief Method that is called when a new event comes in.
79                   The tick call makes sure the state change takes effect immediately.
80            @param bTriggered The state of the incoming event.
81            */
[2071]82            inline void trigger(bool bTriggered)
83                { this->bEventTriggered_ = bTriggered; this->tick(0); }
84
85        protected:
[11071]86            virtual bool isTriggered(TriggerMode mode) override; // Check whether the EventTrigger should be triggered.
[2071]87
88        private:
[8213]89            bool bEventTriggered_; //!< Boolean to keep track of what the state of the last event was.
[2071]90    };
91}
92
93#endif /* _EventTrigger_H__ */
Note: See TracBrowser for help on using the repository browser.