Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
WayPortal.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 __WAY_PORTAL_H__
45 #define __WAY_PORTAL_H__
46 
47 #include "NavMeshEdge.h"
48 
49 namespace Menge {
50 
51  // FORWARD DECLARATIONS
52  class PortalRoute;
53  class PortalPath;
54  namespace Agents {
55  class PrefVelocity;
56  }
57 
64  class WayPortal {
65  public:
76  WayPortal( const NavMeshEdge * edge, unsigned int nodeID, bool p0IsLeft );
77 
84  inline Vector2 getLeft() const { return _p0IsLeft ? _edge->getP0() : _edge->getP1(); }
85 
93  inline Vector2 getLeft( float offset ) const { return _p0IsLeft ? _edge->getP0( offset ) : _edge->getP1( offset ); }
94 
101  inline Vector2 getRight() const { return _p0IsLeft ? _edge->getP1() : _edge->getP0(); }
102 
110  inline Vector2 getRight( float offset ) const { return _p0IsLeft ? _edge->getP1( offset ) : _edge->getP0( offset ); }
111 
122  Vector2 intersectionPoint( const Vector2 & point, const Vector2 & dir ) const;
123 
133  void setPreferredDirection( const Vector2 & pos, float radius, const Vector2 & dir, Agents::PrefVelocity & pVel ) const;
134 
135  friend class PortalRoute;
136  friend class PortalPath;
137 
138  protected:
143 
149  unsigned int _nodeID;
150 
156  bool _p0IsLeft;
157  };
158 
159 } // namespace Menge
160 #endif // __WAY_PORTAL_H__
Vector2 getP1() const
Returns the second edge point.
Definition: NavMeshEdge.h:104
The basic structure defining a way "point" along a path through a navigation mesh. It consists of the navigation mesh edge to pass through and the node one should be in while heading to the edge.
Definition: WayPortal.h:64
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
void setPreferredDirection(const Vector2 &pos, float radius, const Vector2 &dir, Agents::PrefVelocity &pVel) const
Sets the directions on the preferred velocity based on the wayportal.
Definition: WayPortal.cpp:52
The navigation mesh adjacency graph edge.
Definition: NavMeshEdge.h:72
unsigned int _nodeID
The index of the node in which the agent is traveling toward the edge. It should be true that the spe...
Definition: WayPortal.h:149
The definition of a route through a navigation mesh from a start to an end node.
Definition: Route.h:60
Defines the "edge" of the adjacency graph in a navigation mesh.
bool _p0IsLeft
Reports if the edge's P0 is the left vertex. Left is defined based on moving across the portal from t...
Definition: WayPortal.h:156
Vector2 intersectionPoint(const Vector2 &point, const Vector2 &dir) const
Computes the intersection point of the given line with this portal.
Definition: WayPortal.cpp:59
Vector2 getRight(float offset) const
Retrives the position in the portal offset from the right physical vertex.
Definition: WayPortal.h:110
Vector2 getRight() const
Retrives the right physical vertex of the portal.
Definition: WayPortal.h:101
Vector2 getLeft(float offset) const
Retrives the position in the portal offset from the left physical vertex.
Definition: WayPortal.h:93
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
WayPortal(const NavMeshEdge *edge, unsigned int nodeID, bool p0IsLeft)
Constructor.
Definition: WayPortal.cpp:47
The definition of a path through space comprising of a sequence of portals.
Definition: PortalPath.h:70
The namespace that contains the basic simulation mechanisms.
const NavMeshEdge * _edge
The edge which serves as goal.
Definition: WayPortal.h:142
Vector2 getP0() const
Returns the first edge point.
Definition: NavMeshEdge.h:89
Vector2 getLeft() const
Retrives the left physical vertex of the portal.
Definition: WayPortal.h:84