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

369 lines
20 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: rcContourSet 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('structrcContourSet.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="structrcContourSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">rcContourSet Struct Reference<div class="ingroups"><a class="el" href="group__recast.html">Recast</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Represents a group of related contours.
<a href="structrcContourSet.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-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a01481af6f568ea6098fc5fa4fc5140f7" id="r_a01481af6f568ea6098fc5fa4fc5140f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#a01481af6f568ea6098fc5fa4fc5140f7">rcContourSet</a> ()</td></tr>
<tr class="separator:a01481af6f568ea6098fc5fa4fc5140f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab94de9c515eac08480d33cadc50a5a2b" id="r_ab94de9c515eac08480d33cadc50a5a2b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#ab94de9c515eac08480d33cadc50a5a2b">~rcContourSet</a> ()</td></tr>
<tr class="separator:ab94de9c515eac08480d33cadc50a5a2b"><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:ad737b7220701eeae5aa9c488d4d4f18d" id="r_ad737b7220701eeae5aa9c488d4d4f18d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrcContour.html">rcContour</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#ad737b7220701eeae5aa9c488d4d4f18d">conts</a></td></tr>
<tr class="memdesc:ad737b7220701eeae5aa9c488d4d4f18d"><td class="mdescLeft">&#160;</td><td class="mdescRight">An array of the contours in the set. [Size: <a class="el" href="structrcContourSet.html#aa751e5adb077b2ea7a9c8795e7a2fa99" title="The number of contours in the set.">nconts</a>]. <br /></td></tr>
<tr class="separator:ad737b7220701eeae5aa9c488d4d4f18d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa751e5adb077b2ea7a9c8795e7a2fa99" id="r_aa751e5adb077b2ea7a9c8795e7a2fa99"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#aa751e5adb077b2ea7a9c8795e7a2fa99">nconts</a></td></tr>
<tr class="memdesc:aa751e5adb077b2ea7a9c8795e7a2fa99"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of contours in the set. <br /></td></tr>
<tr class="separator:aa751e5adb077b2ea7a9c8795e7a2fa99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6528f1d81286f5bff26ae217c33da654" id="r_a6528f1d81286f5bff26ae217c33da654"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#a6528f1d81286f5bff26ae217c33da654">bmin</a> [3]</td></tr>
<tr class="memdesc:a6528f1d81286f5bff26ae217c33da654"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum bounds in world space. [(x, y, z)]. <br /></td></tr>
<tr class="separator:a6528f1d81286f5bff26ae217c33da654"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae756cdf05388b7455768011841c0f6a1" id="r_ae756cdf05388b7455768011841c0f6a1"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#ae756cdf05388b7455768011841c0f6a1">bmax</a> [3]</td></tr>
<tr class="memdesc:ae756cdf05388b7455768011841c0f6a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum bounds in world space. [(x, y, z)]. <br /></td></tr>
<tr class="separator:ae756cdf05388b7455768011841c0f6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dbf04db7e828a3757e951e4f8499c95" id="r_a1dbf04db7e828a3757e951e4f8499c95"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#a1dbf04db7e828a3757e951e4f8499c95">cs</a></td></tr>
<tr class="memdesc:a1dbf04db7e828a3757e951e4f8499c95"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of each cell. (On the xz-plane.) <br /></td></tr>
<tr class="separator:a1dbf04db7e828a3757e951e4f8499c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada4d5c2916f351065c6f5a382f087ebc" id="r_ada4d5c2916f351065c6f5a382f087ebc"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#ada4d5c2916f351065c6f5a382f087ebc">ch</a></td></tr>
<tr class="memdesc:ada4d5c2916f351065c6f5a382f087ebc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of each cell. (The minimum increment along the y-axis.) <br /></td></tr>
<tr class="separator:ada4d5c2916f351065c6f5a382f087ebc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af165415f9e2ef3cf446786040864e6d2" id="r_af165415f9e2ef3cf446786040864e6d2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#af165415f9e2ef3cf446786040864e6d2">width</a></td></tr>
<tr class="memdesc:af165415f9e2ef3cf446786040864e6d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the set. (Along the x-axis in cell units.) <br /></td></tr>
<tr class="separator:af165415f9e2ef3cf446786040864e6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18be0e9d84b65e8688153b0adb517124" id="r_a18be0e9d84b65e8688153b0adb517124"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#a18be0e9d84b65e8688153b0adb517124">height</a></td></tr>
<tr class="memdesc:a18be0e9d84b65e8688153b0adb517124"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the set. (Along the z-axis in cell units.) <br /></td></tr>
<tr class="separator:a18be0e9d84b65e8688153b0adb517124"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb04d1277e815ed89b156714bad3c17a" id="r_adb04d1277e815ed89b156714bad3c17a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#adb04d1277e815ed89b156714bad3c17a">borderSize</a></td></tr>
<tr class="memdesc:adb04d1277e815ed89b156714bad3c17a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The AABB border size used to generate the source data from which the contours were derived. <br /></td></tr>
<tr class="separator:adb04d1277e815ed89b156714bad3c17a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af657b46878e8fff2dd731ee066e4e1b2" id="r_af657b46878e8fff2dd731ee066e4e1b2"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcContourSet.html#af657b46878e8fff2dd731ee066e4e1b2">maxError</a></td></tr>
<tr class="memdesc:af657b46878e8fff2dd731ee066e4e1b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The max edge error that this contour set was simplified with. <br /></td></tr>
<tr class="separator:af657b46878e8fff2dd731ee066e4e1b2"><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 group of related contours. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>All contours within the set share the minimum bounds and cell sizes of the set.</p>
<p>The standard process for building a contour set is to allocate it using <a class="el" href="group__recast.html#ga93c723c27eee8e8d7eda2a1e893453f2" title="Allocates a contour set object using the Recast allocator.">rcAllocContourSet</a>, then initialize it using <a class="el" href="group__recast.html#gae211dbabbd2a9e3e3e374452f3fa4dfc" title="Builds a contour set from the region outlines in the provided compact heightfield.">rcBuildContours</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__recast.html#ga93c723c27eee8e8d7eda2a1e893453f2" title="Allocates a contour set object using the Recast allocator.">rcAllocContourSet</a>, <a class="el" href="group__recast.html#gae3a9621529cb8d471a95161bd7d0ca96" title="Frees the specified contour set using the Recast allocator.">rcFreeContourSet</a>, <a class="el" href="group__recast.html#gae211dbabbd2a9e3e3e374452f3fa4dfc" title="Builds a contour set from the region outlines in the provided compact heightfield.">rcBuildContours</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a01481af6f568ea6098fc5fa4fc5140f7" name="a01481af6f568ea6098fc5fa4fc5140f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01481af6f568ea6098fc5fa4fc5140f7">&#9670;&#160;</a></span>rcContourSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rcContourSet::rcContourSet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab94de9c515eac08480d33cadc50a5a2b" name="ab94de9c515eac08480d33cadc50a5a2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab94de9c515eac08480d33cadc50a5a2b">&#9670;&#160;</a></span>~rcContourSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rcContourSet::~rcContourSet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae756cdf05388b7455768011841c0f6a1" name="ae756cdf05388b7455768011841c0f6a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae756cdf05388b7455768011841c0f6a1">&#9670;&#160;</a></span>bmax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcContourSet::bmax[3]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum bounds in world space. [(x, y, z)]. </p>
</div>
</div>
<a id="a6528f1d81286f5bff26ae217c33da654" name="a6528f1d81286f5bff26ae217c33da654"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6528f1d81286f5bff26ae217c33da654">&#9670;&#160;</a></span>bmin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcContourSet::bmin[3]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum bounds in world space. [(x, y, z)]. </p>
</div>
</div>
<a id="adb04d1277e815ed89b156714bad3c17a" name="adb04d1277e815ed89b156714bad3c17a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb04d1277e815ed89b156714bad3c17a">&#9670;&#160;</a></span>borderSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcContourSet::borderSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>The AABB border size used to generate the source data from which the contours were derived. </p>
</div>
</div>
<a id="ada4d5c2916f351065c6f5a382f087ebc" name="ada4d5c2916f351065c6f5a382f087ebc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada4d5c2916f351065c6f5a382f087ebc">&#9670;&#160;</a></span>ch</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcContourSet::ch</td>
</tr>
</table>
</div><div class="memdoc">
<p>The height of each cell. (The minimum increment along the y-axis.) </p>
</div>
</div>
<a id="ad737b7220701eeae5aa9c488d4d4f18d" name="ad737b7220701eeae5aa9c488d4d4f18d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad737b7220701eeae5aa9c488d4d4f18d">&#9670;&#160;</a></span>conts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structrcContour.html">rcContour</a>* rcContourSet::conts</td>
</tr>
</table>
</div><div class="memdoc">
<p>An array of the contours in the set. [Size: <a class="el" href="structrcContourSet.html#aa751e5adb077b2ea7a9c8795e7a2fa99" title="The number of contours in the set.">nconts</a>]. </p>
</div>
</div>
<a id="a1dbf04db7e828a3757e951e4f8499c95" name="a1dbf04db7e828a3757e951e4f8499c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dbf04db7e828a3757e951e4f8499c95">&#9670;&#160;</a></span>cs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcContourSet::cs</td>
</tr>
</table>
</div><div class="memdoc">
<p>The size of each cell. (On the xz-plane.) </p>
</div>
</div>
<a id="a18be0e9d84b65e8688153b0adb517124" name="a18be0e9d84b65e8688153b0adb517124"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18be0e9d84b65e8688153b0adb517124">&#9670;&#160;</a></span>height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcContourSet::height</td>
</tr>
</table>
</div><div class="memdoc">
<p>The height of the set. (Along the z-axis in cell units.) </p>
</div>
</div>
<a id="af657b46878e8fff2dd731ee066e4e1b2" name="af657b46878e8fff2dd731ee066e4e1b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af657b46878e8fff2dd731ee066e4e1b2">&#9670;&#160;</a></span>maxError</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcContourSet::maxError</td>
</tr>
</table>
</div><div class="memdoc">
<p>The max edge error that this contour set was simplified with. </p>
</div>
</div>
<a id="aa751e5adb077b2ea7a9c8795e7a2fa99" name="aa751e5adb077b2ea7a9c8795e7a2fa99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa751e5adb077b2ea7a9c8795e7a2fa99">&#9670;&#160;</a></span>nconts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcContourSet::nconts</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of contours in the set. </p>
</div>
</div>
<a id="af165415f9e2ef3cf446786040864e6d2" name="af165415f9e2ef3cf446786040864e6d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af165415f9e2ef3cf446786040864e6d2">&#9670;&#160;</a></span>width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcContourSet::width</td>
</tr>
</table>
</div><div class="memdoc">
<p>The width of the set. (Along the x-axis in cell units.) </p>
</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_8cpp.html">Recast.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="structrcContourSet.html">rcContourSet</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