Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-06-08 08:13:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
recastnavigation/structrcContour.html

278 lines
16 KiB
HTML
Raw Permalink 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: rcContour 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('structrcContour.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="structrcContour-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">rcContour Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a simple, non-overlapping contour in field space.
<a href="structrcContour.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Recast_8h_source.html">Recast.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:a71a33a9ba0930586b0c8ba595267d9da" id="r_a71a33a9ba0930586b0c8ba595267d9da"><td class="memItemLeft" align="right" valign="top">int *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContour.html#a71a33a9ba0930586b0c8ba595267d9da">verts</a></td></tr>
<tr class="memdesc:a71a33a9ba0930586b0c8ba595267d9da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simplified contour vertex and connection data. [Size: 4 * <a class="el" href="structrcContour.html#afcf77c01352f2c46172fdfabd2f9b9f6" title="The number of vertices in the simplified contour.">nverts</a>]. <br /></td></tr>
<tr class="separator:a71a33a9ba0930586b0c8ba595267d9da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcf77c01352f2c46172fdfabd2f9b9f6" id="r_afcf77c01352f2c46172fdfabd2f9b9f6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContour.html#afcf77c01352f2c46172fdfabd2f9b9f6">nverts</a></td></tr>
<tr class="memdesc:afcf77c01352f2c46172fdfabd2f9b9f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of vertices in the simplified contour. <br /></td></tr>
<tr class="separator:afcf77c01352f2c46172fdfabd2f9b9f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4875d6bf00efae95009d0fe8ccb1f0e9" id="r_a4875d6bf00efae95009d0fe8ccb1f0e9"><td class="memItemLeft" align="right" valign="top">int *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContour.html#a4875d6bf00efae95009d0fe8ccb1f0e9">rverts</a></td></tr>
<tr class="memdesc:a4875d6bf00efae95009d0fe8ccb1f0e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raw contour vertex and connection data. [Size: 4 * <a class="el" href="structrcContour.html#a0cceba5f2070c42ac2a871189d4ceb53" title="The number of vertices in the raw contour.">nrverts</a>]. <br /></td></tr>
<tr class="separator:a4875d6bf00efae95009d0fe8ccb1f0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cceba5f2070c42ac2a871189d4ceb53" id="r_a0cceba5f2070c42ac2a871189d4ceb53"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContour.html#a0cceba5f2070c42ac2a871189d4ceb53">nrverts</a></td></tr>
<tr class="memdesc:a0cceba5f2070c42ac2a871189d4ceb53"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of vertices in the raw contour. <br /></td></tr>
<tr class="separator:a0cceba5f2070c42ac2a871189d4ceb53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8971d5c5cc7c7fb8e5d79a6ff9812cd1" id="r_a8971d5c5cc7c7fb8e5d79a6ff9812cd1"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContour.html#a8971d5c5cc7c7fb8e5d79a6ff9812cd1">reg</a></td></tr>
<tr class="memdesc:a8971d5c5cc7c7fb8e5d79a6ff9812cd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The region id of the contour. <br /></td></tr>
<tr class="separator:a8971d5c5cc7c7fb8e5d79a6ff9812cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1052e9ac2da6e515cbb12908a58fca78" id="r_a1052e9ac2da6e515cbb12908a58fca78"><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContour.html#a1052e9ac2da6e515cbb12908a58fca78">area</a></td></tr>
<tr class="memdesc:a1052e9ac2da6e515cbb12908a58fca78"><td class="mdescLeft">&#160;</td><td class="mdescRight">The area id of the contour. <br /></td></tr>
<tr class="separator:a1052e9ac2da6e515cbb12908a58fca78"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Represents a simple, non-overlapping contour in field space. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>A contour only exists within the context of a <a class="el" href="structrcContourSet.html" title="Represents a group of related contours.">rcContourSet</a> object.</p>
<p>While the height of the contour's border may vary, the contour will always form a simple polygon when projected onto the xz-plane.</p>
<p>Example of converting vertices into world space:</p>
<div class="fragment"><div class="line"><span class="comment">// Where cset is the rcContourSet object to which the contour belongs.</span></div>
<div class="line"><span class="keywordtype">float</span> worldX = cset.bmin[0] + vertX * cset.cs;</div>
<div class="line"><span class="keywordtype">float</span> worldY = cset.bmin[1] + vertY * cset.ch;</div>
<div class="line"><span class="keywordtype">float</span> worldZ = cset.bmin[2] + vertZ * cset.cs;</div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="structrcContourSet.html" title="Represents a group of related contours.">rcContourSet</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a1052e9ac2da6e515cbb12908a58fca78" name="a1052e9ac2da6e515cbb12908a58fca78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1052e9ac2da6e515cbb12908a58fca78">&#9670;&#160;</a></span>area</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char rcContour::area</td>
</tr>
</table>
</div><div class="memdoc">
<p>The area id of the contour. </p>
</div>
</div>
<a id="a0cceba5f2070c42ac2a871189d4ceb53" name="a0cceba5f2070c42ac2a871189d4ceb53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cceba5f2070c42ac2a871189d4ceb53">&#9670;&#160;</a></span>nrverts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcContour::nrverts</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of vertices in the raw contour. </p>
</div>
</div>
<a id="afcf77c01352f2c46172fdfabd2f9b9f6" name="afcf77c01352f2c46172fdfabd2f9b9f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcf77c01352f2c46172fdfabd2f9b9f6">&#9670;&#160;</a></span>nverts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcContour::nverts</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of vertices in the simplified contour. </p>
</div>
</div>
<a id="a8971d5c5cc7c7fb8e5d79a6ff9812cd1" name="a8971d5c5cc7c7fb8e5d79a6ff9812cd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8971d5c5cc7c7fb8e5d79a6ff9812cd1">&#9670;&#160;</a></span>reg</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short rcContour::reg</td>
</tr>
</table>
</div><div class="memdoc">
<p>The region id of the contour. </p>
</div>
</div>
<a id="a4875d6bf00efae95009d0fe8ccb1f0e9" name="a4875d6bf00efae95009d0fe8ccb1f0e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4875d6bf00efae95009d0fe8ccb1f0e9">&#9670;&#160;</a></span>rverts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rcContour::rverts</td>
</tr>
</table>
</div><div class="memdoc">
<p>Raw contour vertex and connection data. [Size: 4 * <a class="el" href="structrcContour.html#a0cceba5f2070c42ac2a871189d4ceb53" title="The number of vertices in the raw contour.">nrverts</a>]. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>See <a class="el" href="structrcContour.html#a71a33a9ba0930586b0c8ba595267d9da" title="Simplified contour vertex and connection data. [Size: 4 * nverts].">verts</a> for information on element layout. </p>
</div>
</div>
<a id="a71a33a9ba0930586b0c8ba595267d9da" name="a71a33a9ba0930586b0c8ba595267d9da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71a33a9ba0930586b0c8ba595267d9da">&#9670;&#160;</a></span>verts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rcContour::verts</td>
</tr>
</table>
</div><div class="memdoc">
<p>Simplified contour vertex and connection data. [Size: 4 * <a class="el" href="structrcContour.html#afcf77c01352f2c46172fdfabd2f9b9f6" title="The number of vertices in the simplified contour.">nverts</a>]. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>The simplified contour is a version of the raw contour with all 'unnecessary' vertices removed. Whether a vertex is considered unnecessary depends on the contour build process.</p>
<p>The data format is as follows: (x, y, z, r) * <a class="el" href="structrcContour.html#afcf77c01352f2c46172fdfabd2f9b9f6" title="The number of vertices in the simplified contour.">nverts</a></p>
<p>A contour edge is formed by the current and next vertex. The r-value represents region and connection information for the edge. For example:</p>
<div class="fragment"><div class="line"><span class="keywordtype">int</span> r = <a class="code hl_variable" href="structrcContour.html#a71a33a9ba0930586b0c8ba595267d9da">verts</a>[i*4+3];</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> regionId = r &amp; <a class="code hl_variable" href="Recast_8h.html#a86c6c9df2df0402a9d026fb9603fb02b">RC_CONTOUR_REG_MASK</a>;</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (r &amp; <a class="code hl_variable" href="Recast_8h.html#a8b57de86c98abbad39cce7df7c0aa1f8">RC_BORDER_VERTEX</a>)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// The edge represents a solid border.</span></div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">if</span> (r &amp; <a class="code hl_variable" href="Recast_8h.html#a55bb146cbd1c0ec0e06ca8e90dd5b7bc">RC_AREA_BORDER</a>)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// The edge represents a transition between different areas.</span></div>
<div class="line">}</div>
<div class="ttc" id="aRecast_8h_html_a55bb146cbd1c0ec0e06ca8e90dd5b7bc"><div class="ttname"><a href="Recast_8h.html#a55bb146cbd1c0ec0e06ca8e90dd5b7bc">RC_AREA_BORDER</a></div><div class="ttdeci">static const int RC_AREA_BORDER</div><div class="ttdoc">Area border flag.</div><div class="ttdef"><b>Definition</b> Recast.h:611</div></div>
<div class="ttc" id="aRecast_8h_html_a86c6c9df2df0402a9d026fb9603fb02b"><div class="ttname"><a href="Recast_8h.html#a86c6c9df2df0402a9d026fb9603fb02b">RC_CONTOUR_REG_MASK</a></div><div class="ttdeci">static const int RC_CONTOUR_REG_MASK</div><div class="ttdoc">Applied to the region id field of contour vertices in order to extract the region id.</div><div class="ttdef"><b>Definition</b> Recast.h:625</div></div>
<div class="ttc" id="aRecast_8h_html_a8b57de86c98abbad39cce7df7c0aa1f8"><div class="ttname"><a href="Recast_8h.html#a8b57de86c98abbad39cce7df7c0aa1f8">RC_BORDER_VERTEX</a></div><div class="ttdeci">static const int RC_BORDER_VERTEX</div><div class="ttdoc">Border vertex flag.</div><div class="ttdef"><b>Definition</b> Recast.h:604</div></div>
<div class="ttc" id="astructrcContour_html_a71a33a9ba0930586b0c8ba595267d9da"><div class="ttname"><a href="structrcContour.html#a71a33a9ba0930586b0c8ba595267d9da">rcContour::verts</a></div><div class="ttdeci">int * verts</div><div class="ttdoc">Simplified contour vertex and connection data. [Size: 4 * nverts].</div><div class="ttdef"><b>Definition</b> Recast.h:422</div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="Recast_8h_source.html">Recast.h</a></li>
<li><a class="el" href="Recast__api_8txt.html">Recast_api.txt</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="structrcContour.html">rcContour</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