Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
StateContext.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 __STATE_CONTEXT_H__
46 #define __STATE_CONTEXT_H__
47 
48 #include "CoreConfig.h"
49 #include "fsmCommon.h"
50 #include "Context.h"
52 
53 namespace Menge {
54 
55  // forward declaration
56  namespace BFSM {
57  class StateContext;
58  }
59 
63  typedef HASH_MAP< size_t, BFSM::StateContext * > StateContextMap;
64 
65  namespace Agents {
66  class BaseAgent;
67  }
68 
69  namespace BFSM {
70 
71  // Forward declarations
72  class State;
73 
81  public:
88  StateContext( State * state );
89 
93  virtual ~StateContext();
94 
104 
114  std::string getUIText( const std::string & indent="" ) const;
115 
123  virtual void draw3DGL( const Agents::BaseAgent * agt, bool drawVC, bool drawTrans );
124 
125  protected:
130 
136  static size_t NO_ACTIVE_ID;
137 
142 
150 
151  };
152  } // namespace BFSM
153 } // namespace Menge
154 #endif // __STATE_CONTEXT_H__
The basic state of the behavior finite state machine.
Definition: State.h:123
SDL_Event SDL_Event
Forward declaration of the SDL event type.
Definition: Context.h:53
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.
virtual void draw3DGL(const Agents::BaseAgent *agt, bool drawVC, bool drawTrans)
Draw context elements into the 3D world.
Definition: StateContext.cpp:125
The base context class for defining a how events are handled. It also is responsible drawing UI eleme...
Definition: Context.h:156
HASH_MAP< size_t, BFSM::StateContext * > StateContextMap
A map from state ids to statecontexts to facilitate lookups for a visualized agent.
Definition: StateContext.h:63
Base context for finite state machine states.
Definition: StateContext.h:80
size_t _activeTransition
The id of the "active" transition.
Definition: StateContext.h:149
VelCompContext * _vcContext
The velocity component context for this state.
Definition: StateContext.h:141
static size_t NO_ACTIVE_ID
The value used to indicate that no id is selected.
Definition: StateContext.h:136
virtual SceneGraph::ContextResult handleKeyboard(SDL_Event &e)
Give the context the opportunity to respond to a keyboard event.
Definition: StateContext.cpp:74
State * _state
The underlying finite state machine state.
Definition: StateContext.h:129
Defines the result of the context's consideration of user input.
Definition: Context.h:74
The namespace contains the Behavior Finite State Machine (BFSM) definition.
std::string getUIText(const std::string &indent="") const
Provides a string to be printed in the display as a UI element detailing state information.
Definition: StateContext.cpp:102
StateContext(State *state)
Constructor.
Definition: StateContext.cpp:62
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
The namespace that contains the basic simulation mechanisms.
virtual ~StateContext()
Destructor.
Definition: StateContext.cpp:69
The definition of a basic UI context for finite state machine velocity components.
Base context for finite state machine velocity components.
Definition: VelCompContext.h:70
Defines a context for handling user interaction (mouse and keyboard input).