The definition of a route through a navigation mesh from a start to an end node.
More...
#include <Route.h>
|
unsigned int | _startNode |
| The start node.
|
|
unsigned int | _endNode |
| The end node.
|
|
float | _maxWidth |
| The maximum width an agent can be to take this route.
|
|
float | _bestSmallest |
| The smallest agent width for which this has proven to be the optimal path.
|
|
float | _length |
| The length of the route.
|
|
std::vector< WayPortal > | _portals |
| The list of portals to pass through along the route.
|
|
The definition of a route through a navigation mesh from a start to an end node.
Menge::PortalRoute::PortalRoute |
( |
unsigned int |
start, |
|
|
unsigned int |
end |
|
) |
| |
Constructor.
- Parameters
-
start | The index of the start node of the route. |
end | The index of the end node of the rotue. |
void Menge::PortalRoute::appendWayPortal |
( |
const NavMeshEdge * |
edge, |
|
|
unsigned int |
node |
|
) |
| |
Appends a way portal to the path.
- Parameters
-
edge | The edge forming the portal |
node | The node in which the agent should be traveling toward the edge |
unsigned int Menge::PortalRoute::getEndNode |
( |
| ) |
const |
|
inline |
Returns the identifier for the destination node on the route.
- Returns
- The destination node's index.
WayPortal* Menge::PortalRoute::getPortal |
( |
size_t |
i | ) |
|
|
inline |
Gets the ith portal.
- Parameters
-
i | The path-local index of the portal. |
- Returns
- A pointer to the ith portal.
const WayPortal* Menge::PortalRoute::getPortal |
( |
size_t |
i | ) |
const |
|
inline |
Gets a const version of the ith portal.
- Parameters
-
i | The path-local index of the portal. |
- Returns
- A pointer to the ith portal.
size_t Menge::PortalRoute::getPortalCount |
( |
| ) |
const |
|
inline |
Reports the number of portals on the route.
- Returns
- The number of portals on the route.
unsigned int Menge::PortalRoute::getPortalNode |
( |
size_t |
i | ) |
const |
|
inline |
Reports the node for the ith portal.
- Parameters
-
i | The index of the portal. |
- Returns
- The index of the node the agent should be in when moving toward the ith portal.
unsigned int Menge::PortalRoute::getStartNode |
( |
| ) |
const |
|
inline |
Returns the identifier for the first node on the route.
- Returns
- The first node's index.
bool Menge::PortalRoute::isEquivalent |
( |
const PortalRoute * |
route | ) |
|
Reports if the two routes have the same envelope.
Two routes are equivalent if they have the same sequence of nav mesh nodes. It is assumed that they have the same start and end nodes.
- Parameters
-
route | The route to compare with this. |
- Returns
- True if the two routes are equivalent. False otherwise.
The documentation for this class was generated from the following files:
- src/menge/MengeCore/resources/Route.h
- src/menge/MengeCore/resources/Route.cpp