Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Menge::BFSM::TeleportAction Class Reference

Causes the agents to teleport to a new location. More...

#include <TeleportAction.h>

Inheritance diagram for Menge::BFSM::TeleportAction:
Menge::BFSM::Action Menge::Element

Public Member Functions

 TeleportAction ()
 Constructor.
 
virtual ~TeleportAction ()
 Virtual destructor.
 
virtual void onEnter (Agents::BaseAgent *agent)
 Upon entering the state, this is called – it is the main work of the action. More...
 
- Public Member Functions inherited from Menge::BFSM::Action
 Action ()
 Constructor.
 
void onLeave (Agents::BaseAgent *agent)
 The work to do upon state exit. More...
 
- Public Member Functions inherited from Menge::Element
void destroy ()
 This supplants the destructor. More...
 
virtual BFSM::TaskgetTask ()
 Return an optional task associated with this element. More...
 
virtual SceneGraph::GLNodegetSGNode ()
 Returns an optional visualization element associated with the element. More...
 

Protected Member Functions

virtual void leaveAction (Agents::BaseAgent *agent)
 The work to do upon state exit. More...
 
- Protected Member Functions inherited from Menge::BFSM::Action
virtual ~Action ()
 Virtual destructor.
 

Protected Attributes

Vec2DGenerator_goals
 The generator for computing teleport destination locations.
 
- Protected Attributes inherited from Menge::BFSM::Action
bool _undoOnExit
 Determines if the action undoes itself on exiting the state.
 

Friends

class TeleportActFactory
 

Detailed Description

Causes the agents to teleport to a new location.

This action does not undo the teleport on leaving the state. It is hard-wired this way.

Member Function Documentation

virtual void Menge::BFSM::TeleportAction::leaveAction ( Agents::BaseAgent agent)
inlineprotectedvirtual

The work to do upon state exit.

Parameters
agentThe agent to act on.

Implements Menge::BFSM::Action.

void Menge::BFSM::TeleportAction::onEnter ( Agents::BaseAgent agent)
virtual

Upon entering the state, this is called – it is the main work of the action.

Parameters
agentThe agent to act on.

Implements Menge::BFSM::Action.


The documentation for this class was generated from the following files: