Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelCompConst.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_CONST_H__
46 #define __VEL_COMP_CONST_H__
47 
48 #include "CoreConfig.h"
52 
53 namespace Menge {
54 
55  namespace BFSM {
56 
58 
62  class MENGE_API ConstVelComponent : public VelComponent {
63  public:
68 
74  ConstVelComponent( const Vector2 & vel );
75 
81  void setVelocity( const Vector2 & velocity );
82 
97  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel );
98 
104  Vector2 getConstVelocity() const { return _dir * _speed; }
105 
113  virtual VelCompContext * getContext();
114 
115  friend class ConstVCFactory;
116  protected:
121 
125  float _speed;
126  };
127 
128 
130 
134  class MENGE_API ConstVCContext : public VelCompContext {
135  public:
143 
153  virtual std::string getUIText( const std::string & indent="" ) const;
154 
163  virtual void draw3DGL( const Agents::BaseAgent * agt, const Goal * goal );
164 
165  protected:
170  };
171 
173 
177  class MENGE_API ConstVCFactory : public VelCompFactory {
178  public:
182  ConstVCFactory();
183 
192  virtual const char * name() const { return "const"; }
193 
201  virtual const char * description() const {
202  return "Provides a preferred velocity which is always a constant value (direction and magnitude).";
203  };
204 
205  protected:
216  VelComponent * instance() const { return new ConstVelComponent(); }
217 
236  virtual bool setFromXML( VelComponent * vc, TiXmlElement * node, const std::string & behaveFldr ) const;
237 
241  size_t _xID;
242 
246  size_t _yID;
247  };
248 
250 
251  // forward declaration
252  class ConstDirVCContext;
253 
258  class MENGE_API ConstVelDirComponent : public VelComponent {
259  public:
264 
271  ConstVelDirComponent( const Vector2 & vel );
272 
287  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel );
288 
296  void setDirection( const Vector2 & dir );
297 
305  virtual VelCompContext * getContext();
306 
307  friend class ConstDirVCContext;
308  protected:
313  };
314 
315 
317 
321  class MENGE_API ConstDirVCContext : public VelCompContext {
322  public:
330 
340  virtual std::string getUIText( const std::string & indent="" ) const;
341 
350  virtual void draw3DGL( const Agents::BaseAgent * agt, const Goal * goal );
351 
352  protected:
357  };
358 
360 
364  class MENGE_API ConstDirVCFactory : public VelCompFactory {
365  public:
370 
379  virtual const char * name() const { return "const_dir"; }
380 
388  virtual const char * description() const {
389  return "Provides a preferred velocity which is always in a fixed direction but uses the agent's preferred speed.";
390  };
391 
392  protected:
403  VelComponent * instance() const { return new ConstVelDirComponent(); }
404 
423  virtual bool setFromXML( VelComponent * vc, TiXmlElement * node, const std::string & behaveFldr ) const;
424 
428  size_t _xID;
429 
433  size_t _yID;
434  };
435 
437 
441  class MENGE_API ZeroVelComponent : public VelComponent {
442  public:
447 
462  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel );
463 
471  virtual VelCompContext * getContext();
472 
473  };
474 
476 
480  class MENGE_API ZeroVCContext : public VelCompContext {
481  public:
485  ZeroVCContext();
486 
496  virtual std::string getUIText( const std::string & indent="" ) const;
497 
498  };
499 
501 
505  class MENGE_API ZeroVCFactory : public VelCompFactory {
506  public:
515  virtual const char * name() const { return "zero"; }
516 
524  virtual const char * description() const {
525  return "Provides a preferred velocity which is always the zero velocity.";
526  };
527 
528  protected:
539  VelComponent * instance() const { return new ZeroVelComponent(); }
540  };
541 
543 
544  } // namespace BFSM
545 
546 } // namespace Menge
547 
548 #endif // __VEL_COMP_CONST_H__
size_t _xID
The identifier for the "x" float attribute.
Definition: VelCompConst.h:241
The context for the ConstVelDirComponent.
Definition: VelCompConst.h:321
virtual const char * description() const
A description of the velocity component.
Definition: VelCompConst.h:201
virtual const char * description() const
A description of the velocity component.
Definition: VelCompConst.h:388
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
The context for the ZeroVelComponent.
Definition: VelCompConst.h:480
Vector2 _dir
The direction of the constant preferred velocity.
Definition: VelCompConst.h:120
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
virtual const char * name() const
The name of the velocity component.
Definition: VelCompConst.h:192
The base, abstract class defining goals.
Definition: Goal.h:110
Factory for the ConstVelComponent.
Definition: VelCompConst.h:177
The base class for computing an agent's preferred velocity.
Definition: VelComponent.h:112
Vector2 _dir
The direction of the constant preferred velocity.
Definition: VelCompConst.h:312
Factory for the ConstVelDirComponent.
Definition: VelCompConst.h:364
VelComponent * instance() const
Create an instance of this class's velocity component.
Definition: VelCompConst.h:539
A velocity component that always returns a constant velocity.
Definition: VelCompConst.h:62
A velocity component that always returns a constant direction but leaves the preferred speed unchange...
Definition: VelCompConst.h:258
A velocity component that always returns the zero velocity.
Definition: VelCompConst.h:441
Vector2 getConstVelocity() const
Returns the constant velocity.
Definition: VelCompConst.h:104
The namespace contains the Behavior Finite State Machine (BFSM) definition.
size_t _yID
The identifier for the "y" float attribute.
Definition: VelCompConst.h:433
Factory for the ZeroVelComponent.
Definition: VelCompConst.h:505
The definition of how preferred velocity is computed in a state.
virtual const char * name() const
The name of the velocity component.
Definition: VelCompConst.h:515
virtual const char * description() const
A description of the velocity component.
Definition: VelCompConst.h:524
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
float _speed
The speed of the constant preferred velocity.
Definition: VelCompConst.h:125
VelComponent * instance() const
Create an instance of this class's velocity component.
Definition: VelCompConst.h:403
The factory for parsing xml data and instantiating velocity components.
VelComponent * instance() const
Create an instance of this class's velocity component.
Definition: VelCompConst.h:216
size_t _xID
The identifier for the "x" float attribute.
Definition: VelCompConst.h:428
ConstVelDirComponent * _vc
The underlying finite state machine velocity component.
Definition: VelCompConst.h:356
ConstVelComponent * _vc
The underlying finite state machine velocity component.
Definition: VelCompConst.h:169
virtual const char * name() const
The name of the velocity component.
Definition: VelCompConst.h:379
The context for the ConstVelComponent.
Definition: VelCompConst.h:134
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
size_t _yID
The identifier for the "y" float attribute.
Definition: VelCompConst.h:246