Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelCompContext.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 __VEL_COMP_CONTEXT_H__
46 #define __VEL_COMP_CONTEXT_H__
47 
48 #include "Context.h"
49 #include <vector>
50 
51 namespace Menge {
52 
53  namespace Agents {
54  class BaseAgent;
55  class PrefVelocity;
56  }
57 
58  namespace BFSM {
59 
60  // Forward declarations
61  class VelComponent;
62  class Goal;
63 
70  class MENGE_API VelCompContext : public SceneGraph::Context {
71  public:
76 
91  void destroy() { delete this; }
92 
93  protected:
97  virtual ~VelCompContext(){}
98 
99  public:
109  virtual std::string getUIText( const std::string & indent="" ) const;
110 
119  virtual void draw3DGL( const Agents::BaseAgent * agt, const Goal * goal ){}
120 
121  protected:
129  void drawPrefVel( const Agents::PrefVelocity & pVel, const Vector2 & pos, float elevation=0.f );
130 
137  void drawGoal( const Vector2 & goalPoint, const Agents::BaseAgent * agent ) const;
138 
145  void drawGoal( const Vector3 & goalPoint, float agtRadius=0.19f ) const;
146  };
147 
148  } // namespace BFSM
149 } // namespace Menge
150 
151 #endif // __VEL_COMP_CONTEXT_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
void destroy()
This supplants the destructor.
Definition: VelCompContext.h:91
virtual ~VelCompContext()
Destructor.
Definition: VelCompContext.h:97
The base, abstract class defining goals.
Definition: Goal.h:110
The base context class for defining a how events are handled. It also is responsible drawing UI eleme...
Definition: Context.h:156
VelCompContext()
Constructor.
Definition: VelCompContext.h:75
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
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 void draw3DGL(const Agents::BaseAgent *agt, const Goal *goal)
Draw context elements into the 3D world.
Definition: VelCompContext.h:119
Base context for finite state machine velocity components.
Definition: VelCompContext.h:70
Defines a context for handling user interaction (mouse and keyboard input).