Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Route.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 __ROUTE_H__
45 #define __ROUTE_H__
46 
47 #include "WayPortal.h"
48 #include <vector>
49 
50 namespace Menge {
51 
52  // FORWARD DECLARATIONS
53  class PathPlanner;
54  class NavMeshEdge;
55 
60  class PortalRoute {
61  public:
68  PortalRoute( unsigned int start, unsigned int end );
69 
73  ~PortalRoute();
74 
80  inline unsigned int getStartNode() const { return _startNode; }
81 
87  inline unsigned int getEndNode() const { return _endNode; }
88 
94  inline size_t getPortalCount() const { return _portals.size(); }
95 
103  inline unsigned int getPortalNode( size_t i ) const { return _portals[ i ]._nodeID; }
104 
111  WayPortal * getPortal( size_t i ) { return &_portals[i]; }
112 
119  const WayPortal * getPortal( size_t i ) const { return &_portals[i]; }
120 
128  void appendWayPortal( const NavMeshEdge * edge, unsigned int node );
129 
139  bool isEquivalent( const PortalRoute * route );
140 
144  float getLength() const { return _length; }
145 
146  friend class PathPlanner;
147 
148  protected:
149 
153  unsigned int _startNode;
154 
158  unsigned int _endNode;
159 
163  float _maxWidth;
164 
170 
174  float _length;
175 
179  std::vector< WayPortal > _portals;
180  };
181 } // namespace Menge
182 
183 #endif // __ROUTE_H__
184 
PortalRoute(unsigned int start, unsigned int end)
Constructor.
Definition: Route.cpp:49
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
float _maxWidth
The maximum width an agent can be to take this route.
Definition: Route.h:163
unsigned int getStartNode() const
Returns the identifier for the first node on the route.
Definition: Route.h:80
bool isEquivalent(const PortalRoute *route)
Reports if the two routes have the same envelope.
Definition: Route.cpp:68
void appendWayPortal(const NavMeshEdge *edge, unsigned int node)
Appends a way portal to the path.
Definition: Route.cpp:59
unsigned int getPortalNode(size_t i) const
Reports the node for the ith portal.
Definition: Route.h:103
~PortalRoute()
Destructor.
Definition: Route.cpp:54
unsigned int _endNode
The end node.
Definition: Route.h:158
The navigation mesh adjacency graph edge.
Definition: NavMeshEdge.h:72
unsigned int _startNode
The start node.
Definition: Route.h:153
Class for computing paths through a navigation mesh.
Definition: PathPlanner.h:133
float _length
The length of the route.
Definition: Route.h:174
The definition of a route through a navigation mesh from a start to an end node.
Definition: Route.h:60
WayPortal * getPortal(size_t i)
Gets the ith portal.
Definition: Route.h:111
const WayPortal * getPortal(size_t i) const
Gets a const version of the ith portal.
Definition: Route.h:119
std::vector< WayPortal > _portals
The list of portals to pass through along the route.
Definition: Route.h:179
float getLength() const
Report the length of the path.
Definition: Route.h:144
Defines a way portal for a navigation mesh route/path.
size_t getPortalCount() const
Reports the number of portals on the route.
Definition: Route.h:94
float _bestSmallest
The smallest agent width for which this has proven to be the optimal path.
Definition: Route.h:169
unsigned int getEndNode() const
Returns the identifier for the destination node on the route.
Definition: Route.h:87