Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial2/src/modules/objects/triggers/DistanceMultiTrigger.h @ 8003

Last change on this file since 8003 was 7301, checked in by dafrick, 14 years ago

Improving documentation for MultiTriggers, also some small bugfixes, simplifications and added features.

  • Property svn:eol-style set to native
File size: 5.3 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 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27*/
28
29/**
30    @file DistanceMultiTrigger.h
31    @brief Definition of the DistanceMultiTrigger class.
32*/
33
34#ifndef _DistanceMultiTrigger_H__
35#define _DistanceMultiTrigger_H__
36
37#include "objects/ObjectsPrereqs.h"
38
39#include "worldentities/WorldEntity.h"
40#include "core/WeakPtr.h"
41#include <map>
42
43#include "MultiTrigger.h"
44
45namespace orxonox
46{
47
48    /**
49    @brief
50        The DistanceMultiTrigger is a trigger that triggers whenever an object (that is of the specified target type) is in a specified range of the DistanceMultiTrigger. The object can be specified further by adding a DistanceTriggerBeacon (just attaching it) to the objects that can trigger this DistanceMultiTrigger and specify the name of the DistanceTriggerBeacon with the parameter targetname and only objects that have a DistanceTriggerBeacon with that name attached will trigger the DistanceMultiTrigger.
51        Parameters are (additional to the ones of MultiTrigger):
52            'distance', which specifies the maximum distance at which the DistanceMultiTrigger still triggers. Default is 100.
53            'targetname', which, if not left blank, causes the DistancMultiTrigger to be in single-target mode, meaning, that it only reacts to objects that have a DistanceTriggerBeacon (therefore the target has to be set to DistanceTriggerBeacon for it to work), with the name specified by targetname, attached.
54
55        A simple DistanceMultiTrigger would look like this:
56        @code
57        <DistanceMultiTrigger position="0,0,0" switch="true" target="Pawn" distance="20" />
58        @endcode
59
60        An implementation that only reacts to objects with a DistanceTriggerBeacon attached would look like this:
61        @code
62        <DistanceMultiTrigger position="0,0,0" target="DistanceMultiTrigger" targetname="beacon1" distance="30" />
63        @endcode
64        This particular DistanceMultiTrigger would only react if an object was in range, that had a DistanceTriggerBeacon with the name 'beacon1' attached.
65    @see MultiTrigger.h
66        For more information on MultiTriggers.
67    @author
68        Damian 'Mozork' Frick
69    */
70    class _ObjectsExport DistanceMultiTrigger : public MultiTrigger
71    {
72
73        public:
74            DistanceMultiTrigger(BaseObject* creator); //!< Default Constructor. Registers the object and initializes default values.
75            virtual ~DistanceMultiTrigger(); //!< Destructor.
76
77            void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a DistanceMultiTrigger object through XML.
78
79            void setTargetName(const std::string& targetname); //!< Set the target name of DistanceTriggerBeacons that triggers this DistanceMultiTrigger.
80            /**
81            @brief Get the target name of the DistanceTriggerbeacon, that triggers this DistanceMultiTrigger.
82            @return Returns the target name as a string.
83            */
84            inline const std::string& getTargetName(void)
85                { return this->targetName_; }
86
87            /**
88            @brief Set the distance at which the DistanceMultiTrigger triggers.
89            @param distance The distance.
90            */
91            inline void setDistance(float distance)
92                { if(distance >= 0) this->distance_ = distance; }
93            /**
94            @brief Get the distance at which the DistanceMultiTrigger triggers.
95            @return Returns the distance.
96            */
97            inline float getDistance() const
98                { return this->distance_; }
99
100        protected:
101            virtual std::queue<MultiTriggerState*>* letTrigger(void); //!< This method is called by the MultiTrigger to get information about new trigger events that need to be looked at.
102
103            bool addToRange(WorldEntity* entity); //!< Add a given entity to the entities, that currently are in range of the DistanceMultiTrigger.
104            bool removeFromRange(WorldEntity* entity); //!< Remove a given entity from the set of entities, that currently are in range of the DistanceMultiTrigger.
105
106        private:
107            float distance_; //!< The distance at which the DistanceMultiTrigger triggers.
108            std::string targetName_; //!< The target name, used in singleTargetMode.
109            bool singleTargetMode_; //!< To indicate whe the MultiDistanceTrigger is in single-target-mode.
110
111            std::map<WorldEntity*, WeakPtr<WorldEntity>* > range_; //!< The set of entities that currently are in range of the DistanceMultiTrigger.
112
113    };
114
115}
116
117#endif // _DistanceMultiTrigger_H__
Note: See TracBrowser for help on using the repository browser.