Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/objects/triggers/DistanceMultiTrigger.h @ 7163

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

Merged presentation3 branch into trunk.

  • Property svn:eol-style set to native
File size: 5.2 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 hav a DistanceTriggerBeacon with that name attached will trigger the DistanceMultiTrigger.
51    @see MultiTrigger.h
52        For more information on MultiTriggers.
53    @author
54        Damian 'Mozork' Frick
55    */
56    class _ObjectsExport DistanceMultiTrigger : public MultiTrigger
57    {
58
59        public:
60            DistanceMultiTrigger(BaseObject* creator); //!< Default Constructor. Registers the object and initializes default values.
61            ~DistanceMultiTrigger(); //!< Destructor.
62
63            void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a DistanceMultiTrigger object through XML.
64
65            /**
66            @brief Set the target name of DistanceTriggerBeacons that triggers this DistanceMultiTrigger.
67            @param targename The name of the DistanceTriggerBeacon as a string.
68            */
69            inline void setTargetName(const std::string& targetname)
70                { if(targetname.compare(BLANKSTRING) != 0) this->singleTargetMode_ = true; else this->singleTargetMode_ = false; this->targetName_ = targetname; }
71            /**
72            @brief Get the target name of the DistanceTriggerbeacon, that triggers this DistanceMultiTrigger.
73            @return Returns the target name as a string.
74            */
75            inline const std::string& getTargetName(void)
76                { return this->targetName_; }
77
78            /**
79            @brief Set the distance at which the DistanceMultiTrigger triggers.
80            @param distance The distance.
81            */
82            inline void setDistance(float distance)
83                { if(distance >= 0) this->distance_ = distance; }
84            /**
85            @brief Get the distance at which the DistanceMultiTrigger triggers.
86            @return Returns the distance.
87            */
88            inline float getDistance() const
89                { return this->distance_; }
90
91        protected:
92            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.
93
94            /**
95            @brief Add a given entity to the entities, that currently are in range of the DistanceMultiTrigger.
96            @param entity A pointer to the entity.
97            @return Returns true if successful, false if not.
98            */
99            inline bool addToRange(WorldEntity* entity)
100                { std::pair<std::map<WorldEntity*, WeakPtr<WorldEntity>* >::iterator, bool> pair = this->range_.insert(std::pair<WorldEntity*, WeakPtr<WorldEntity>* >(entity, new WeakPtr<WorldEntity>(entity))); return pair.second; }
101            /**
102            @brief Remove a given entity from the set of entities, that currently are in range of the DistanceMultiTrigger.
103            @param entity A pointer ot the entity.
104            @return Returns true if successful.
105            */
106            inline bool removeFromRange(WorldEntity* entity)
107                { WeakPtr<WorldEntity>* weakptr = this->range_.find(entity)->second; bool erased = this->range_.erase(entity) > 0; if(erased) delete weakptr; return erased; }
108
109        private:
110            float distance_; //!< The distance at which the DistanceMultiTrigger triggers.
111            std::string targetName_; //!< The target name, used in singleTargetMode.
112            bool singleTargetMode_; //!< To indicate whe the MultiDistanceTrigger is in single-target-mode.
113
114            std::map<WorldEntity*, WeakPtr<WorldEntity>* > range_; //!< The set of entities that currently are in range of the DistanceMultiTrigger.
115
116    };
117
118}
119
120#endif // _DistanceMultiTrigger_H__
Note: See TracBrowser for help on using the repository browser.