Files
recastnavigation/structdtLink.html

247 lines
12 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" 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: dtLink 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('structdtLink.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-attribs">Public Attributes</a> &#124;
<a href="structdtLink-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">dtLink Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Defines a link between polygons.
<a href="structdtLink.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-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a34c73193fed76de347adb0f2e9841659" id="r_a34c73193fed76de347adb0f2e9841659"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtLink.html#a34c73193fed76de347adb0f2e9841659">ref</a></td></tr>
<tr class="memdesc:a34c73193fed76de347adb0f2e9841659"><td class="mdescLeft">&#160;</td><td class="mdescRight">Neighbour reference. (The neighbor that is linked to.) <br /></td></tr>
<tr class="separator:a34c73193fed76de347adb0f2e9841659"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a475b893f03bf4c942ab6376d83dca82e" id="r_a475b893f03bf4c942ab6376d83dca82e"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtLink.html#a475b893f03bf4c942ab6376d83dca82e">next</a></td></tr>
<tr class="memdesc:a475b893f03bf4c942ab6376d83dca82e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of the next link. <br /></td></tr>
<tr class="separator:a475b893f03bf4c942ab6376d83dca82e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14ff7d317cbceba6ab9d1958b463cb3a" id="r_a14ff7d317cbceba6ab9d1958b463cb3a"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtLink.html#a14ff7d317cbceba6ab9d1958b463cb3a">edge</a></td></tr>
<tr class="memdesc:a14ff7d317cbceba6ab9d1958b463cb3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of the polygon edge that owns this link. <br /></td></tr>
<tr class="separator:a14ff7d317cbceba6ab9d1958b463cb3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62d34d0e6350fe9790e91ec287bc1423" id="r_a62d34d0e6350fe9790e91ec287bc1423"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtLink.html#a62d34d0e6350fe9790e91ec287bc1423">side</a></td></tr>
<tr class="memdesc:a62d34d0e6350fe9790e91ec287bc1423"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a boundary link, defines on which side the link is. <br /></td></tr>
<tr class="separator:a62d34d0e6350fe9790e91ec287bc1423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0123fe6375fa414a48b2e73c3b23a1ce" id="r_a0123fe6375fa414a48b2e73c3b23a1ce"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtLink.html#a0123fe6375fa414a48b2e73c3b23a1ce">bmin</a></td></tr>
<tr class="memdesc:a0123fe6375fa414a48b2e73c3b23a1ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a boundary link, defines the minimum sub-edge area. <br /></td></tr>
<tr class="separator:a0123fe6375fa414a48b2e73c3b23a1ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8a3afc341614707afb915d2822ffdc7" id="r_ac8a3afc341614707afb915d2822ffdc7"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdtLink.html#ac8a3afc341614707afb915d2822ffdc7">bmax</a></td></tr>
<tr class="memdesc:ac8a3afc341614707afb915d2822ffdc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">If a boundary link, defines the maximum sub-edge area. <br /></td></tr>
<tr class="separator:ac8a3afc341614707afb915d2822ffdc7"><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 link between polygons. </p>
<dl class="section note"><dt>Note</dt><dd>This structure is rarely if ever used by the end user. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structdtMeshTile.html" title="Defines a navigation mesh tile.">dtMeshTile</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ac8a3afc341614707afb915d2822ffdc7" name="ac8a3afc341614707afb915d2822ffdc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8a3afc341614707afb915d2822ffdc7">&#9670;&#160;</a></span>bmax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtLink::bmax</td>
</tr>
</table>
</div><div class="memdoc">
<p>If a boundary link, defines the maximum sub-edge area. </p>
</div>
</div>
<a id="a0123fe6375fa414a48b2e73c3b23a1ce" name="a0123fe6375fa414a48b2e73c3b23a1ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0123fe6375fa414a48b2e73c3b23a1ce">&#9670;&#160;</a></span>bmin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtLink::bmin</td>
</tr>
</table>
</div><div class="memdoc">
<p>If a boundary link, defines the minimum sub-edge area. </p>
</div>
</div>
<a id="a14ff7d317cbceba6ab9d1958b463cb3a" name="a14ff7d317cbceba6ab9d1958b463cb3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14ff7d317cbceba6ab9d1958b463cb3a">&#9670;&#160;</a></span>edge</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtLink::edge</td>
</tr>
</table>
</div><div class="memdoc">
<p>Index of the polygon edge that owns this link. </p>
</div>
</div>
<a id="a475b893f03bf4c942ab6376d83dca82e" name="a475b893f03bf4c942ab6376d83dca82e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a475b893f03bf4c942ab6376d83dca82e">&#9670;&#160;</a></span>next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int dtLink::next</td>
</tr>
</table>
</div><div class="memdoc">
<p>Index of the next link. </p>
</div>
</div>
<a id="a34c73193fed76de347adb0f2e9841659" name="a34c73193fed76de347adb0f2e9841659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34c73193fed76de347adb0f2e9841659">&#9670;&#160;</a></span>ref</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__detour.html#gab4e0b2257a670c1a800057999612b466">dtPolyRef</a> dtLink::ref</td>
</tr>
</table>
</div><div class="memdoc">
<p>Neighbour reference. (The neighbor that is linked to.) </p>
</div>
</div>
<a id="a62d34d0e6350fe9790e91ec287bc1423" name="a62d34d0e6350fe9790e91ec287bc1423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62d34d0e6350fe9790e91ec287bc1423">&#9670;&#160;</a></span>side</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char dtLink::side</td>
</tr>
</table>
</div><div class="memdoc">
<p>If a boundary link, defines on which side the link is. </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="structdtLink.html">dtLink</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>