Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelCompGoal.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_GOAL_H__
46 #define __VEL_COMP_GOAL_H__
47 
48 #include "CoreConfig.h"
52 
53 namespace Menge {
54 
55  namespace BFSM {
56 
61  class MENGE_API GoalVelComponent: public VelComponent {
62  public:
67 
82  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel );
83 
91  virtual VelCompContext * getContext();
92  };
93 
95 
99  class MENGE_API GoalVCContext : public VelCompContext {
100  public:
108 
118  virtual std::string getUIText( const std::string & indent="" ) const;
119 
128  virtual void draw3DGL( const Agents::BaseAgent * agt, const Goal * goal );
129 
130  protected:
135  };
136 
138 
142  class MENGE_API GoalVCFactory : public VelCompFactory {
143  public:
152  virtual const char * name() const { return "goal"; }
153 
161  virtual const char * description() const {
162  return "Provides a preferred velocity which always aims directly toward the goal (at the agent's preferred speed)"\
163  " unless it will overstep the goal in a single time step, then it is scaled down.";
164  };
165 
166  protected:
177  VelComponent * instance() const { return new GoalVelComponent(); }
178  };
179 
180  } // namespace BFSM
181 } // namespace Menge
182 
183 #endif // __VEL_COMP_GOAL_H__
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.
A class for parsing the xml description of a velocity component and instantiating particular instance...
Definition: VelComponentFactory.h:60
The base, abstract class defining goals.
Definition: Goal.h:110
The context for the GoalVelComponent.
Definition: VelCompGoal.h:99
The base class for computing an agent's preferred velocity.
Definition: VelComponent.h:112
VelComponent * instance() const
Create an instance of this class's velocity component.
Definition: VelCompGoal.h:177
GoalVelComponent * _vc
The underlying finite state machine velocity component.
Definition: VelCompGoal.h:134
A velocity component that returns a preferred velocity whose direction points from the current agent ...
Definition: VelCompGoal.h:61
virtual const char * description() const
A description of the velocity component.
Definition: VelCompGoal.h:161
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The definition of how preferred velocity is computed in a state.
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
Factory for the GoalVelComponent.
Definition: VelCompGoal.h:142
The factory for parsing xml data and instantiating velocity components.
virtual const char * name() const
The name of the velocity component.
Definition: VelCompGoal.h:152
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