Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TeleportAction.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
45 #ifndef __TELEPORT_ACTION_H__
46 #define __TELEPORT_ACTION_H__
47 
48 #include "CoreConfig.h"
49 #include "Actions/Action.h"
50 #include "Actions/ActionFactory.h"
51 #include "fsmCommon.h"
52 
53 namespace Menge {
54 
55  // forward declaration
56 
57  namespace Agents {
58  class BaseAgent;
59  }
60 
61  namespace BFSM {
62  // forward declaration
63  class TeleportActFactory;
64 
71  class MENGE_API TeleportAction : public Action {
72  public:
78 
82  virtual ~TeleportAction();
83 
90  virtual void onEnter( Agents::BaseAgent * agent );
91 
92  friend class TeleportActFactory;
93  protected:
94 
100  virtual void leaveAction( Agents::BaseAgent * agent ) {}
101 
106  };
107 
111  class MENGE_API TeleportActFactory : public ActionFactory {
112  public:
117 
126  virtual const char * name() const { return "teleport"; }
127 
135  virtual const char * description() const {
136  return "Causes the agent to teleport to a user-specified location based on a 2D generator";
137  };
138 
139  protected:
150  Action * instance() const;
151 
170  virtual bool setFromXML( Action * action, TiXmlElement * node, const std::string & behaveFldr ) const;
171 
175  size_t _2DGoalID;
176  };
177 
178  } // namespace BFSM
179 
180 } //
181 #endif // __TELEPORT_ACTION_H__
virtual void leaveAction(Agents::BaseAgent *agent)
The work to do upon state exit.
Definition: TeleportAction.h:100
size_t _2DGoalID
The identifier for the "exit_reset" boolean attribute.
Definition: TeleportAction.h:175
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Sets up the proper compiler directives for platform and dll export/import.
Factory for the TeleportAction.
Definition: TeleportAction.h:111
Vec2DGenerator * _goals
The generator for computing teleport destination locations.
Definition: TeleportAction.h:105
The definition of actions that are taken as agents enter states.
Causes the agents to teleport to a new location.
Definition: TeleportAction.h:71
Generic abstract class which generates a 2D vector float values.
Definition: RandGenerator.h:706
virtual const char * description() const
A description of the action.
Definition: TeleportAction.h:135
The factory for parsing xml data and instantiating actions.
virtual const char * name() const
The name of the action.
Definition: TeleportAction.h:126
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The abstract definition of an action.
Definition: Action.h:78
Collection of convenient pre-compiler information for fsm definitions.
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
A class for parsing the xml description of an action and instantiating particular instances...
Definition: ActionFactory.h:62
The namespace that contains the basic simulation mechanisms.