Files
recastnavigation/classdtFindNearestPolyQuery.html

331 lines
15 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: dtFindNearestPolyQuery 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="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('classdtFindNearestPolyQuery.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="#pub-methods">Public Member Functions</a> &#124;
<a href="classdtFindNearestPolyQuery-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dtFindNearestPolyQuery Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for dtFindNearestPolyQuery:</div>
<div class="dyncontent">
<div class="center">
<img src="classdtFindNearestPolyQuery.png" usemap="#dtFindNearestPolyQuery_map" alt=""/>
<map id="dtFindNearestPolyQuery_map" name="dtFindNearestPolyQuery_map">
<area href="classdtPolyQuery.html" title="Provides custom polygon query behavior." alt="dtPolyQuery" shape="rect" coords="0,0,152,24"/>
</map>
</div></div>
<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:a8900d818df939f8917d5220b854675c6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtFindNearestPolyQuery.html#a8900d818df939f8917d5220b854675c6">dtFindNearestPolyQuery</a> (const <a class="el" href="classdtNavMeshQuery.html">dtNavMeshQuery</a> *query, const float *center)</td></tr>
<tr class="separator:a8900d818df939f8917d5220b854675c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f3122a8f4d6151eb628453b3e99d74c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtFindNearestPolyQuery.html#a0f3122a8f4d6151eb628453b3e99d74c">~dtFindNearestPolyQuery</a> ()</td></tr>
<tr class="separator:a0f3122a8f4d6151eb628453b3e99d74c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72c70bc181bdd635a23e0d2b6df724cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtFindNearestPolyQuery.html#a72c70bc181bdd635a23e0d2b6df724cb">nearestRef</a> () const</td></tr>
<tr class="separator:a72c70bc181bdd635a23e0d2b6df724cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6d790e28c61d28b5ebdcd79373e834c"><td class="memItemLeft" align="right" valign="top">const float *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtFindNearestPolyQuery.html#ad6d790e28c61d28b5ebdcd79373e834c">nearestPoint</a> () const</td></tr>
<tr class="separator:ad6d790e28c61d28b5ebdcd79373e834c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9668cae24253780eebecccde9f023fc7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtFindNearestPolyQuery.html#a9668cae24253780eebecccde9f023fc7">isOverPoly</a> () const</td></tr>
<tr class="separator:a9668cae24253780eebecccde9f023fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70f751a070792e099462d3af34357bcd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtFindNearestPolyQuery.html#a70f751a070792e099462d3af34357bcd">process</a> (const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile, <a class="el" href="structdtPoly.html">dtPoly</a> **polys, <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> *refs, int count)</td></tr>
<tr class="memdesc:a70f751a070792e099462d3af34357bcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called for each batch of unique polygons touched by the search area in <a class="el" href="classdtNavMeshQuery.html#a06e46d57afad3f07380d82bb8d4a6720" title="Finds polygons that overlap the search box.">dtNavMeshQuery::queryPolygons</a>. <a href="classdtFindNearestPolyQuery.html#a70f751a070792e099462d3af34357bcd">More...</a><br /></td></tr>
<tr class="separator:a70f751a070792e099462d3af34357bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classdtPolyQuery"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdtPolyQuery')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classdtPolyQuery.html">dtPolyQuery</a></td></tr>
<tr class="memitem:a9ad241119b015028dc392b33b1b32d68 inherit pub_methods_classdtPolyQuery"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtPolyQuery.html#a9ad241119b015028dc392b33b1b32d68">~dtPolyQuery</a> ()</td></tr>
<tr class="separator:a9ad241119b015028dc392b33b1b32d68 inherit pub_methods_classdtPolyQuery"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8900d818df939f8917d5220b854675c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8900d818df939f8917d5220b854675c6">&#9670;&nbsp;</a></span>dtFindNearestPolyQuery()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dtFindNearestPolyQuery::dtFindNearestPolyQuery </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdtNavMeshQuery.html">dtNavMeshQuery</a> *&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *&#160;</td>
<td class="paramname"><em>center</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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="a0f3122a8f4d6151eb628453b3e99d74c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f3122a8f4d6151eb628453b3e99d74c">&#9670;&nbsp;</a></span>~dtFindNearestPolyQuery()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dtFindNearestPolyQuery::~dtFindNearestPolyQuery </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9668cae24253780eebecccde9f023fc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9668cae24253780eebecccde9f023fc7">&#9670;&nbsp;</a></span>isOverPoly()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dtFindNearestPolyQuery::isOverPoly </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="ad6d790e28c61d28b5ebdcd79373e834c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6d790e28c61d28b5ebdcd79373e834c">&#9670;&nbsp;</a></span>nearestPoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const float* dtFindNearestPolyQuery::nearestPoint </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="a72c70bc181bdd635a23e0d2b6df724cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72c70bc181bdd635a23e0d2b6df724cb">&#9670;&nbsp;</a></span>nearestRef()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> dtFindNearestPolyQuery::nearestRef </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="a70f751a070792e099462d3af34357bcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70f751a070792e099462d3af34357bcd">&#9670;&nbsp;</a></span>process()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dtFindNearestPolyQuery::process </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *&#160;</td>
<td class="paramname"><em>tile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structdtPoly.html">dtPoly</a> **&#160;</td>
<td class="paramname"><em>polys</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>refs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>count</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called for each batch of unique polygons touched by the search area in <a class="el" href="classdtNavMeshQuery.html#a06e46d57afad3f07380d82bb8d4a6720" title="Finds polygons that overlap the search box.">dtNavMeshQuery::queryPolygons</a>. </p>
<p>This can be called multiple times for a single query. </p>
<p>Implements <a class="el" href="classdtPolyQuery.html#a21184a157b5762bc558ac49e43a1131e">dtPolyQuery</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DetourNavMeshQuery_8cpp.html">DetourNavMeshQuery.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="classdtFindNearestPolyQuery.html">dtFindNearestPolyQuery</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>