Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-08-30 06:58:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c58589f169ebc337962a67aa4a1f73d30c323155
recastnavigation/structdtPoly.html

384 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Recast Navigation: dtPoly Struct 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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign">
<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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structdtPoly.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdtPoly-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dtPoly Struct Reference<div class="ingroups"><a class="el" href="group__detour.html">Detour</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Defines a polygon within a <a class="el" href="structdtMeshTile.html" title="Defines a navigation mesh tile.">dtMeshTile</a> object.
<a href="structdtPoly.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DetourNavMesh_8h_source.html">DetourNavMesh.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a84f05dcf69d70b26323b65a0c1c66954" id="r_a84f05dcf69d70b26323b65a0c1c66954"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#a84f05dcf69d70b26323b65a0c1c66954">setArea</a> (unsigned char a)</td></tr>
<tr class="memdesc:a84f05dcf69d70b26323b65a0c1c66954"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the user defined area id. [Limit: &lt; <a class="el" href="group__detour.html#ga954dc85eacf41248ee76968957484a9e" title="The maximum number of user defined area ids.">DT_MAX_AREAS</a>]. <br /></td></tr>
<tr class="separator:a84f05dcf69d70b26323b65a0c1c66954"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac625b3f1acf8df354a50464e210300dc" id="r_ac625b3f1acf8df354a50464e210300dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#ac625b3f1acf8df354a50464e210300dc">setType</a> (unsigned char t)</td></tr>
<tr class="memdesc:ac625b3f1acf8df354a50464e210300dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the polygon type. (See: <a class="el" href="DetourNavMesh_8h.html#a19937b4ff098f7c52ee08af1b5f39c98" title="Flags representing the type of a navigation mesh polygon.">dtPolyTypes</a>.) <br /></td></tr>
<tr class="separator:ac625b3f1acf8df354a50464e210300dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5e97720847977aa7a4caf8c75e73792" id="r_ab5e97720847977aa7a4caf8c75e73792"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#ab5e97720847977aa7a4caf8c75e73792">getArea</a> () const</td></tr>
<tr class="memdesc:ab5e97720847977aa7a4caf8c75e73792"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the user defined area id. <br /></td></tr>
<tr class="separator:ab5e97720847977aa7a4caf8c75e73792"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12a7d5dcd2f1d7164531be4ecb5f35a4" id="r_a12a7d5dcd2f1d7164531be4ecb5f35a4"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#a12a7d5dcd2f1d7164531be4ecb5f35a4">getType</a> () const</td></tr>
<tr class="memdesc:a12a7d5dcd2f1d7164531be4ecb5f35a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the polygon type. (See: <a class="el" href="DetourNavMesh_8h.html#a19937b4ff098f7c52ee08af1b5f39c98" title="Flags representing the type of a navigation mesh polygon.">dtPolyTypes</a>) <br /></td></tr>
<tr class="separator:a12a7d5dcd2f1d7164531be4ecb5f35a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a671fd6893087936e80fcd17f7f666c0e" id="r_a671fd6893087936e80fcd17f7f666c0e"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#a671fd6893087936e80fcd17f7f666c0e">firstLink</a></td></tr>
<tr class="memdesc:a671fd6893087936e80fcd17f7f666c0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index to first link in linked list. (Or <a class="el" href="DetourNavMesh_8h.html#aca31b5eadafd19285e16eca707b3295b" title="A value that indicates the entity does not link to anything.">DT_NULL_LINK</a> if there is no link.) <br /></td></tr>
<tr class="separator:a671fd6893087936e80fcd17f7f666c0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acff94eb19526d33ef3c966b583d1d73f" id="r_acff94eb19526d33ef3c966b583d1d73f"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#acff94eb19526d33ef3c966b583d1d73f">verts</a> [<a class="el" href="group__detour.html#ga8591fdac662dbfabb580de626c64c9f3">DT_VERTS_PER_POLYGON</a>]</td></tr>
<tr class="memdesc:acff94eb19526d33ef3c966b583d1d73f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The indices of the polygon's vertices. <br /></td></tr>
<tr class="separator:acff94eb19526d33ef3c966b583d1d73f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4f5aa32df32aa5b1385f76f697376af" id="r_ac4f5aa32df32aa5b1385f76f697376af"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#ac4f5aa32df32aa5b1385f76f697376af">neis</a> [<a class="el" href="group__detour.html#ga8591fdac662dbfabb580de626c64c9f3">DT_VERTS_PER_POLYGON</a>]</td></tr>
<tr class="memdesc:ac4f5aa32df32aa5b1385f76f697376af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Packed data representing neighbor polygons references and flags for each edge. <br /></td></tr>
<tr class="separator:ac4f5aa32df32aa5b1385f76f697376af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47312e2c5dfd1ff1a729580c339f0d7d" id="r_a47312e2c5dfd1ff1a729580c339f0d7d"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#a47312e2c5dfd1ff1a729580c339f0d7d">flags</a></td></tr>
<tr class="memdesc:a47312e2c5dfd1ff1a729580c339f0d7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user defined polygon flags. <br /></td></tr>
<tr class="separator:a47312e2c5dfd1ff1a729580c339f0d7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af940c431464c022f844e61130f83d9c2" id="r_af940c431464c022f844e61130f83d9c2"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#af940c431464c022f844e61130f83d9c2">vertCount</a></td></tr>
<tr class="memdesc:af940c431464c022f844e61130f83d9c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of vertices in the polygon. <br /></td></tr>
<tr class="separator:af940c431464c022f844e61130f83d9c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3caa090f5d4776766bf56f82c27a899" id="r_af3caa090f5d4776766bf56f82c27a899"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtPoly.html#af3caa090f5d4776766bf56f82c27a899">areaAndtype</a></td></tr>
<tr class="memdesc:af3caa090f5d4776766bf56f82c27a899"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bit packed area id and polygon type. <br /></td></tr>
<tr class="separator:af3caa090f5d4776766bf56f82c27a899"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Defines a polygon within a <a class="el" href="structdtMeshTile.html" title="Defines a navigation mesh tile.">dtMeshTile</a> object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab5e97720847977aa7a4caf8c75e73792" name="ab5e97720847977aa7a4caf8c75e73792"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5e97720847977aa7a4caf8c75e73792">&#9670;&#160;</a></span>getArea()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned char dtPoly::getArea </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the user defined area id. </p>
</div>
</div>
<a id="a12a7d5dcd2f1d7164531be4ecb5f35a4" name="a12a7d5dcd2f1d7164531be4ecb5f35a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12a7d5dcd2f1d7164531be4ecb5f35a4">&#9670;&#160;</a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned char dtPoly::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the polygon type. (See: <a class="el" href="DetourNavMesh_8h.html#a19937b4ff098f7c52ee08af1b5f39c98" title="Flags representing the type of a navigation mesh polygon.">dtPolyTypes</a>) </p>
</div>
</div>
<a id="a84f05dcf69d70b26323b65a0c1c66954" name="a84f05dcf69d70b26323b65a0c1c66954"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84f05dcf69d70b26323b65a0c1c66954">&#9670;&#160;</a></span>setArea()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dtPoly::setArea </td>
<td>(</td>
<td class="paramtype">unsigned char&#160;</td>
<td class="paramname"><em>a</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the user defined area id. [Limit: &lt; <a class="el" href="group__detour.html#ga954dc85eacf41248ee76968957484a9e" title="The maximum number of user defined area ids.">DT_MAX_AREAS</a>]. </p>
</div>
</div>
<a id="ac625b3f1acf8df354a50464e210300dc" name="ac625b3f1acf8df354a50464e210300dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac625b3f1acf8df354a50464e210300dc">&#9670;&#160;</a></span>setType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dtPoly::setType </td>
<td>(</td>
<td class="paramtype">unsigned char&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the polygon type. (See: <a class="el" href="DetourNavMesh_8h.html#a19937b4ff098f7c52ee08af1b5f39c98" title="Flags representing the type of a navigation mesh polygon.">dtPolyTypes</a>.) </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af3caa090f5d4776766bf56f82c27a899" name="af3caa090f5d4776766bf56f82c27a899"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3caa090f5d4776766bf56f82c27a899">&#9670;&#160;</a></span>areaAndtype</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtPoly::areaAndtype</td>
</tr>
</table>
</div><div class="memdoc">
<p>The bit packed area id and polygon type. </p>
<dl class="section note"><dt>Note</dt><dd>Use the structure's set and get methods to access this value. </dd></dl>
</div>
</div>
<a id="a671fd6893087936e80fcd17f7f666c0e" name="a671fd6893087936e80fcd17f7f666c0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a671fd6893087936e80fcd17f7f666c0e">&#9670;&#160;</a></span>firstLink</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int dtPoly::firstLink</td>
</tr>
</table>
</div><div class="memdoc">
<p>Index to first link in linked list. (Or <a class="el" href="DetourNavMesh_8h.html#aca31b5eadafd19285e16eca707b3295b" title="A value that indicates the entity does not link to anything.">DT_NULL_LINK</a> if there is no link.) </p>
</div>
</div>
<a id="a47312e2c5dfd1ff1a729580c339f0d7d" name="a47312e2c5dfd1ff1a729580c339f0d7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47312e2c5dfd1ff1a729580c339f0d7d">&#9670;&#160;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short dtPoly::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>The user defined polygon flags. </p>
</div>
</div>
<a id="ac4f5aa32df32aa5b1385f76f697376af" name="ac4f5aa32df32aa5b1385f76f697376af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4f5aa32df32aa5b1385f76f697376af">&#9670;&#160;</a></span>neis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short dtPoly::neis[<a class="el" href="group__detour.html#ga8591fdac662dbfabb580de626c64c9f3">DT_VERTS_PER_POLYGON</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Packed data representing neighbor polygons references and flags for each edge. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>Each entry represents data for the edge starting at the vertex of the same index. E.g. The entry at index n represents the edge data for vertex[n] to vertex[n+1].</p>
<p>A value of zero indicates the edge has no polygon connection. (It makes up the border of the navigation mesh.)</p>
<p>The information can be extracted as follows: </p><div class="fragment"><div class="line">neighborRef = <a class="code hl_variable" href="structdtPoly.html#ac4f5aa32df32aa5b1385f76f697376af">neis</a>[n] &amp; 0xff; <span class="comment">// Get the neighbor polygon reference.</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (<a class="code hl_variable" href="structdtPoly.html#ac4f5aa32df32aa5b1385f76f697376af">neis</a>[n] &amp; #DT_EX_LINK)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// The edge is an external (portal) edge.</span></div>
<div class="line">}</div>
<div class="ttc" id="astructdtPoly_html_ac4f5aa32df32aa5b1385f76f697376af"><div class="ttname"><a href="structdtPoly.html#ac4f5aa32df32aa5b1385f76f697376af">dtPoly::neis</a></div><div class="ttdeci">unsigned short neis[DT_VERTS_PER_POLYGON]</div><div class="ttdoc">Packed data representing neighbor polygons references and flags for each edge.</div><div class="ttdef"><b>Definition</b> DetourNavMesh.h:165</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="af940c431464c022f844e61130f83d9c2" name="af940c431464c022f844e61130f83d9c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af940c431464c022f844e61130f83d9c2">&#9670;&#160;</a></span>vertCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtPoly::vertCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of vertices in the polygon. </p>
</div>
</div>
<a id="acff94eb19526d33ef3c966b583d1d73f" name="acff94eb19526d33ef3c966b583d1d73f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acff94eb19526d33ef3c966b583d1d73f">&#9670;&#160;</a></span>verts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short dtPoly::verts[<a class="el" href="group__detour.html#ga8591fdac662dbfabb580de626c64c9f3">DT_VERTS_PER_POLYGON</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The indices of the polygon's vertices. </p>
<p>The actual vertices are located in <a class="el" href="structdtMeshTile.html#abee62e6320aff3e2d0cdce239ec2c549" title="The tile vertices. [(x, y, z) * dtMeshHeader::vertCount].">dtMeshTile::verts</a>. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="DetourNavMesh_8h_source.html">DetourNavMesh.h</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="structdtPoly.html">dtPoly</a></li>
&nbsp;&nbsp;<a href="https://github.com/recastnavigation/recastnavigation">Project Home</a>
| <a href="./License.txt">Licence (ZLib)</a>
| Copyright 2009 Mikko Mononen
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink