Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/triggers/CheckPoint.h @ 8192

Last change on this file since 8192 was 7601, checked in by dafrick, 14 years ago

Adding all classes in modules/objects to Objects module (in doxygen).
Created TriggerBase which is the base class of Trigger and MultiTrigger and now provides the shared functionality and data.
Updated some of the documentation in MultiTrigger and Script.

  • Property svn:eol-style set to native
File size: 2.4 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 *      Aurelian Jaggi
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file CheckPoint.h
31    @brief Definition of the CheckPoint class.
32    @ingroup NormalTrigger
33*/
34
35#ifndef _CheckPoint_H__
36#define _CheckPoint_H__
37
38#include "objects/ObjectsPrereqs.h"
39
40#include "interfaces/RadarViewable.h"
41#include "DistanceTrigger.h"
42
43namespace orxonox
44{
45
46    /**
47    @brief
48
49    @author
50        Aurelian Jaggi
51
52    @ingroup NormalTrigger
53    */
54    class _ObjectsExport CheckPoint : public DistanceTrigger, public RadarViewable
55    {
56    public:
57        CheckPoint(BaseObject* creator);
58        virtual ~CheckPoint();
59
60        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a CheckPoint object through XML.
61        virtual void changedActivity();
62
63    private:
64        virtual void triggered(bool bIsTriggered);
65        virtual void notifyMaskUpdate();
66
67        inline void setDestination(bool isDestination)
68            { bIsDestination_ = isDestination; }
69
70        inline const WorldEntity* getWorldEntity() const
71            { return this; }
72
73        inline bool getDestination()
74            { return bIsDestination_; }
75
76        inline void setFirst(bool isFirst)
77            { this->bIsFirst_ = isFirst; }
78
79        inline bool getFirst()
80            { return this->bIsFirst_; }
81
82        inline void setAddTime(float time)
83            { this->addTime_ = time; }
84
85        inline bool getAddTime()
86            { return this->addTime_; }
87
88        bool bIsFirst_;
89        bool bIsDestination_;
90        float addTime_;
91    };
92}
93
94#endif /* _CheckPoint_H__ */
Note: See TracBrowser for help on using the repository browser.