Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-08-30 15:08:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e9617a8433d67e80dbb2c2dbfa8dfc45160e55ea
recastnavigation/classdtQueryFilter.html

546 lines
27 KiB
HTML
Raw Blame History

<!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: dtQueryFilter 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('classdtQueryFilter.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="classdtQueryFilter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dtQueryFilter Class Reference<div class="ingroups"><a class="el" href="group__detour.html">Detour</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Defines polygon filtering and traversal costs for navigation mesh query operations.
<a href="classdtQueryFilter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DetourNavMeshQuery_8h_source.html">DetourNavMeshQuery.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:ad686b0d14e2826de3b674c663f7f1456"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#ad686b0d14e2826de3b674c663f7f1456">dtQueryFilter</a> ()</td></tr>
<tr class="separator:ad686b0d14e2826de3b674c663f7f1456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf072b8617dfbd4701a8e07f0f10be9c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#aaf072b8617dfbd4701a8e07f0f10be9c">passFilter</a> (const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref, const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile, const <a class="el" href="structdtPoly.html">dtPoly</a> *poly) const</td></tr>
<tr class="memdesc:aaf072b8617dfbd4701a8e07f0f10be9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the polygon can be visited. <a href="classdtQueryFilter.html#aaf072b8617dfbd4701a8e07f0f10be9c">More...</a><br /></td></tr>
<tr class="separator:aaf072b8617dfbd4701a8e07f0f10be9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11d016505b732a1a013c3771a4157dea"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#a11d016505b732a1a013c3771a4157dea">getCost</a> (const float *pa, const float *pb, const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> prevRef, const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *prevTile, const <a class="el" href="structdtPoly.html">dtPoly</a> *prevPoly, const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> curRef, const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *curTile, const <a class="el" href="structdtPoly.html">dtPoly</a> *curPoly, const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> nextRef, const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *nextTile, const <a class="el" href="structdtPoly.html">dtPoly</a> *nextPoly) const</td></tr>
<tr class="memdesc:a11d016505b732a1a013c3771a4157dea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns cost to move from the beginning to the end of a line segment that is fully contained within a polygon. <a href="classdtQueryFilter.html#a11d016505b732a1a013c3771a4157dea">More...</a><br /></td></tr>
<tr class="separator:a11d016505b732a1a013c3771a4157dea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Getters and setters for the default implementation data.</div></td></tr>
<tr class="memitem:a1e41582a45d2a10eb7e68740475e5665"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#a1e41582a45d2a10eb7e68740475e5665">getAreaCost</a> (const int i) const</td></tr>
<tr class="memdesc:a1e41582a45d2a10eb7e68740475e5665"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the traversal cost of the area. <a href="classdtQueryFilter.html#a1e41582a45d2a10eb7e68740475e5665">More...</a><br /></td></tr>
<tr class="separator:a1e41582a45d2a10eb7e68740475e5665"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36063c39d5c391a393412108a8a33927"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#a36063c39d5c391a393412108a8a33927">setAreaCost</a> (const int i, const float cost)</td></tr>
<tr class="memdesc:a36063c39d5c391a393412108a8a33927"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the traversal cost of the area. <a href="classdtQueryFilter.html#a36063c39d5c391a393412108a8a33927">More...</a><br /></td></tr>
<tr class="separator:a36063c39d5c391a393412108a8a33927"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bae688840167576dc6ab7913dda1b34"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#a5bae688840167576dc6ab7913dda1b34">getIncludeFlags</a> () const</td></tr>
<tr class="memdesc:a5bae688840167576dc6ab7913dda1b34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the include flags for the filter. <a href="classdtQueryFilter.html#a5bae688840167576dc6ab7913dda1b34">More...</a><br /></td></tr>
<tr class="separator:a5bae688840167576dc6ab7913dda1b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9783c92a30e41df84ebfd2f68338970"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#ab9783c92a30e41df84ebfd2f68338970">setIncludeFlags</a> (const unsigned short flags)</td></tr>
<tr class="memdesc:ab9783c92a30e41df84ebfd2f68338970"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the include flags for the filter. <a href="classdtQueryFilter.html#ab9783c92a30e41df84ebfd2f68338970">More...</a><br /></td></tr>
<tr class="separator:ab9783c92a30e41df84ebfd2f68338970"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3e2d16755c3510003f0580e27ce4897"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#ac3e2d16755c3510003f0580e27ce4897">getExcludeFlags</a> () const</td></tr>
<tr class="memdesc:ac3e2d16755c3510003f0580e27ce4897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the exclude flags for the filter. <a href="classdtQueryFilter.html#ac3e2d16755c3510003f0580e27ce4897">More...</a><br /></td></tr>
<tr class="separator:ac3e2d16755c3510003f0580e27ce4897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18c1b888c9b2c3b30703d6861a793600"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtQueryFilter.html#a18c1b888c9b2c3b30703d6861a793600">setExcludeFlags</a> (const unsigned short flags)</td></tr>
<tr class="memdesc:a18c1b888c9b2c3b30703d6861a793600"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the exclude flags for the filter. <a href="classdtQueryFilter.html#a18c1b888c9b2c3b30703d6861a793600">More...</a><br /></td></tr>
<tr class="separator:a18c1b888c9b2c3b30703d6861a793600"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Defines polygon filtering and traversal costs for navigation mesh query operations. </p>
<p><b>The Default Implementation</b></p>
<p>At construction: All area costs default to 1.0. All flags are included and none are excluded.</p>
<p>If a polygon has both an include and an exclude flag, it will be excluded.</p>
<p>The way filtering works, a navigation mesh polygon must have at least one flag set to ever be considered by a query. So a polygon with no flags will never be considered.</p>
<p>Setting the include flags to 0 will result in all polygons being excluded.</p>
<p><b>Custom Implementations</b></p>
<p>DT_VIRTUAL_QUERYFILTER must be defined in order to extend this class.</p>
<p>Implement a custom query filter by overriding the virtual <a class="el" href="classdtQueryFilter.html#aaf072b8617dfbd4701a8e07f0f10be9c" title="Returns true if the polygon can be visited.">passFilter()</a> and <a class="el" href="classdtQueryFilter.html#a11d016505b732a1a013c3771a4157dea" title="Returns cost to move from the beginning to the end of a line segment that is fully contained within a...">getCost()</a> functions. If this is done, both functions should be as fast as possible. Use cached local copies of data rather than accessing your own objects where possible.</p>
<p>Custom implementations do not need to adhere to the flags or cost logic used by the default implementation. <br />
</p>
<p>In order for A* searches to work properly, the cost should be proportional to the travel distance. Implementing a cost modifier less than 1.0 is likely to lead to problems during pathfinding.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMeshQuery.html" title="Provides the ability to perform pathfinding related queries against a navigation mesh.">dtNavMeshQuery</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad686b0d14e2826de3b674c663f7f1456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad686b0d14e2826de3b674c663f7f1456">&#9670;&nbsp;</a></span>dtQueryFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtQueryFilter::dtQueryFilter </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="a1e41582a45d2a10eb7e68740475e5665"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e41582a45d2a10eb7e68740475e5665">&#9670;&nbsp;</a></span>getAreaCost()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float dtQueryFilter::getAreaCost </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>i</em></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">
<p>Returns the traversal cost of the area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>The id of the area. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The traversal cost of the area. </dd></dl>
</div>
</div>
<a id="a11d016505b732a1a013c3771a4157dea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11d016505b732a1a013c3771a4157dea">&#9670;&nbsp;</a></span>getCost()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float dtQueryFilter::getCost </td>
<td>(</td>
<td class="paramtype">const float *&#160;</td>
<td class="paramname"><em>pa</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float *&#160;</td>
<td class="paramname"><em>pb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td>
<td class="paramname"><em>prevRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *&#160;</td>
<td class="paramname"><em>prevTile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structdtPoly.html">dtPoly</a> *&#160;</td>
<td class="paramname"><em>prevPoly</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td>
<td class="paramname"><em>curRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *&#160;</td>
<td class="paramname"><em>curTile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structdtPoly.html">dtPoly</a> *&#160;</td>
<td class="paramname"><em>curPoly</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td>
<td class="paramname"><em>nextRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *&#160;</td>
<td class="paramname"><em>nextTile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structdtPoly.html">dtPoly</a> *&#160;</td>
<td class="paramname"><em>nextPoly</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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">
<p>Returns cost to move from the beginning to the end of a line segment that is fully contained within a polygon. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pa</td><td>The start position on the edge of the previous and current polygon. [(x, y, z)] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pb</td><td>The end position on the edge of the current and next polygon. [(x, y, z)] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prevRef</td><td>The reference id of the previous polygon. [opt] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prevTile</td><td>The tile containing the previous polygon. [opt] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prevPoly</td><td>The previous polygon. [opt] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">curRef</td><td>The reference id of the current polygon. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">curTile</td><td>The tile containing the current polygon. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">curPoly</td><td>The current polygon. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nextRef</td><td>The refernece id of the next polygon. [opt] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nextTile</td><td>The tile containing the next polygon. [opt] </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nextPoly</td><td>The next polygon. [opt] </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac3e2d16755c3510003f0580e27ce4897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3e2d16755c3510003f0580e27ce4897">&#9670;&nbsp;</a></span>getExcludeFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned short dtQueryFilter::getExcludeFlags </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">
<p>Returns the exclude flags for the filter. </p>
<p>Any polygons that include one ore more of these flags will be excluded from the operation. </p>
</div>
</div>
<a id="a5bae688840167576dc6ab7913dda1b34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bae688840167576dc6ab7913dda1b34">&#9670;&nbsp;</a></span>getIncludeFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned short dtQueryFilter::getIncludeFlags </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">
<p>Returns the include flags for the filter. </p>
<p>Any polygons that include one or more of these flags will be included in the operation. </p>
</div>
</div>
<a id="aaf072b8617dfbd4701a8e07f0f10be9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf072b8617dfbd4701a8e07f0f10be9c">&#9670;&nbsp;</a></span>passFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dtQueryFilter::passFilter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></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">const <a class="el" href="structdtPoly.html">dtPoly</a> *&#160;</td>
<td class="paramname"><em>poly</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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">
<p>Returns true if the polygon can be visited. </p>
<p>(I.e. Is traversable.) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The reference id of the polygon test. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tile</td><td>The tile containing the polygon. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">poly</td><td>The polygon to test. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a36063c39d5c391a393412108a8a33927"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36063c39d5c391a393412108a8a33927">&#9670;&nbsp;</a></span>setAreaCost()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dtQueryFilter::setAreaCost </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float&#160;</td>
<td class="paramname"><em>cost</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">
<p>Sets the traversal cost of the area. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>The id of the area. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cost</td><td>The new cost of traversing the area. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a18c1b888c9b2c3b30703d6861a793600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c1b888c9b2c3b30703d6861a793600">&#9670;&nbsp;</a></span>setExcludeFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dtQueryFilter::setExcludeFlags </td>
<td>(</td>
<td class="paramtype">const unsigned short&#160;</td>
<td class="paramname"><em>flags</em></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">
<p>Sets the exclude flags for the filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The new flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab9783c92a30e41df84ebfd2f68338970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9783c92a30e41df84ebfd2f68338970">&#9670;&nbsp;</a></span>setIncludeFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dtQueryFilter::setIncludeFlags </td>
<td>(</td>
<td class="paramtype">const unsigned short&#160;</td>
<td class="paramname"><em>flags</em></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">
<p>Sets the include flags for the filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The new flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="DetourNavMeshQuery_8h_source.html">DetourNavMeshQuery.h</a></li>
<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="classdtQueryFilter.html">dtQueryFilter</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>
Reference in New Issue View Git Blame Copy Permalink