Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PrefVelocity.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 
44 #ifndef __PREF_VELOCITY_H__
45 #define __PREF_VELOCITY_H__
46 
47 #include "mengeCommon.h"
48 
49 namespace Menge {
50 
51  namespace Agents {
52 
68  class MENGE_API PrefVelocity {
69  public:
73  PrefVelocity();
74 
82  PrefVelocity( const Vector2 & dir, float speed, const Vector2 & target );
83 
93  PrefVelocity( const Vector2 & left, const Vector2 & right, const Vector2 & pref, float speed, const Vector2 & target );
94 
100  PrefVelocity( const PrefVelocity & vel );
101 
108  PrefVelocity & operator=( const PrefVelocity & vel );
109 
115  inline Vector2 getLeft() const { return _left; }
116 
122  inline Vector2 getRight() const { return _right; }
123 
129  inline Vector2 getPreferred() const { return _preferred; }
130 
138  inline Vector2 getPreferredVel() const { return _preferred * _speed; }
139 
145  inline float getSpeed() const { return _speed; }
146 
152  inline void setSpeed( float speed ) { _speed = speed; }
153 
159  inline void setSingle( const Vector2 & dir ) { _left = _preferred = _right = dir; }
160 
166  inline Vector2 getTarget() const { return _target; }
167 
173  inline void setTarget( const Vector2 & target ) { _target = target; }
174 
182  void setSpan( const Vector2 & left, const Vector2 & right, const Vector2 & preferred );
183 
191  inline bool hasArea() const { return _left * _right < 1.f; }
192 
193  protected:
200 
207 
211  float _speed;
212 
220 
226 
227  };
228 
229  } // namespace Agents
230 } // namespace Menge
231 
232 #endif // __PREF_VELOCITY_H__
Vector2 getLeft() const
Returns the left extent of the span.
Definition: PrefVelocity.h:115
void setSpeed(float speed)
Sets the speed.
Definition: PrefVelocity.h:152
void setTarget(const Vector2 &target)
Sets the target of the preferred velocity.
Definition: PrefVelocity.h:173
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Vector2 _preferred
The preferred direction. All directions in the span may be topologically equivalent, but this direction is the "best". This value must lie within the span (i.e., det( right, preferred ) > 0 and det( preferred, left) > 0).
Definition: PrefVelocity.h:219
Vector2 getTarget() const
Gets the target of the preferred velocity.
Definition: PrefVelocity.h:166
void setSingle(const Vector2 &dir)
Sets the preferred velocity to be a single velocity.
Definition: PrefVelocity.h:159
Vector2 _right
The "right" extent of the preferred velocity span (i.e. det( right, left ) >= 0). This direction has ...
Definition: PrefVelocity.h:206
Vector2 getRight() const
Returns the right extent of the span.
Definition: PrefVelocity.h:122
Vector2 _left
The "left" extent of the preferred velocity span (i.e. det( right, left ) >= 0). This direction has u...
Definition: PrefVelocity.h:199
bool hasArea() const
Reports if the arc spans more than a single direction (by reporting whether the arc has area...
Definition: PrefVelocity.h:191
Vector2 getPreferredVel() const
Returns the preferred *velocity" of the span. This is the preferred direction at the velocity's speed...
Definition: PrefVelocity.h:138
Vector2 _target
The immediate goal point – this corresponds to the preferred direction.
Definition: PrefVelocity.h:225
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
float getSpeed() const
Returns the speed of the preferred velocity.
Definition: PrefVelocity.h:145
Vector2 getPreferred() const
Returns the preferred direction of the span.
Definition: PrefVelocity.h:129
The namespace that contains the basic simulation mechanisms.
float _speed
The preferred speed (also the radius of the arc.
Definition: PrefVelocity.h:211