mirror of
https://github.com/recastnavigation/recastnavigation.git
synced 2026-08-30 23:18:40 +00:00
1543 lines
90 KiB
HTML
1543 lines
90 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: dtNavMesh 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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classdtNavMesh.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> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classdtNavMesh-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">dtNavMesh Class Reference<div class="ingroups"><a class="el" href="group__detour.html">Detour</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A navigation mesh based on tiles of convex polygons.
|
|
<a href="classdtNavMesh.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="DetourNavMesh_8h_source.html">DetourNavMesh.h</a>></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:a2c0a9164f97121d8d6fc5d48d3b2c544"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a2c0a9164f97121d8d6fc5d48d3b2c544">dtNavMesh</a> ()</td></tr>
|
|
<tr class="separator:a2c0a9164f97121d8d6fc5d48d3b2c544"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08ff0da5bc8c2d01d26535f67d0f4726"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a08ff0da5bc8c2d01d26535f67d0f4726">~dtNavMesh</a> ()</td></tr>
|
|
<tr class="separator:a08ff0da5bc8c2d01d26535f67d0f4726"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Initialization and Tile Management</div></td></tr>
|
|
<tr class="memitem:a020702938951249972b955a65967234a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a020702938951249972b955a65967234a">init</a> (const <a class="el" href="structdtNavMeshParams.html">dtNavMeshParams</a> *params)</td></tr>
|
|
<tr class="memdesc:a020702938951249972b955a65967234a"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the navigation mesh for tiled use. <a href="classdtNavMesh.html#a020702938951249972b955a65967234a">More...</a><br /></td></tr>
|
|
<tr class="separator:a020702938951249972b955a65967234a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3cbc598755db0d1e9541b15f0f464318"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a3cbc598755db0d1e9541b15f0f464318">init</a> (unsigned char *data, const int dataSize, const int flags)</td></tr>
|
|
<tr class="memdesc:a3cbc598755db0d1e9541b15f0f464318"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the navigation mesh for single tile use. <a href="classdtNavMesh.html#a3cbc598755db0d1e9541b15f0f464318">More...</a><br /></td></tr>
|
|
<tr class="separator:a3cbc598755db0d1e9541b15f0f464318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9202ff1b571f26d948c0ee2f07c9bce8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structdtNavMeshParams.html">dtNavMeshParams</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a9202ff1b571f26d948c0ee2f07c9bce8">getParams</a> () const</td></tr>
|
|
<tr class="memdesc:a9202ff1b571f26d948c0ee2f07c9bce8"><td class="mdescLeft"> </td><td class="mdescRight">The navigation mesh initialization params. <a href="classdtNavMesh.html#a9202ff1b571f26d948c0ee2f07c9bce8">More...</a><br /></td></tr>
|
|
<tr class="separator:a9202ff1b571f26d948c0ee2f07c9bce8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89">addTile</a> (unsigned char *data, int dataSize, int flags, <a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> lastRef, <a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> *result)</td></tr>
|
|
<tr class="memdesc:a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89"><td class="mdescLeft"> </td><td class="mdescRight">Adds a tile to the navigation mesh. <a href="classdtNavMesh.html#a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ca09946d00f1cee4987ed5e2f999fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a5ca09946d00f1cee4987ed5e2f999fdb">removeTile</a> (<a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> ref, unsigned char **data, int *dataSize)</td></tr>
|
|
<tr class="memdesc:a5ca09946d00f1cee4987ed5e2f999fdb"><td class="mdescLeft"> </td><td class="mdescRight">Removes the specified tile from the navigation mesh. <a href="classdtNavMesh.html#a5ca09946d00f1cee4987ed5e2f999fdb">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ca09946d00f1cee4987ed5e2f999fdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Query Functions</div></td></tr>
|
|
<tr class="memitem:a609d55c59062910ff645dbbd4c72fed1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a609d55c59062910ff645dbbd4c72fed1">calcTileLoc</a> (const float *pos, int *tx, int *ty) const</td></tr>
|
|
<tr class="memdesc:a609d55c59062910ff645dbbd4c72fed1"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the tile grid location for the specified world position. <a href="classdtNavMesh.html#a609d55c59062910ff645dbbd4c72fed1">More...</a><br /></td></tr>
|
|
<tr class="separator:a609d55c59062910ff645dbbd4c72fed1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecd08fb7ce20324cd18de51a834ff2ef"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#aecd08fb7ce20324cd18de51a834ff2ef">getTileAt</a> (const int x, const int y, const int layer) const</td></tr>
|
|
<tr class="memdesc:aecd08fb7ce20324cd18de51a834ff2ef"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tile at the specified grid location. <a href="classdtNavMesh.html#aecd08fb7ce20324cd18de51a834ff2ef">More...</a><br /></td></tr>
|
|
<tr class="separator:aecd08fb7ce20324cd18de51a834ff2ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a89053de47c9ed459d598fc7f739670"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a1a89053de47c9ed459d598fc7f739670">getTilesAt</a> (const int x, const int y, <a class="el" href="structdtMeshTile.html">dtMeshTile</a> const **tiles, const int maxTiles) const</td></tr>
|
|
<tr class="memdesc:a1a89053de47c9ed459d598fc7f739670"><td class="mdescLeft"> </td><td class="mdescRight">Gets all tiles at the specified grid location. <a href="classdtNavMesh.html#a1a89053de47c9ed459d598fc7f739670">More...</a><br /></td></tr>
|
|
<tr class="separator:a1a89053de47c9ed459d598fc7f739670"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88f53f80fa95524b1e7197dface10948"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a88f53f80fa95524b1e7197dface10948">getTileRefAt</a> (int x, int y, int layer) const</td></tr>
|
|
<tr class="memdesc:a88f53f80fa95524b1e7197dface10948"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tile reference for the tile at specified grid location. <a href="classdtNavMesh.html#a88f53f80fa95524b1e7197dface10948">More...</a><br /></td></tr>
|
|
<tr class="separator:a88f53f80fa95524b1e7197dface10948"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6027a9a6f032dfd6a3b72563f17d80d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a6027a9a6f032dfd6a3b72563f17d80d7">getTileRef</a> (const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile) const</td></tr>
|
|
<tr class="memdesc:a6027a9a6f032dfd6a3b72563f17d80d7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tile reference for the specified tile. <a href="classdtNavMesh.html#a6027a9a6f032dfd6a3b72563f17d80d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a6027a9a6f032dfd6a3b72563f17d80d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7924d8eeed5c67b04d2d23d0cc766ad"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#ac7924d8eeed5c67b04d2d23d0cc766ad">getTileByRef</a> (<a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> ref) const</td></tr>
|
|
<tr class="memdesc:ac7924d8eeed5c67b04d2d23d0cc766ad"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tile for the specified tile reference. <a href="classdtNavMesh.html#ac7924d8eeed5c67b04d2d23d0cc766ad">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7924d8eeed5c67b04d2d23d0cc766ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17672fe19464d55eb66dc69f5f2f2b3f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a17672fe19464d55eb66dc69f5f2f2b3f">getMaxTiles</a> () const</td></tr>
|
|
<tr class="memdesc:a17672fe19464d55eb66dc69f5f2f2b3f"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of tiles supported by the navigation mesh. <a href="classdtNavMesh.html#a17672fe19464d55eb66dc69f5f2f2b3f">More...</a><br /></td></tr>
|
|
<tr class="separator:a17672fe19464d55eb66dc69f5f2f2b3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52bb4f57b24a139600cfb6aeec1d9bcd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a52bb4f57b24a139600cfb6aeec1d9bcd">getTile</a> (int i) const</td></tr>
|
|
<tr class="memdesc:a52bb4f57b24a139600cfb6aeec1d9bcd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tile at the specified index. <a href="classdtNavMesh.html#a52bb4f57b24a139600cfb6aeec1d9bcd">More...</a><br /></td></tr>
|
|
<tr class="separator:a52bb4f57b24a139600cfb6aeec1d9bcd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36a84aa7296d5cc257eb3ddc38181253"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a36a84aa7296d5cc257eb3ddc38181253">getTileAndPolyByRef</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:a36a84aa7296d5cc257eb3ddc38181253"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tile and polygon for the specified polygon reference. <a href="classdtNavMesh.html#a36a84aa7296d5cc257eb3ddc38181253">More...</a><br /></td></tr>
|
|
<tr class="separator:a36a84aa7296d5cc257eb3ddc38181253"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5c5b89a6af63b7de29089ae83091e0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#ac5c5b89a6af63b7de29089ae83091e0f">getTileAndPolyByRefUnsafe</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:ac5c5b89a6af63b7de29089ae83091e0f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the tile and polygon for the specified polygon reference. <a href="classdtNavMesh.html#ac5c5b89a6af63b7de29089ae83091e0f">More...</a><br /></td></tr>
|
|
<tr class="separator:ac5c5b89a6af63b7de29089ae83091e0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84ce3e44a2a97c5377b3b308825fcd37"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a84ce3e44a2a97c5377b3b308825fcd37">isValidPolyRef</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref) const</td></tr>
|
|
<tr class="memdesc:a84ce3e44a2a97c5377b3b308825fcd37"><td class="mdescLeft"> </td><td class="mdescRight">Checks the validity of a polygon reference. <a href="classdtNavMesh.html#a84ce3e44a2a97c5377b3b308825fcd37">More...</a><br /></td></tr>
|
|
<tr class="separator:a84ce3e44a2a97c5377b3b308825fcd37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0741871ed1357c51e3847f22673fcc9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a0741871ed1357c51e3847f22673fcc9c">getPolyRefBase</a> (const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile) const</td></tr>
|
|
<tr class="memdesc:a0741871ed1357c51e3847f22673fcc9c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the polygon reference for the tile's base polygon. <a href="classdtNavMesh.html#a0741871ed1357c51e3847f22673fcc9c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0741871ed1357c51e3847f22673fcc9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f4c392080406146805f674489feac4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a5f4c392080406146805f674489feac4a">getOffMeshConnectionPolyEndPoints</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> prevRef, <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> polyRef, float *startPos, float *endPos) const</td></tr>
|
|
<tr class="memdesc:a5f4c392080406146805f674489feac4a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the endpoints for an off-mesh connection, ordered by "direction of travel". <a href="classdtNavMesh.html#a5f4c392080406146805f674489feac4a">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f4c392080406146805f674489feac4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1db2c979241da0b6e0fda278206678de"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structdtOffMeshConnection.html">dtOffMeshConnection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a1db2c979241da0b6e0fda278206678de">getOffMeshConnectionByRef</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref) const</td></tr>
|
|
<tr class="memdesc:a1db2c979241da0b6e0fda278206678de"><td class="mdescLeft"> </td><td class="mdescRight">Gets the specified off-mesh connection. <a href="classdtNavMesh.html#a1db2c979241da0b6e0fda278206678de">More...</a><br /></td></tr>
|
|
<tr class="separator:a1db2c979241da0b6e0fda278206678de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">State Management</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>These functions do not effect <a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5" title="A handle to a tile within a navigation mesh.">dtTileRef</a> or <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466" title="A handle to a polygon within a navigation mesh tile.">dtPolyRef</a>'s. <br />
|
|
</p>
|
|
</div></td></tr>
|
|
<tr class="memitem:af11a9e69fa88b6d5cf66c376d46b8889"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#af11a9e69fa88b6d5cf66c376d46b8889">setPolyFlags</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref, unsigned short flags)</td></tr>
|
|
<tr class="memdesc:af11a9e69fa88b6d5cf66c376d46b8889"><td class="mdescLeft"> </td><td class="mdescRight">Sets the user defined flags for the specified polygon. <a href="classdtNavMesh.html#af11a9e69fa88b6d5cf66c376d46b8889">More...</a><br /></td></tr>
|
|
<tr class="separator:af11a9e69fa88b6d5cf66c376d46b8889"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d5d33030fc21afa6b1be3c80689f9b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a8d5d33030fc21afa6b1be3c80689f9b7">getPolyFlags</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref, unsigned short *resultFlags) const</td></tr>
|
|
<tr class="memdesc:a8d5d33030fc21afa6b1be3c80689f9b7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the user defined flags for the specified polygon. <a href="classdtNavMesh.html#a8d5d33030fc21afa6b1be3c80689f9b7">More...</a><br /></td></tr>
|
|
<tr class="separator:a8d5d33030fc21afa6b1be3c80689f9b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74a6e65e04a87a1b6abf837349f214fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a74a6e65e04a87a1b6abf837349f214fb">setPolyArea</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref, unsigned char area)</td></tr>
|
|
<tr class="memdesc:a74a6e65e04a87a1b6abf837349f214fb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the user defined area for the specified polygon. <a href="classdtNavMesh.html#a74a6e65e04a87a1b6abf837349f214fb">More...</a><br /></td></tr>
|
|
<tr class="separator:a74a6e65e04a87a1b6abf837349f214fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac53c07a2ab699b15228c91a17b3bafd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#aac53c07a2ab699b15228c91a17b3bafd">getPolyArea</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref, unsigned char *resultArea) const</td></tr>
|
|
<tr class="memdesc:aac53c07a2ab699b15228c91a17b3bafd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the user defined area for the specified polygon. <a href="classdtNavMesh.html#aac53c07a2ab699b15228c91a17b3bafd">More...</a><br /></td></tr>
|
|
<tr class="separator:aac53c07a2ab699b15228c91a17b3bafd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf6f0b0ce2bd81c5e6cd8ac67f6a8638"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#aaf6f0b0ce2bd81c5e6cd8ac67f6a8638">getTileStateSize</a> (const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile) const</td></tr>
|
|
<tr class="memdesc:aaf6f0b0ce2bd81c5e6cd8ac67f6a8638"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the buffer required by <a class="el" href="classdtNavMesh.html#a141e01263950382365468ea265f48758" title="Stores the non-structural state of the tile in the specified buffer.">storeTileState</a> to store the specified tile's state. <a href="classdtNavMesh.html#aaf6f0b0ce2bd81c5e6cd8ac67f6a8638">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf6f0b0ce2bd81c5e6cd8ac67f6a8638"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a141e01263950382365468ea265f48758"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a141e01263950382365468ea265f48758">storeTileState</a> (const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile, unsigned char *data, const int maxDataSize) const</td></tr>
|
|
<tr class="memdesc:a141e01263950382365468ea265f48758"><td class="mdescLeft"> </td><td class="mdescRight">Stores the non-structural state of the tile in the specified buffer. <a href="classdtNavMesh.html#a141e01263950382365468ea265f48758">More...</a><br /></td></tr>
|
|
<tr class="separator:a141e01263950382365468ea265f48758"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef336a67e552a9d031d669ec84029fb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#aef336a67e552a9d031d669ec84029fb8">restoreTileState</a> (<a class="el" href="structdtMeshTile.html">dtMeshTile</a> *tile, const unsigned char *data, const int maxDataSize)</td></tr>
|
|
<tr class="memdesc:aef336a67e552a9d031d669ec84029fb8"><td class="mdescLeft"> </td><td class="mdescRight">Restores the state of the tile. <a href="classdtNavMesh.html#aef336a67e552a9d031d669ec84029fb8">More...</a><br /></td></tr>
|
|
<tr class="separator:aef336a67e552a9d031d669ec84029fb8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Encoding and Decoding</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>These functions are generally meant for internal use only. </p>
|
|
</div></td></tr>
|
|
<tr class="memitem:a168a479840e7e32613f4b68ee4662d78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a168a479840e7e32613f4b68ee4662d78">encodePolyId</a> (unsigned int salt, unsigned int it, unsigned int ip) const</td></tr>
|
|
<tr class="memdesc:a168a479840e7e32613f4b68ee4662d78"><td class="mdescLeft"> </td><td class="mdescRight">Derives a standard polygon reference. <a href="classdtNavMesh.html#a168a479840e7e32613f4b68ee4662d78">More...</a><br /></td></tr>
|
|
<tr class="separator:a168a479840e7e32613f4b68ee4662d78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afaaf5c22864cdf4a61d5e40a4efce43f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#afaaf5c22864cdf4a61d5e40a4efce43f">decodePolyId</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref, unsigned int &salt, unsigned int &it, unsigned int &ip) const</td></tr>
|
|
<tr class="memdesc:afaaf5c22864cdf4a61d5e40a4efce43f"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a standard polygon reference. <a href="classdtNavMesh.html#afaaf5c22864cdf4a61d5e40a4efce43f">More...</a><br /></td></tr>
|
|
<tr class="separator:afaaf5c22864cdf4a61d5e40a4efce43f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a588b6f839fd249430cff02cea71f347c"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a588b6f839fd249430cff02cea71f347c">decodePolyIdSalt</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref) const</td></tr>
|
|
<tr class="memdesc:a588b6f839fd249430cff02cea71f347c"><td class="mdescLeft"> </td><td class="mdescRight">Extracts a tile's salt value from the specified polygon reference. <a href="classdtNavMesh.html#a588b6f839fd249430cff02cea71f347c">More...</a><br /></td></tr>
|
|
<tr class="separator:a588b6f839fd249430cff02cea71f347c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94cfcf0015d7d6d856acaf96126cd349"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a94cfcf0015d7d6d856acaf96126cd349">decodePolyIdTile</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref) const</td></tr>
|
|
<tr class="memdesc:a94cfcf0015d7d6d856acaf96126cd349"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the tile's index from the specified polygon reference. <a href="classdtNavMesh.html#a94cfcf0015d7d6d856acaf96126cd349">More...</a><br /></td></tr>
|
|
<tr class="separator:a94cfcf0015d7d6d856acaf96126cd349"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a936c3779e6cb7484e57dd106911eccc2"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a936c3779e6cb7484e57dd106911eccc2">decodePolyIdPoly</a> (<a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref) const</td></tr>
|
|
<tr class="memdesc:a936c3779e6cb7484e57dd106911eccc2"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the polygon's index (within its tile) from the specified polygon reference. <a href="classdtNavMesh.html#a936c3779e6cb7484e57dd106911eccc2">More...</a><br /></td></tr>
|
|
<tr class="separator:a936c3779e6cb7484e57dd106911eccc2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a43ead93bfa93182d47caf9c6be597376"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtNavMesh.html#a43ead93bfa93182d47caf9c6be597376">dtNavMeshQuery</a></td></tr>
|
|
<tr class="separator:a43ead93bfa93182d47caf9c6be597376"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<div class="textblock"><p>A navigation mesh based on tiles of convex polygons. </p>
|
|
<p>The navigation mesh consists of one or more tiles defining three primary types of structural data:</p>
|
|
<p>A polygon mesh which defines most of the navigation graph. (See <a class="el" href="structrcPolyMesh.html" title="Represents a polygon mesh suitable for use in building a navigation mesh.">rcPolyMesh</a> for its structure.) A detail mesh used for determining surface height on the polygon mesh. (See <a class="el" href="structrcPolyMeshDetail.html" title="Contains triangle meshes that represent detailed height data associated with the polygons in its asso...">rcPolyMeshDetail</a> for its structure.) Off-mesh connections, which define custom point-to-point edges within the navigation graph.</p>
|
|
<p>The general build process is as follows:</p>
|
|
<ol type="1">
|
|
<li>Create <a class="el" href="structrcPolyMesh.html" title="Represents a polygon mesh suitable for use in building a navigation mesh.">rcPolyMesh</a> and <a class="el" href="structrcPolyMeshDetail.html" title="Contains triangle meshes that represent detailed height data associated with the polygons in its asso...">rcPolyMeshDetail</a> data using the Recast build pipeline.</li>
|
|
<li>Optionally, create off-mesh connection data.</li>
|
|
<li>Combine the source data into a <a class="el" href="structdtNavMeshCreateParams.html" title="Represents the source data used to build an navigation mesh tile.">dtNavMeshCreateParams</a> structure.</li>
|
|
<li>Create a tile data array using <a class="el" href="group__detour.html#gaf56ac19e79e5948fdb1051158577e648" title="Builds navigation mesh tile data from the provided tile creation data.">dtCreateNavMeshData()</a>.</li>
|
|
<li>Allocate at <a class="el" href="classdtNavMesh.html" title="A navigation mesh based on tiles of convex polygons.">dtNavMesh</a> object and initialize it. (For single tile navigation meshes, the tile data is loaded during this step.)</li>
|
|
<li>For multi-tile navigation meshes, load the tile data using <a class="el" href="classdtNavMesh.html#a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89" title="Adds a tile to the navigation mesh.">dtNavMesh::addTile()</a>.</li>
|
|
</ol>
|
|
<p>Notes:</p>
|
|
<ul>
|
|
<li>This class is usually used in conjunction with the <a class="el" href="classdtNavMeshQuery.html" title="Provides the ability to perform pathfinding related queries against a navigation mesh.">dtNavMeshQuery</a> class for pathfinding.</li>
|
|
<li>Technically, all navigation meshes are tiled. A 'solo' mesh is simply a navigation mesh initialized to have only a single tile.</li>
|
|
<li>This class does not implement any asynchronous methods. So the <a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> result of all methods will always contain either a success or failure flag.</li>
|
|
</ul>
|
|
<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>, <a class="el" href="group__detour.html#gaf56ac19e79e5948fdb1051158577e648" title="Builds navigation mesh tile data from the provided tile creation data.">dtCreateNavMeshData</a>, <a class="el" href="structdtNavMeshCreateParams.html" title="Represents the source data used to build an navigation mesh tile.">dtNavMeshCreateParams</a>, <a class="el" href="group__detour.html#ga73648d53c5a414855a2aa264aab9263c" title="Allocates a navigation mesh object using the Detour allocator.">dtAllocNavMesh</a>, <a class="el" href="group__detour.html#gad938af5675a2f62c7c3830b38ea9a184" title="Frees the specified navigation mesh object using the Detour allocator.">dtFreeNavMesh</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2c0a9164f97121d8d6fc5d48d3b2c544"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c0a9164f97121d8d6fc5d48d3b2c544">◆ </a></span>dtNavMesh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dtNavMesh::dtNavMesh </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a08ff0da5bc8c2d01d26535f67d0f4726"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a08ff0da5bc8c2d01d26535f67d0f4726">◆ </a></span>~dtNavMesh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">dtNavMesh::~dtNavMesh </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="a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89">◆ </a></span>addTile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::addTile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned char * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>dataSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>flags</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> </td>
|
|
<td class="paramname"><em>lastRef</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> * </td>
|
|
<td class="paramname"><em>result</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a tile to the navigation mesh. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data for the new tile mesh. (See: <a class="el" href="group__detour.html#gaf56ac19e79e5948fdb1051158577e648" title="Builds navigation mesh tile data from the provided tile creation data.">dtCreateNavMeshData</a>) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dataSize</td><td>Data size of the new tile mesh. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Tile flags. (See: <a class="el" href="DetourNavMesh_8h.html#ace45ee22124392a9026eb6266000ca1c" title="Tile flags used for various functions and fields.">dtTileFlags</a>) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">lastRef</td><td>The desired reference for the tile. (When reloading a tile.) [opt] [Default: 0] </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>The tile reference. (If the tile was succesfully added.) [opt] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>The add operation will fail if the data is in the wrong format, the allocated tile space is full, or there is a tile already at the specified reference.</p>
|
|
<p>The lastRef parameter is used to restore a tile with the same tile reference it had previously used. In this case the <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466" title="A handle to a polygon within a navigation mesh tile.">dtPolyRef</a>'s for the tile will be restored to the same values they were before the tile was removed.</p>
|
|
<p>The nav mesh assumes exclusive access to the data passed and will make changes to the dynamic portion of the data. For that reason the data should not be reused in other nav meshes until the tile has been successfully removed from this nav mesh.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__detour.html#gaf56ac19e79e5948fdb1051158577e648" title="Builds navigation mesh tile data from the provided tile creation data.">dtCreateNavMeshData</a>, <a class="el" href="classdtNavMesh.html#a5ca09946d00f1cee4987ed5e2f999fdb" title="Removes the specified tile from the navigation mesh.">removeTile</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a609d55c59062910ff645dbbd4c72fed1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a609d55c59062910ff645dbbd4c72fed1">◆ </a></span>calcTileLoc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void dtNavMesh::calcTileLoc </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const float * </td>
|
|
<td class="paramname"><em>pos</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>tx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>ty</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculates the tile grid location for the specified world position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pos</td><td>The world position for the query. [(x, y, z)] </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">tx</td><td>The tile's x-location. (x, y) </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">ty</td><td>The tile's y-location. (x, y) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afaaf5c22864cdf4a61d5e40a4efce43f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afaaf5c22864cdf4a61d5e40a4efce43f">◆ </a></span>decodePolyId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void dtNavMesh::decodePolyId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int & </td>
|
|
<td class="paramname"><em>salt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int & </td>
|
|
<td class="paramname"><em>it</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int & </td>
|
|
<td class="paramname"><em>ip</em> </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>Decodes a standard polygon reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is generally meant for internal use only. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference to decode. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">salt</td><td>The tile's salt value. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">it</td><td>The index of the tile. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">ip</td><td>The index of the polygon within the tile. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a168a479840e7e32613f4b68ee4662d78" title="Derives a standard polygon reference.">encodePolyId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a936c3779e6cb7484e57dd106911eccc2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a936c3779e6cb7484e57dd106911eccc2">◆ </a></span>decodePolyIdPoly()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int dtNavMesh::decodePolyIdPoly </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</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>Extracts the polygon's index (within its tile) from the specified polygon reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is generally meant for internal use only. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a168a479840e7e32613f4b68ee4662d78" title="Derives a standard polygon reference.">encodePolyId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a588b6f839fd249430cff02cea71f347c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a588b6f839fd249430cff02cea71f347c">◆ </a></span>decodePolyIdSalt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int dtNavMesh::decodePolyIdSalt </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</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>Extracts a tile's salt value from the specified polygon reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is generally meant for internal use only. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a168a479840e7e32613f4b68ee4662d78" title="Derives a standard polygon reference.">encodePolyId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94cfcf0015d7d6d856acaf96126cd349"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94cfcf0015d7d6d856acaf96126cd349">◆ </a></span>decodePolyIdTile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int dtNavMesh::decodePolyIdTile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</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>Extracts the tile's index from the specified polygon reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is generally meant for internal use only. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a168a479840e7e32613f4b68ee4662d78" title="Derives a standard polygon reference.">encodePolyId</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a168a479840e7e32613f4b68ee4662d78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a168a479840e7e32613f4b68ee4662d78">◆ </a></span>encodePolyId()</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> dtNavMesh::encodePolyId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>salt</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>it</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>ip</em> </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>Derives a standard polygon reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function is generally meant for internal use only. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">salt</td><td>The tile's salt value. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">it</td><td>The index of the tile. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ip</td><td>The index of the polygon within the tile. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a17672fe19464d55eb66dc69f5f2f2b3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a17672fe19464d55eb66dc69f5f2f2b3f">◆ </a></span>getMaxTiles()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int dtNavMesh::getMaxTiles </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The maximum number of tiles supported by the navigation mesh. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The maximum number of tiles supported by the navigation mesh. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1db2c979241da0b6e0fda278206678de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1db2c979241da0b6e0fda278206678de">◆ </a></span>getOffMeshConnectionByRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structdtOffMeshConnection.html">dtOffMeshConnection</a> * dtNavMesh::getOffMeshConnectionByRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the specified off-mesh connection. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference of the off-mesh connection. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The specified off-mesh connection, or null if the polygon reference is not valid. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5f4c392080406146805f674489feac4a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f4c392080406146805f674489feac4a">◆ </a></span>getOffMeshConnectionPolyEndPoints()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::getOffMeshConnectionPolyEndPoints </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>prevRef</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>polyRef</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>startPos</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>endPos</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the endpoints for an off-mesh connection, ordered by "direction of travel". </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">prevRef</td><td>The reference of the polygon before the connection. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">polyRef</td><td>The reference of the off-mesh connection polygon. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">startPos</td><td>The start position of the off-mesh connection. [(x, y, z)] </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">endPos</td><td>The end position of the off-mesh connection. [(x, y, z)] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>Off-mesh connections are stored in the navigation mesh as special 2-vertex polygons with a single edge. At least one of the vertices is expected to be inside a normal polygon. So an off-mesh connection is "entered" from a normal polygon at one of its endpoints. This is the polygon identified by the prevRef parameter. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9202ff1b571f26d948c0ee2f07c9bce8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9202ff1b571f26d948c0ee2f07c9bce8">◆ </a></span>getParams()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structdtNavMeshParams.html">dtNavMeshParams</a> * dtNavMesh::getParams </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The navigation mesh initialization params. </p>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>The parameters are created automatically when the single tile initialization is performed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac53c07a2ab699b15228c91a17b3bafd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac53c07a2ab699b15228c91a17b3bafd">◆ </a></span>getPolyArea()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::getPolyArea </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned char * </td>
|
|
<td class="paramname"><em>resultArea</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the user defined area for the specified polygon. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">resultArea</td><td>The area id for the polygon. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d5d33030fc21afa6b1be3c80689f9b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d5d33030fc21afa6b1be3c80689f9b7">◆ </a></span>getPolyFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::getPolyFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned short * </td>
|
|
<td class="paramname"><em>resultFlags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the user defined flags for the specified polygon. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">resultFlags</td><td>The polygon flags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0741871ed1357c51e3847f22673fcc9c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0741871ed1357c51e3847f22673fcc9c">◆ </a></span>getPolyRefBase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> dtNavMesh::getPolyRefBase </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td>
|
|
<td class="paramname"><em>tile</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the polygon reference for the tile's base polygon. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tile</td><td>The tile. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The polygon reference for the base polygon in the specified tile.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>Example use case: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <a class="code" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> base = navmesh->getPolyRefBase(tile);</div>
|
|
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < tile->header->polyCount; ++i)</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="keyword">const</span> <a class="code" href="structdtPoly.html">dtPoly</a>* p = &tile->polys[i];</div>
|
|
<div class="line"> <span class="keyword">const</span> <a class="code" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> ref = base | (<a class="code" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>)i;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Use the reference to access the polygon data.</span></div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="agroup__detour_html_gab4e0b2257a670c1a800057999612b466"><div class="ttname"><a href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a></div><div class="ttdeci">unsigned int dtPolyRef</div><div class="ttdoc">A handle to a polygon within a navigation mesh tile.</div><div class="ttdef"><b>Definition:</b> DetourNavMesh.h:48</div></div>
|
|
<div class="ttc" id="astructdtPoly_html"><div class="ttname"><a href="structdtPoly.html">dtPoly</a></div><div class="ttdoc">Defines a polygon within a dtMeshTile object.</div><div class="ttdef"><b>Definition:</b> DetourNavMesh.h:156</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a52bb4f57b24a139600cfb6aeec1d9bcd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52bb4f57b24a139600cfb6aeec1d9bcd">◆ </a></span>getTile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * dtNavMesh::getTile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>i</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the tile at the specified index. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>The tile index. [Limit: 0 >= index < <a class="el" href="classdtNavMesh.html#a17672fe19464d55eb66dc69f5f2f2b3f" title="The maximum number of tiles supported by the navigation mesh.">getMaxTiles()</a>] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The tile at the specified index. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36a84aa7296d5cc257eb3ddc38181253"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36a84aa7296d5cc257eb3ddc38181253">◆ </a></span>getTileAndPolyByRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::getTileAndPolyByRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </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> ** </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> ** </td>
|
|
<td class="paramname"><em>poly</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the tile and polygon for the specified polygon reference. </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 for the a polygon. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">tile</td><td>The tile containing the polygon. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">poly</td><td>The polygon. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac5c5b89a6af63b7de29089ae83091e0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac5c5b89a6af63b7de29089ae83091e0f">◆ </a></span>getTileAndPolyByRefUnsafe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void dtNavMesh::getTileAndPolyByRefUnsafe </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </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> ** </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> ** </td>
|
|
<td class="paramname"><em>poly</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the tile and polygon for the specified polygon reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>A known valid reference for a polygon. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">tile</td><td>The tile containing the polygon. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">poly</td><td>The polygon.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Only use this function if it is known that the provided polygon reference is valid. This function is faster than <a class="el" href="classdtNavMesh.html#a36a84aa7296d5cc257eb3ddc38181253" title="Gets the tile and polygon for the specified polygon reference.">getTileAndPolyByRef</a>, but it does not validate the reference. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aecd08fb7ce20324cd18de51a834ff2ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecd08fb7ce20324cd18de51a834ff2ef">◆ </a></span>getTileAt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * dtNavMesh::getTileAt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>layer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the tile at the specified grid location. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The tile's x-location. (x, y, layer) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The tile's y-location. (x, y, layer) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">layer</td><td>The tile's layer. (x, y, layer) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The tile, or null if the tile does not exist. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7924d8eeed5c67b04d2d23d0cc766ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7924d8eeed5c67b04d2d23d0cc766ad">◆ </a></span>getTileByRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * dtNavMesh::getTileByRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> </td>
|
|
<td class="paramname"><em>ref</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the tile for the specified tile reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The tile reference of the tile to retrieve. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The tile for the specified reference, or null if the reference is invalid. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6027a9a6f032dfd6a3b72563f17d80d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6027a9a6f032dfd6a3b72563f17d80d7">◆ </a></span>getTileRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> dtNavMesh::getTileRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td>
|
|
<td class="paramname"><em>tile</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the tile reference for the specified tile. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tile</td><td>The tile. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The tile reference of the tile. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88f53f80fa95524b1e7197dface10948"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88f53f80fa95524b1e7197dface10948">◆ </a></span>getTileRefAt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> dtNavMesh::getTileRefAt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>layer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the tile reference for the tile at specified grid location. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The tile's x-location. (x, y, layer) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The tile's y-location. (x, y, layer) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">layer</td><td>The tile's layer. (x, y, layer) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The tile reference of the tile, or 0 if there is none. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a89053de47c9ed459d598fc7f739670"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a89053de47c9ed459d598fc7f739670">◆ </a></span>getTilesAt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int dtNavMesh::getTilesAt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structdtMeshTile.html">dtMeshTile</a> const ** </td>
|
|
<td class="paramname"><em>tiles</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>maxTiles</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets all tiles at the specified grid location. </p>
|
|
<p>(All layers.) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The tile's x-location. (x, y) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The tile's y-location. (x, y) </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">tiles</td><td>A pointer to an array of tiles that will hold the result. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxTiles</td><td>The maximum tiles the tiles parameter can hold. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of tiles returned in the tiles array.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>This function will not fail if the tiles array is too small to hold the entire result set. It will simply fill the array to capacity. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf6f0b0ce2bd81c5e6cd8ac67f6a8638"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf6f0b0ce2bd81c5e6cd8ac67f6a8638">◆ </a></span>getTileStateSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int dtNavMesh::getTileStateSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td>
|
|
<td class="paramname"><em>tile</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the size of the buffer required by <a class="el" href="classdtNavMesh.html#a141e01263950382365468ea265f48758" title="Stores the non-structural state of the tile in the specified buffer.">storeTileState</a> to store the specified tile's state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tile</td><td>The tile. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The size of the buffer required to store the state.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a141e01263950382365468ea265f48758" title="Stores the non-structural state of the tile in the specified buffer.">storeTileState</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a020702938951249972b955a65967234a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a020702938951249972b955a65967234a">◆ </a></span>init() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structdtNavMeshParams.html">dtNavMeshParams</a> * </td>
|
|
<td class="paramname"><em>params</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the navigation mesh for tiled use. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>Initialization parameters. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3cbc598755db0d1e9541b15f0f464318"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3cbc598755db0d1e9541b15f0f464318">◆ </a></span>init() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned char * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>dataSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>flags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the navigation mesh for single tile use. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data of the new tile. (See: <a class="el" href="group__detour.html#gaf56ac19e79e5948fdb1051158577e648" title="Builds navigation mesh tile data from the provided tile creation data.">dtCreateNavMeshData</a>) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dataSize</td><td>The data size of the new tile. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The tile flags. (See: <a class="el" href="DetourNavMesh_8h.html#ace45ee22124392a9026eb6266000ca1c" title="Tile flags used for various functions and fields.">dtTileFlags</a>) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__detour.html#gaf56ac19e79e5948fdb1051158577e648" title="Builds navigation mesh tile data from the provided tile creation data.">dtCreateNavMeshData</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a84ce3e44a2a97c5377b3b308825fcd37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84ce3e44a2a97c5377b3b308825fcd37">◆ </a></span>isValidPolyRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool dtNavMesh::isValidPolyRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks the validity of a polygon reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference to check. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if polygon reference is valid for the navigation mesh. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ca09946d00f1cee4987ed5e2f999fdb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ca09946d00f1cee4987ed5e2f999fdb">◆ </a></span>removeTile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::removeTile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5">dtTileRef</a> </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned char ** </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>dataSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes the specified tile from the navigation mesh. </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 of the tile to remove. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Data associated with deleted tile. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">dataSize</td><td>Size of the data associated with deleted tile. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>This function returns the data for the tile so that, if desired, it can be added back to the navigation mesh at a later point.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a5b5a7c4fa72c08d9a6d4cc4d8cd3bb89" title="Adds a tile to the navigation mesh.">addTile</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aef336a67e552a9d031d669ec84029fb8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aef336a67e552a9d031d669ec84029fb8">◆ </a></span>restoreTileState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::restoreTileState </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td>
|
|
<td class="paramname"><em>tile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const unsigned char * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>maxDataSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restores the state of the tile. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tile</td><td>The tile. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The new state. (Obtained from <a class="el" href="classdtNavMesh.html#a141e01263950382365468ea265f48758" title="Stores the non-structural state of the tile in the specified buffer.">storeTileState</a>.) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxDataSize</td><td>The size of the state within the data buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>Tile state includes non-structural data such as polygon flags, area ids, etc. </p><dl class="section note"><dt>Note</dt><dd>This function does not impact the tile's <a class="el" href="group__detour.html#ga7ea56cfe01bd7c34a81d821d94cbeea5" title="A handle to a tile within a navigation mesh.">dtTileRef</a> and <a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466" title="A handle to a polygon within a navigation mesh tile.">dtPolyRef</a>'s. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#a141e01263950382365468ea265f48758" title="Stores the non-structural state of the tile in the specified buffer.">storeTileState</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74a6e65e04a87a1b6abf837349f214fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74a6e65e04a87a1b6abf837349f214fb">◆ </a></span>setPolyArea()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::setPolyArea </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned char </td>
|
|
<td class="paramname"><em>area</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the user defined area for the specified polygon. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">area</td><td>The new area id for the polygon. [Limit: < <a class="el" href="group__detour.html#ga954dc85eacf41248ee76968957484a9e" title="The maximum number of user defined area ids.">DT_MAX_AREAS</a>] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af11a9e69fa88b6d5cf66c376d46b8889"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af11a9e69fa88b6d5cf66c376d46b8889">◆ </a></span>setPolyFlags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::setPolyFlags </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned short </td>
|
|
<td class="paramname"><em>flags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the user defined flags for the specified polygon. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The polygon reference. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The new flags for the polygon. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a141e01263950382365468ea265f48758"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a141e01263950382365468ea265f48758">◆ </a></span>storeTileState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="DetourStatus_8h.html#a4f23c0dcf28d9e299a4aa06af5b9ada3">dtStatus</a> dtNavMesh::storeTileState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structdtMeshTile.html">dtMeshTile</a> * </td>
|
|
<td class="paramname"><em>tile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned char * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>maxDataSize</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Stores the non-structural state of the tile in the specified buffer. </p>
|
|
<p>(Flags, area ids, etc.) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tile</td><td>The tile. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>The buffer to store the tile's state in. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">maxDataSize</td><td>The size of the data buffer. [Limit: >= <a class="el" href="classdtNavMesh.html#aaf6f0b0ce2bd81c5e6cd8ac67f6a8638" title="Gets the size of the buffer required by storeTileState to store the specified tile's state.">getTileStateSize</a>] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The status flags for the operation.</dd></dl>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>Tile state includes non-structural data such as polygon flags, area ids, etc. </p><dl class="section note"><dt>Note</dt><dd>The state data is only valid until the tile reference changes. </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classdtNavMesh.html#aaf6f0b0ce2bd81c5e6cd8ac67f6a8638" title="Gets the size of the buffer required by storeTileState to store the specified tile's state.">getTileStateSize</a>, <a class="el" href="classdtNavMesh.html#aef336a67e552a9d031d669ec84029fb8" title="Restores the state of the tile.">restoreTileState</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="a43ead93bfa93182d47caf9c6be597376"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43ead93bfa93182d47caf9c6be597376">◆ </a></span>dtNavMeshQuery</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classdtNavMeshQuery.html">dtNavMeshQuery</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </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="DetourNavMesh_8h_source.html">DetourNavMesh.h</a></li>
|
|
<li><a class="el" href="DetourNavMesh_8cpp.html">DetourNavMesh.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="classdtNavMesh.html">dtNavMesh</a></li>
|
|
<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>
|