Files
recastnavigation/classdtPathQueue.html

353 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Recast Navigation: dtPathQueue Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Recast Navigation
</div>
<div id="projectbrief">Navigation-mesh Toolset for Games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classdtPathQueue.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdtPathQueue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dtPathQueue Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="DetourPathQueue_8h_source.html">DetourPathQueue.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a586a27d4f141dd4d47f3f92bad82be1c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#a586a27d4f141dd4d47f3f92bad82be1c">dtPathQueue</a> ()</td></tr>
<tr class="separator:a586a27d4f141dd4d47f3f92bad82be1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aed72cee418c920b5fbdc247845dae3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#a3aed72cee418c920b5fbdc247845dae3">~dtPathQueue</a> ()</td></tr>
<tr class="separator:a3aed72cee418c920b5fbdc247845dae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb36a7890f01f2dbc9be362282538803"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#afb36a7890f01f2dbc9be362282538803">init</a> (const int maxPathSize, const int maxSearchNodeCount, <a class="el" href="classdtNavMesh.html">dtNavMesh</a> *nav)</td></tr>
<tr class="separator:afb36a7890f01f2dbc9be362282538803"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab28e659d2db86d9f5d5246811cb08da0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#ab28e659d2db86d9f5d5246811cb08da0">update</a> (const int maxIters)</td></tr>
<tr class="separator:ab28e659d2db86d9f5d5246811cb08da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc95d9bf0e1b12543be41c3ca938e994"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourPathQueue_8h.html#ab97a1eb15082a50b8b7b781a715f5f74">dtPathQueueRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#acc95d9bf0e1b12543be41c3ca938e994">request</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> startRef, <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> endRef, const float *startPos, const float *endPos, const <a class="el" href="classdtQueryFilter.html">dtQueryFilter</a> *filter)</td></tr>
<tr class="separator:acc95d9bf0e1b12543be41c3ca938e994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b1a005dfc3d8d3efd1bb4bc46f49e32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#a2b1a005dfc3d8d3efd1bb4bc46f49e32">getRequestStatus</a> (<a class="el" href="DetourPathQueue_8h.html#ab97a1eb15082a50b8b7b781a715f5f74">dtPathQueueRef</a> ref) const</td></tr>
<tr class="separator:a2b1a005dfc3d8d3efd1bb4bc46f49e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6599518fe1e3c0e4c7d8c3cba062aeab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#a6599518fe1e3c0e4c7d8c3cba062aeab">getPathResult</a> (<a class="el" href="DetourPathQueue_8h.html#ab97a1eb15082a50b8b7b781a715f5f74">dtPathQueueRef</a> ref, <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> *path, int *pathSize, const int maxPath)</td></tr>
<tr class="separator:a6599518fe1e3c0e4c7d8c3cba062aeab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4fb7d75b1b65ad1db89782f8ad4e8da"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classdtNavMeshQuery.html">dtNavMeshQuery</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPathQueue.html#ad4fb7d75b1b65ad1db89782f8ad4e8da">getNavQuery</a> () const</td></tr>
<tr class="separator:ad4fb7d75b1b65ad1db89782f8ad4e8da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a586a27d4f141dd4d47f3f92bad82be1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a586a27d4f141dd4d47f3f92bad82be1c">&#9670;&nbsp;</a></span>dtPathQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtPathQueue::dtPathQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3aed72cee418c920b5fbdc247845dae3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aed72cee418c920b5fbdc247845dae3">&#9670;&nbsp;</a></span>~dtPathQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtPathQueue::~dtPathQueue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad4fb7d75b1b65ad1db89782f8ad4e8da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4fb7d75b1b65ad1db89782f8ad4e8da">&#9670;&nbsp;</a></span>getNavQuery()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classdtNavMeshQuery.html">dtNavMeshQuery</a>* dtPathQueue::getNavQuery </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6599518fe1e3c0e4c7d8c3cba062aeab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6599518fe1e3c0e4c7d8c3cba062aeab">&#9670;&nbsp;</a></span>getPathResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtPathQueue::getPathResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="DetourPathQueue_8h.html#ab97a1eb15082a50b8b7b781a715f5f74">dtPathQueueRef</a>&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> *&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>pathSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>maxPath</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2b1a005dfc3d8d3efd1bb4bc46f49e32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b1a005dfc3d8d3efd1bb4bc46f49e32">&#9670;&nbsp;</a></span>getRequestStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtPathQueue::getRequestStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="DetourPathQueue_8h.html#ab97a1eb15082a50b8b7b781a715f5f74">dtPathQueueRef</a>&#160;</td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afb36a7890f01f2dbc9be362282538803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb36a7890f01f2dbc9be362282538803">&#9670;&nbsp;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool dtPathQueue::init </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>maxPathSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>maxSearchNodeCount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtNavMesh.html">dtNavMesh</a> *&#160;</td>
<td class="paramname"><em>nav</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acc95d9bf0e1b12543be41c3ca938e994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc95d9bf0e1b12543be41c3ca938e994">&#9670;&nbsp;</a></span>request()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="DetourPathQueue_8h.html#ab97a1eb15082a50b8b7b781a715f5f74">dtPathQueueRef</a> dtPathQueue::request </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td>
<td class="paramname"><em>startRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td>
<td class="paramname"><em>endRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *&#160;</td>
<td class="paramname"><em>startPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *&#160;</td>
<td class="paramname"><em>endPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classdtQueryFilter.html">dtQueryFilter</a> *&#160;</td>
<td class="paramname"><em>filter</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab28e659d2db86d9f5d5246811cb08da0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab28e659d2db86d9f5d5246811cb08da0">&#9670;&nbsp;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dtPathQueue::update </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>maxIters</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="DetourPathQueue_8h_source.html">DetourPathQueue.h</a></li>
<li><a class="el" href="DetourPathQueue_8cpp.html">DetourPathQueue.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classdtPathQueue.html">dtPathQueue</a></li>
&nbsp;&nbsp;<a href="https://github.com/recastnavigation/recastnavigation">Project Home</a>
| <a href="./License.txt">Licence (ZLib)</a>
| Copyright 2009 Mikko Mononen
</ul>
</div>
</body>
</html>