Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Portal.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 __PORTAL_H__
46 #define __PORTAL_H__
47 
48 #include "mengeCommon.h"
49 
50 namespace Menge {
51 
57  class Portal {
58  public:
62  Portal():_p0(0.f,0.f), _p1(0.f,0.f), _mag(0.f), _dir(1.f,0.f) {}
63 
72  Portal( float x0, float y0, float x1, float y1 );
73 
82  void set( float x0, float y0, float x1, float y1 );
83 
90  void set( const Vector2 & p0, const Vector2 & p1 );
91 
107  Vector2 nearestPoint( const Vector2 & pos, float radius );
108 
113 
118 
122  float _mag;
123 
128  };
129 } // namespace Menge
130 #endif // __PORTAL_H__
A simple portal definition.
Definition: Portal.h:57
Vector2 _p0
The first end point of the portal line segment.
Definition: Portal.h:112
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Portal()
Default constructor.
Definition: Portal.h:62
void set(float x0, float y0, float x1, float y1)
Sets the geometry of the portal.
Definition: Portal.cpp:55
float _mag
The distance between endpoints (i.e., length of the portal).
Definition: Portal.h:122
Vector2 nearestPoint(const Vector2 &pos, float radius)
Computes the neareset clearable point w.r.t. the portal.
Definition: Portal.cpp:75
Vector2 _dir
The direction from the first to the second end point of the portal.
Definition: Portal.h:127
Vector2 _p1
The second end point of the portal line segment.
Definition: Portal.h:117