Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelCompVF.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 
46 #ifndef __VEL_COMP_VF_H__
47 #define __VEL_COMP_VF_H__
48 
49 #include "CoreConfig.h"
53 #include "VectorField.h"
54 
55 namespace Menge {
56 
57  // forward declaration
58  template < class R >
59  class ResourcePtr;
60 
66 
67  namespace BFSM {
75  class MENGE_API VFVelComponent : public VelComponent {
76  public:
81 
90  VFVelComponent( VectorFieldPtr & vf, bool useNearest );
91 
99  void setUseNearest( bool useNearest ) { _nearest = useNearest; }
100 
106  void setVectorField( const VectorFieldPtr & vf ) { _vf = vf; }
107 
122  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel );
123 
131  virtual VelCompContext * getContext();
132 
133  friend class VecFieldVCContext;
134 
135  protected:
139  VectorFieldPtr _vf;
140 
145  bool _nearest;
146  };
147 
149 
153  class MENGE_API VecFieldVCContext : public VelCompContext {
154  public:
162 
172  virtual std::string getUIText( const std::string & indent="" ) const;
173 
182  virtual SceneGraph::ContextResult handleKeyboard( SDL_Event & e );
183 
192  virtual void draw3DGL( const Agents::BaseAgent * agt, const Goal * goal );
193 
194  protected:
199 
204 
209  };
210 
212 
216  class MENGE_API VFVCFactory : public VelCompFactory {
217  public:
221  VFVCFactory();
222 
231  virtual const char * name() const { return "vel_field"; }
232 
240  virtual const char * description() const {
241  return "Provides a preferred velocity which is derived from a velocity field defined"\
242  " on a uniform, 2D discretization of the planning space.";
243  };
244 
245  protected:
256  VelComponent * instance() const { return new VFVelComponent(); }
257 
276  virtual bool setFromXML( VelComponent * vc, TiXmlElement * node, const std::string & behaveFldr ) const;
277 
281  size_t _fileNameID;
282 
287  };
288 
289  } // namespace BFSM
290 } // namespace Menge
291 
292 #endif // __VEL_COMP_VF_H__
SDL_Event SDL_Event
Forward declaration of the SDL event type.
Definition: Context.h:53
size_t _useNearestID
The identifier for the "use_nearest" bool attribute.
Definition: VelCompVF.h:286
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
A velocity component that returns a preferred velocity whose direction and preferred speed are comput...
Definition: VelCompVF.h:75
Sets up the proper compiler directives for platform and dll export/import.
The context for the VFVelComponent.
Definition: VelCompVF.h:153
virtual const char * name() const
The name of the velocity component.
Definition: VelCompVF.h:231
A class for parsing the xml description of a velocity component and instantiating particular instance...
Definition: VelComponentFactory.h:60
size_t _fileNameID
The identifier for the "file_name" string attribute.
Definition: VelCompVF.h:281
virtual const char * description() const
A description of the velocity component.
Definition: VelCompVF.h:240
The base, abstract class defining goals.
Definition: Goal.h:110
The base class for computing an agent's preferred velocity.
Definition: VelComponent.h:112
void setUseNearest(bool useNearest)
Determines whether the vector field velocity component computes velocity from the nearest cell center...
Definition: VelCompVF.h:99
bool _nearest
Determines if the vector selection is based on nearest (true) or bilinear interpolation (false) ...
Definition: VelCompVF.h:145
bool _showLocal
Displays only the local area around the agent.
Definition: VelCompVF.h:203
Factory for the VFVelComponent.
Definition: VelCompVF.h:216
VectorFieldPtr _vf
The vector field resource which provides preferred velocity vectors.
Definition: VelCompVF.h:139
Defines the result of the context's consideration of user input.
Definition: Context.h:74
Base Class providing a pointer interface to Resources.
Definition: VelCompRoadMap.h:63
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The definition of a 2D vector field.
void setVectorField(const VectorFieldPtr &vf)
Sets the velocity field pointer.
Definition: VelCompVF.h:106
The definition of how preferred velocity is computed in a state.
int _neighborhood
Size of the local neighborhood to visualize.
Definition: VelCompVF.h:208
VelComponent * instance() const
Create an instance of this class's velocity component.
Definition: VelCompVF.h:256
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 factory for parsing xml data and instantiating velocity components.
VFVelComponent * _vc
The underlying finite state machine velocity component.
Definition: VelCompVF.h:198
ResourcePtr< VectorField > VectorFieldPtr
forward declaration of VectorField resource pointer. see VectorField.h for more details ...
Definition: VelCompVF.h:59
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