Files
recastnavigation/DetourTileCache_8h.html

320 lines
18 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: DetourTileCache.h File 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('DetourTileCache_8h.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="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">DetourTileCache.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="DetourStatus_8h_source.html">DetourStatus.h</a>&quot;</code><br />
</div>
<p><a href="DetourTileCache_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtCompressedTile.html">dtCompressedTile</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtObstacleCylinder.html">dtObstacleCylinder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtObstacleBox.html">dtObstacleBox</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtObstacleOrientedBox.html">dtObstacleOrientedBox</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtTileCacheObstacle.html">dtTileCacheObstacle</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtTileCacheParams.html">dtTileCacheParams</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtTileCacheMeshProcess.html">dtTileCacheMeshProcess</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdtTileCache.html">dtTileCache</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a98ea3fd044afb85907f03e6de505fa75"><td class="memItemLeft" align="right" valign="top">typedef unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#a98ea3fd044afb85907f03e6de505fa75">dtObstacleRef</a></td></tr>
<tr class="separator:a98ea3fd044afb85907f03e6de505fa75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3892eb9546be426b84e906846ada2f6"><td class="memItemLeft" align="right" valign="top">typedef unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#ae3892eb9546be426b84e906846ada2f6">dtCompressedTileRef</a></td></tr>
<tr class="separator:ae3892eb9546be426b84e906846ada2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae7bbfdb463ce9748076a000e6a4f95e7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#ae7bbfdb463ce9748076a000e6a4f95e7">dtCompressedTileFlags</a> { <a class="el" href="DetourTileCache_8h.html#ae7bbfdb463ce9748076a000e6a4f95e7ae39535ace91c26741052d77c5a2dcb8d">DT_COMPRESSEDTILE_FREE_DATA</a> = 0x01
}</td></tr>
<tr class="memdesc:ae7bbfdb463ce9748076a000e6a4f95e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags for addTile. <a href="DetourTileCache_8h.html#ae7bbfdb463ce9748076a000e6a4f95e7">More...</a><br /></td></tr>
<tr class="separator:ae7bbfdb463ce9748076a000e6a4f95e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7ed646a7dd7b710737b2f9519ba6be0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#aa7ed646a7dd7b710737b2f9519ba6be0">ObstacleState</a> { <a class="el" href="DetourTileCache_8h.html#aa7ed646a7dd7b710737b2f9519ba6be0a094b269c342db86c17d4e378a5b40e91">DT_OBSTACLE_EMPTY</a>
, <a class="el" href="DetourTileCache_8h.html#aa7ed646a7dd7b710737b2f9519ba6be0addaffc9e5b62b3804b907d00dd29cc16">DT_OBSTACLE_PROCESSING</a>
, <a class="el" href="DetourTileCache_8h.html#aa7ed646a7dd7b710737b2f9519ba6be0a4498b976355b555e4f3f44f83a1c00f4">DT_OBSTACLE_PROCESSED</a>
, <a class="el" href="DetourTileCache_8h.html#aa7ed646a7dd7b710737b2f9519ba6be0a994e7077e1e02ba53b4b00d5cf0430fb">DT_OBSTACLE_REMOVING</a>
}</td></tr>
<tr class="separator:aa7ed646a7dd7b710737b2f9519ba6be0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9852a22595ceae4debd70f078e037971"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#a9852a22595ceae4debd70f078e037971">ObstacleType</a> { <a class="el" href="DetourTileCache_8h.html#a9852a22595ceae4debd70f078e037971a766d09d1314b46ef10e4841c3bee531f">DT_OBSTACLE_CYLINDER</a>
, <a class="el" href="DetourTileCache_8h.html#a9852a22595ceae4debd70f078e037971ab654da18354a922d963354e55469a66b">DT_OBSTACLE_BOX</a>
, <a class="el" href="DetourTileCache_8h.html#a9852a22595ceae4debd70f078e037971ab58715685be1dff92c88c3e008f16b04">DT_OBSTACLE_ORIENTED_BOX</a>
}</td></tr>
<tr class="separator:a9852a22595ceae4debd70f078e037971"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abbf86fa9f52a802f0a1005b9dfd31b53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdtTileCache.html">dtTileCache</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#abbf86fa9f52a802f0a1005b9dfd31b53">dtAllocTileCache</a> ()</td></tr>
<tr class="separator:abbf86fa9f52a802f0a1005b9dfd31b53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7924ac4ce94c94affdfbe6a07cea976"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#ac7924ac4ce94c94affdfbe6a07cea976">dtFreeTileCache</a> (<a class="el" href="classdtTileCache.html">dtTileCache</a> *tc)</td></tr>
<tr class="separator:ac7924ac4ce94c94affdfbe6a07cea976"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a3d05fd569d4f9cb51f3c99cbbdf97e22"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DetourTileCache_8h.html#a3d05fd569d4f9cb51f3c99cbbdf97e22">DT_MAX_TOUCHED_TILES</a> = 8</td></tr>
<tr class="separator:a3d05fd569d4f9cb51f3c99cbbdf97e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ae3892eb9546be426b84e906846ada2f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3892eb9546be426b84e906846ada2f6">&#9670;&nbsp;</a></span>dtCompressedTileRef</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned int <a class="el" href="DetourTileCache_8h.html#ae3892eb9546be426b84e906846ada2f6">dtCompressedTileRef</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a98ea3fd044afb85907f03e6de505fa75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98ea3fd044afb85907f03e6de505fa75">&#9670;&nbsp;</a></span>dtObstacleRef</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned int <a class="el" href="DetourTileCache_8h.html#a98ea3fd044afb85907f03e6de505fa75">dtObstacleRef</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ae7bbfdb463ce9748076a000e6a4f95e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7bbfdb463ce9748076a000e6a4f95e7">&#9670;&nbsp;</a></span>dtCompressedTileFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="DetourTileCache_8h.html#ae7bbfdb463ce9748076a000e6a4f95e7">dtCompressedTileFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags for addTile. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae7bbfdb463ce9748076a000e6a4f95e7ae39535ace91c26741052d77c5a2dcb8d"></a>DT_COMPRESSEDTILE_FREE_DATA&#160;</td><td class="fielddoc"><p>Navmesh owns the tile memory and should free it. </p>
</td></tr>
</table>
</div>
</div>
<a id="aa7ed646a7dd7b710737b2f9519ba6be0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7ed646a7dd7b710737b2f9519ba6be0">&#9670;&nbsp;</a></span>ObstacleState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="DetourTileCache_8h.html#aa7ed646a7dd7b710737b2f9519ba6be0">ObstacleState</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa7ed646a7dd7b710737b2f9519ba6be0a094b269c342db86c17d4e378a5b40e91"></a>DT_OBSTACLE_EMPTY&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa7ed646a7dd7b710737b2f9519ba6be0addaffc9e5b62b3804b907d00dd29cc16"></a>DT_OBSTACLE_PROCESSING&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa7ed646a7dd7b710737b2f9519ba6be0a4498b976355b555e4f3f44f83a1c00f4"></a>DT_OBSTACLE_PROCESSED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="aa7ed646a7dd7b710737b2f9519ba6be0a994e7077e1e02ba53b4b00d5cf0430fb"></a>DT_OBSTACLE_REMOVING&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a9852a22595ceae4debd70f078e037971"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9852a22595ceae4debd70f078e037971">&#9670;&nbsp;</a></span>ObstacleType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="DetourTileCache_8h.html#a9852a22595ceae4debd70f078e037971">ObstacleType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9852a22595ceae4debd70f078e037971a766d09d1314b46ef10e4841c3bee531f"></a>DT_OBSTACLE_CYLINDER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9852a22595ceae4debd70f078e037971ab654da18354a922d963354e55469a66b"></a>DT_OBSTACLE_BOX&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9852a22595ceae4debd70f078e037971ab58715685be1dff92c88c3e008f16b04"></a>DT_OBSTACLE_ORIENTED_BOX&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="abbf86fa9f52a802f0a1005b9dfd31b53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbf86fa9f52a802f0a1005b9dfd31b53">&#9670;&nbsp;</a></span>dtAllocTileCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdtTileCache.html">dtTileCache</a>* dtAllocTileCache </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac7924ac4ce94c94affdfbe6a07cea976"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7924ac4ce94c94affdfbe6a07cea976">&#9670;&nbsp;</a></span>dtFreeTileCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dtFreeTileCache </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdtTileCache.html">dtTileCache</a> *&#160;</td>
<td class="paramname"><em>tc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a3d05fd569d4f9cb51f3c99cbbdf97e22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d05fd569d4f9cb51f3c99cbbdf97e22">&#9670;&nbsp;</a></span>DT_MAX_TOUCHED_TILES</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int DT_MAX_TOUCHED_TILES = 8</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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="dir_76ba9689d458e28c6a6af5e586a54235.html">DetourTileCache</a></li><li class="navelem"><a class="el" href="dir_1103d4975f5090865f21f06eb0a41e57.html">Include</a></li><li class="navelem"><a class="el" href="DetourTileCache_8h.html">DetourTileCache.h</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>