mirror of
https://github.com/recastnavigation/recastnavigation.git
synced 2026-06-11 17:53:48 +00:00
249 lines
12 KiB
HTML
249 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: dtOffMeshConnection 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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('structdtOffMeshConnection.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> |
|
|
<a href="structdtOffMeshConnection-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">dtOffMeshConnection Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Defines an navigation mesh off-mesh connection within a <a class="el" href="structdtMeshTile.html" title="Defines a navigation mesh tile.">dtMeshTile</a> object.
|
|
<a href="structdtOffMeshConnection.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 id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a1ad6f470aa15ca67e1df62d692a4efe4" id="r_a1ad6f470aa15ca67e1df62d692a4efe4"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtOffMeshConnection.html#a1ad6f470aa15ca67e1df62d692a4efe4">pos</a> [6]</td></tr>
|
|
<tr class="memdesc:a1ad6f470aa15ca67e1df62d692a4efe4"><td class="mdescLeft"> </td><td class="mdescRight">The endpoints of the connection. [(ax, ay, az, bx, by, bz)]. <br /></td></tr>
|
|
<tr class="separator:a1ad6f470aa15ca67e1df62d692a4efe4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5ea87d3e8c0d6c1bd5afeac3f954fa1" id="r_af5ea87d3e8c0d6c1bd5afeac3f954fa1"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtOffMeshConnection.html#af5ea87d3e8c0d6c1bd5afeac3f954fa1">rad</a></td></tr>
|
|
<tr class="memdesc:af5ea87d3e8c0d6c1bd5afeac3f954fa1"><td class="mdescLeft"> </td><td class="mdescRight">The radius of the endpoints. [Limit: >= 0]. <br /></td></tr>
|
|
<tr class="separator:af5ea87d3e8c0d6c1bd5afeac3f954fa1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b6b7097d8fd55a5e7f7173a40d01325" id="r_a4b6b7097d8fd55a5e7f7173a40d01325"><td class="memItemLeft" align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtOffMeshConnection.html#a4b6b7097d8fd55a5e7f7173a40d01325">poly</a></td></tr>
|
|
<tr class="memdesc:a4b6b7097d8fd55a5e7f7173a40d01325"><td class="mdescLeft"> </td><td class="mdescRight">The polygon reference of the connection within the tile. <br /></td></tr>
|
|
<tr class="separator:a4b6b7097d8fd55a5e7f7173a40d01325"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adf581af16754d8bbed1479cdf91dd82d" id="r_adf581af16754d8bbed1479cdf91dd82d"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtOffMeshConnection.html#adf581af16754d8bbed1479cdf91dd82d">flags</a></td></tr>
|
|
<tr class="memdesc:adf581af16754d8bbed1479cdf91dd82d"><td class="mdescLeft"> </td><td class="mdescRight">Link flags. <br /></td></tr>
|
|
<tr class="separator:adf581af16754d8bbed1479cdf91dd82d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c193e7df9998a218be48a39b2be1488" id="r_a8c193e7df9998a218be48a39b2be1488"><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtOffMeshConnection.html#a8c193e7df9998a218be48a39b2be1488">side</a></td></tr>
|
|
<tr class="memdesc:a8c193e7df9998a218be48a39b2be1488"><td class="mdescLeft"> </td><td class="mdescRight">End point side. <br /></td></tr>
|
|
<tr class="separator:a8c193e7df9998a218be48a39b2be1488"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a157eae33ff9cb301e25f822a9d0b74dc" id="r_a157eae33ff9cb301e25f822a9d0b74dc"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtOffMeshConnection.html#a157eae33ff9cb301e25f822a9d0b74dc">userId</a></td></tr>
|
|
<tr class="memdesc:a157eae33ff9cb301e25f822a9d0b74dc"><td class="mdescLeft"> </td><td class="mdescRight">The id of the offmesh connection. (User assigned when the navigation mesh is built.) <br /></td></tr>
|
|
<tr class="separator:a157eae33ff9cb301e25f822a9d0b74dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<div class="textblock"><p>Defines an navigation mesh off-mesh connection within a <a class="el" href="structdtMeshTile.html" title="Defines a navigation mesh tile.">dtMeshTile</a> object. </p>
|
|
<p>An off-mesh connection is a user defined traversable connection made up to two vertices. </p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="adf581af16754d8bbed1479cdf91dd82d" name="adf581af16754d8bbed1479cdf91dd82d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf581af16754d8bbed1479cdf91dd82d">◆ </a></span>flags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned char dtOffMeshConnection::flags</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Link flags. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>These are not the connection's user defined flags. Those are assigned via the connection's <a class="el" href="structdtPoly.html" title="Defines a polygon within a dtMeshTile object.">dtPoly</a> definition. These are link flags used for internal purposes. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b6b7097d8fd55a5e7f7173a40d01325" name="a4b6b7097d8fd55a5e7f7173a40d01325"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b6b7097d8fd55a5e7f7173a40d01325">◆ </a></span>poly</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned short dtOffMeshConnection::poly</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The polygon reference of the connection within the tile. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1ad6f470aa15ca67e1df62d692a4efe4" name="a1ad6f470aa15ca67e1df62d692a4efe4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ad6f470aa15ca67e1df62d692a4efe4">◆ </a></span>pos</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float dtOffMeshConnection::pos[6]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The endpoints of the connection. [(ax, ay, az, bx, by, bz)]. </p>
|
|
<dl class="section user"><dt></dt><dd></dd></dl>
|
|
<p>For a properly built navigation mesh, vertex A will always be within the bounds of the mesh. Vertex B is not required to be within the bounds of the mesh. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5ea87d3e8c0d6c1bd5afeac3f954fa1" name="af5ea87d3e8c0d6c1bd5afeac3f954fa1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5ea87d3e8c0d6c1bd5afeac3f954fa1">◆ </a></span>rad</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float dtOffMeshConnection::rad</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The radius of the endpoints. [Limit: >= 0]. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c193e7df9998a218be48a39b2be1488" name="a8c193e7df9998a218be48a39b2be1488"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c193e7df9998a218be48a39b2be1488">◆ </a></span>side</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned char dtOffMeshConnection::side</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>End point side. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a157eae33ff9cb301e25f822a9d0b74dc" name="a157eae33ff9cb301e25f822a9d0b74dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a157eae33ff9cb301e25f822a9d0b74dc">◆ </a></span>userId</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int dtOffMeshConnection::userId</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The id of the offmesh connection. (User assigned when the navigation mesh is built.) </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="structdtOffMeshConnection.html">dtOffMeshConnection</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>
|