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/structrcCompactHeightfield.html

558 lines
41 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: rcCompactHeightfield 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('structrcCompactHeightfield.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="structrcCompactHeightfield-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">rcCompactHeightfield Struct Reference<div class="ingroups"><a class="el" href="group__recast.html">Recast</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>A compact, static heightfield representing unobstructed space.
<a href="structrcCompactHeightfield.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:a33d0846cef5f90e605f272b61277ffb0" id="r_a33d0846cef5f90e605f272b61277ffb0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a33d0846cef5f90e605f272b61277ffb0">rcCompactHeightfield</a> ()</td></tr>
<tr class="separator:a33d0846cef5f90e605f272b61277ffb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea6121b36d3fb1cab5955a7915c68809" id="r_aea6121b36d3fb1cab5955a7915c68809"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#aea6121b36d3fb1cab5955a7915c68809">~rcCompactHeightfield</a> ()</td></tr>
<tr class="separator:aea6121b36d3fb1cab5955a7915c68809"><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:a98868c1df2523cd724696ed1d223ba13" id="r_a98868c1df2523cd724696ed1d223ba13"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a98868c1df2523cd724696ed1d223ba13">width</a></td></tr>
<tr class="memdesc:a98868c1df2523cd724696ed1d223ba13"><td class="mdescLeft">&#160;</td><td class="mdescRight">The width of the heightfield. (Along the x-axis in cell units.) <br /></td></tr>
<tr class="separator:a98868c1df2523cd724696ed1d223ba13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25d9e16e5d82cf698e47b18a5740b639" id="r_a25d9e16e5d82cf698e47b18a5740b639"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a25d9e16e5d82cf698e47b18a5740b639">height</a></td></tr>
<tr class="memdesc:a25d9e16e5d82cf698e47b18a5740b639"><td class="mdescLeft">&#160;</td><td class="mdescRight">The height of the heightfield. (Along the z-axis in cell units.) <br /></td></tr>
<tr class="separator:a25d9e16e5d82cf698e47b18a5740b639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7206a15efe8a9e2a8e28b8c7d89b45bd" id="r_a7206a15efe8a9e2a8e28b8c7d89b45bd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd">spanCount</a></td></tr>
<tr class="memdesc:a7206a15efe8a9e2a8e28b8c7d89b45bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of spans in the heightfield. <br /></td></tr>
<tr class="separator:a7206a15efe8a9e2a8e28b8c7d89b45bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04baed5c41b0e19e525e3136b138dc1a" id="r_a04baed5c41b0e19e525e3136b138dc1a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a04baed5c41b0e19e525e3136b138dc1a">walkableHeight</a></td></tr>
<tr class="memdesc:a04baed5c41b0e19e525e3136b138dc1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The walkable height used during the build of the field. (See: <a class="el" href="structrcConfig.html#a2483649686584b9d696ac00b968dedaa" title="Minimum floor to &#39;ceiling&#39; height that will still allow the floor area to be considered walkable.">rcConfig::walkableHeight</a>) <br /></td></tr>
<tr class="separator:a04baed5c41b0e19e525e3136b138dc1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae403555331ef3d2624ca9433226bd683" id="r_ae403555331ef3d2624ca9433226bd683"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#ae403555331ef3d2624ca9433226bd683">walkableClimb</a></td></tr>
<tr class="memdesc:ae403555331ef3d2624ca9433226bd683"><td class="mdescLeft">&#160;</td><td class="mdescRight">The walkable climb used during the build of the field. (See: <a class="el" href="structrcConfig.html#a9b6bbabb4857e3f4bf4428af86ee7673" title="Maximum ledge height that is considered to still be traversable. [Limit: &gt;=0] [Units: vx].">rcConfig::walkableClimb</a>) <br /></td></tr>
<tr class="separator:ae403555331ef3d2624ca9433226bd683"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a675418d81ce6ade83fbd18be2dfd1647" id="r_a675418d81ce6ade83fbd18be2dfd1647"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a675418d81ce6ade83fbd18be2dfd1647">borderSize</a></td></tr>
<tr class="memdesc:a675418d81ce6ade83fbd18be2dfd1647"><td class="mdescLeft">&#160;</td><td class="mdescRight">The AABB border size used during the build of the field. (See: <a class="el" href="structrcConfig.html#a473ec0f080862d2593099d8ee207da57" title="The size of the non-navigable border around the heightfield. [Limit: &gt;=0] [Units: vx].">rcConfig::borderSize</a>) <br /></td></tr>
<tr class="separator:a675418d81ce6ade83fbd18be2dfd1647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38921b347d72bdc07487d07e7608ffc7" id="r_a38921b347d72bdc07487d07e7608ffc7"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a38921b347d72bdc07487d07e7608ffc7">maxDistance</a></td></tr>
<tr class="memdesc:a38921b347d72bdc07487d07e7608ffc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum distance value of any span within the field. <br /></td></tr>
<tr class="separator:a38921b347d72bdc07487d07e7608ffc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bfb7a2fdb06a64b03f0fffa885edd94" id="r_a6bfb7a2fdb06a64b03f0fffa885edd94"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a6bfb7a2fdb06a64b03f0fffa885edd94">maxRegions</a></td></tr>
<tr class="memdesc:a6bfb7a2fdb06a64b03f0fffa885edd94"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum region id of any span within the field. <br /></td></tr>
<tr class="separator:a6bfb7a2fdb06a64b03f0fffa885edd94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae73d55ffeafd659c189bf14e440b902f" id="r_ae73d55ffeafd659c189bf14e440b902f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#ae73d55ffeafd659c189bf14e440b902f">bmin</a> [3]</td></tr>
<tr class="memdesc:ae73d55ffeafd659c189bf14e440b902f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The minimum bounds in world space. [(x, y, z)]. <br /></td></tr>
<tr class="separator:ae73d55ffeafd659c189bf14e440b902f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d175954135840be9d4e4fc3b36d8067" id="r_a5d175954135840be9d4e4fc3b36d8067"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a5d175954135840be9d4e4fc3b36d8067">bmax</a> [3]</td></tr>
<tr class="memdesc:a5d175954135840be9d4e4fc3b36d8067"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum bounds in world space. [(x, y, z)]. <br /></td></tr>
<tr class="separator:a5d175954135840be9d4e4fc3b36d8067"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75ee8e198d672db29a2f98c7463c0b31" id="r_a75ee8e198d672db29a2f98c7463c0b31"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a75ee8e198d672db29a2f98c7463c0b31">cs</a></td></tr>
<tr class="memdesc:a75ee8e198d672db29a2f98c7463c0b31"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of each cell. (On the xz-plane.) <br /></td></tr>
<tr class="separator:a75ee8e198d672db29a2f98c7463c0b31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39baf56bf3baf2b026aae0a309facaf4" id="r_a39baf56bf3baf2b026aae0a309facaf4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a39baf56bf3baf2b026aae0a309facaf4">ch</a></td></tr>
<tr class="memdesc:a39baf56bf3baf2b026aae0a309facaf4"><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:a39baf56bf3baf2b026aae0a309facaf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab497c9a9f6e0f1b8882fada13ce880a5" id="r_ab497c9a9f6e0f1b8882fada13ce880a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrcCompactCell.html">rcCompactCell</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#ab497c9a9f6e0f1b8882fada13ce880a5">cells</a></td></tr>
<tr class="memdesc:ab497c9a9f6e0f1b8882fada13ce880a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of cells. [Size: <a class="el" href="structrcCompactHeightfield.html#a98868c1df2523cd724696ed1d223ba13" title="The width of the heightfield. (Along the x-axis in cell units.)">width</a>*<a class="el" href="structrcCompactHeightfield.html#a25d9e16e5d82cf698e47b18a5740b639" title="The height of the heightfield. (Along the z-axis in cell units.)">height</a>]. <br /></td></tr>
<tr class="separator:ab497c9a9f6e0f1b8882fada13ce880a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20f5a93095dfd199b0a9baad4127bec3" id="r_a20f5a93095dfd199b0a9baad4127bec3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrcCompactSpan.html">rcCompactSpan</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#a20f5a93095dfd199b0a9baad4127bec3">spans</a></td></tr>
<tr class="memdesc:a20f5a93095dfd199b0a9baad4127bec3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of spans. [Size: <a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd" title="The number of spans in the heightfield.">spanCount</a>]. <br /></td></tr>
<tr class="separator:a20f5a93095dfd199b0a9baad4127bec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af345442d6b49e71a2191c5e2dac3ca97" id="r_af345442d6b49e71a2191c5e2dac3ca97"><td class="memItemLeft" align="right" valign="top">unsigned short *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#af345442d6b49e71a2191c5e2dac3ca97">dist</a></td></tr>
<tr class="memdesc:af345442d6b49e71a2191c5e2dac3ca97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array containing border distance data. [Size: <a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd" title="The number of spans in the heightfield.">spanCount</a>]. <br /></td></tr>
<tr class="separator:af345442d6b49e71a2191c5e2dac3ca97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcdf0d737779779376bce23d1c0be910" id="r_abcdf0d737779779376bce23d1c0be910"><td class="memItemLeft" align="right" valign="top">unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrcCompactHeightfield.html#abcdf0d737779779376bce23d1c0be910">areas</a></td></tr>
<tr class="memdesc:abcdf0d737779779376bce23d1c0be910"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array containing area id data. [Size: <a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd" title="The number of spans in the heightfield.">spanCount</a>]. <br /></td></tr>
<tr class="separator:abcdf0d737779779376bce23d1c0be910"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>A compact, static heightfield representing unobstructed space. </p>
<dl class="section user"><dt></dt><dd></dd></dl>
<p>For this type of heightfield, the spans represent the open (unobstructed) space above the solid surfaces of a voxel field. It is usually created from a <a class="el" href="structrcHeightfield.html" title="A dynamic heightfield representing obstructed space.">rcHeightfield</a> object. Data is stored in a compact, efficient manner, <br />
but the structure is not condusive to adding and removing spans.</p>
<p>The standard process for buidling a compact heightfield is to allocate it using <a class="el" href="group__recast.html#ga766374592cc6b87d804539258e690c25" title="Allocates a compact heightfield object using the Recast allocator.">rcAllocCompactHeightfield</a>, build it using <a class="el" href="group__recast.html#ga3dc179b83cb925eb6602cd06123bf038" title="Builds a compact heightfield representing open space, from a heightfield representing solid space.">rcBuildCompactHeightfield</a>, then run it through the various helper functions to generate neighbor and region data.</p>
<p>Connected neighbor spans form non-overlapping surfaces. When neighbor information is generated, spans will include data that can be used to locate axis-neighbors. Axis-neighbors are connected spans that are offset from the current cell column as follows: </p><pre>
Direction 0 = (-1, 0)
Direction 1 = (0, 1)
Direction 2 = (1, 0)
Direction 3 = (0, -1)
</pre><p>Example of iterating and inspecting spans, including connected neighbors:</p>
<div class="fragment"><div class="line"><span class="comment">// Where chf is an instance of a rcCompactHeightfield.</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structrcCompactHeightfield.html#a75ee8e198d672db29a2f98c7463c0b31">cs</a> = chf.cs;</div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structrcCompactHeightfield.html#a39baf56bf3baf2b026aae0a309facaf4">ch</a> = chf.ch;</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">int</span> y = 0; y &lt; chf.height; ++y)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> x = 0; x &lt; chf.width; ++x)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// Deriving the minimum corner of the grid location.</span></div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">float</span> fx = chf.bmin[0] + x*<a class="code hl_variable" href="structrcCompactHeightfield.html#a75ee8e198d672db29a2f98c7463c0b31">cs</a>;</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">float</span> fz = chf.bmin[2] + y*<a class="code hl_variable" href="structrcCompactHeightfield.html#a75ee8e198d672db29a2f98c7463c0b31">cs</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Get the cell for the grid location then iterate</span></div>
<div class="line"> <span class="comment">// up the column.</span></div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="structrcCompactCell.html">rcCompactCell</a>&amp; c = chf.cells[x+y*chf.width];</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = c.<a class="code hl_variable" href="structrcCompactCell.html#ad1695135ae520dfee8c39aa7b1fd41d8">index</a>, ni = c.<a class="code hl_variable" href="structrcCompactCell.html#ad1695135ae520dfee8c39aa7b1fd41d8">index</a>+c.<a class="code hl_variable" href="structrcCompactCell.html#a70bb509654a28a8c9d67bcb469d0b3ce">count</a>; i &lt; ni; ++i)</div>
<div class="line"> {</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="structrcCompactSpan.html">rcCompactSpan</a>&amp; s = chf.spans[i];</div>
<div class="line"> </div>
<div class="line"> Deriving the minimum (floor) of the span.</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">float</span> fy = chf.bmin[1] + (s.<a class="code hl_variable" href="structrcCompactSpan.html#a51e8cdcf30408a3f84da22c4d2623b68">y</a>+1)*<a class="code hl_variable" href="structrcCompactHeightfield.html#a39baf56bf3baf2b026aae0a309facaf4">ch</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Testing the area assignment of the span.</span></div>
<div class="line"> <span class="keywordflow">if</span> (chf.areas[i] == <a class="code hl_variable" href="Recast_8h.html#a55c878bf81a2811829c8c5e491be41cb">RC_WALKABLE_AREA</a>)</div>
<div class="line"> { </div>
<div class="line"> <span class="comment">// The span is in the default &#39;walkable area&#39;.</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (chf.areas[i] == <a class="code hl_variable" href="Recast_8h.html#a5105dbfb2d2bf8aa69122db502d0e39e">RC_NULL_AREA</a>)</div>
<div class="line"> { </div>
<div class="line"> <span class="comment">// The surface is not considered walkable.</span></div>
<div class="line"> <span class="comment">// E.g. It was filtered out during the build processes.</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span></div>
<div class="line"> { </div>
<div class="line"> <span class="comment">// Do something. (Only applicable for custom build</span></div>
<div class="line"> <span class="comment">// build processes.)</span></div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Iterating the connected axis-neighbor spans.</span></div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> dir = 0; dir &lt; 4; ++dir)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="group__recast.html#gad3ccc7652b12db58c8e58c976bb34b1b">rcGetCon</a>(s, dir) != <a class="code hl_variable" href="Recast_8h.html#a64354aff947c2d8040e39bb4ceaf1a9f">RC_NOT_CONNECTED</a>)</div>
<div class="line"> {</div>
<div class="line"> <span class="comment">// There is a neighbor in this direction.</span></div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">int</span> nx = x + <a class="code hl_function" href="group__recast.html#ga7f308c34d7d5beb73eca24fe30033064">rcGetDirOffsetX</a>(dir);</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">int</span> ny = y + <a class="code hl_function" href="group__recast.html#ga7d225822d057252755aeeebdc2388cf2">rcGetDirOffsetY</a>(dir);</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">int</span> ni = (int)chf.cells[nx+ny*w].index + <a class="code hl_function" href="group__recast.html#gad3ccc7652b12db58c8e58c976bb34b1b">rcGetCon</a>(s, 0);</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="structrcCompactSpan.html">rcCompactSpan</a>&amp; ns = chf.spans[ni];</div>
<div class="line"> <span class="comment">// Do something with the neighbor span.</span></div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="ttc" id="aRecast_8h_html_a5105dbfb2d2bf8aa69122db502d0e39e"><div class="ttname"><a href="Recast_8h.html#a5105dbfb2d2bf8aa69122db502d0e39e">RC_NULL_AREA</a></div><div class="ttdeci">static const unsigned char RC_NULL_AREA</div><div class="ttdoc">Represents the null area.</div><div class="ttdef"><b>Definition</b> Recast.h:635</div></div>
<div class="ttc" id="aRecast_8h_html_a55c878bf81a2811829c8c5e491be41cb"><div class="ttname"><a href="Recast_8h.html#a55c878bf81a2811829c8c5e491be41cb">RC_WALKABLE_AREA</a></div><div class="ttdeci">static const unsigned char RC_WALKABLE_AREA</div><div class="ttdoc">The default area id used to indicate a walkable polygon.</div><div class="ttdef"><b>Definition</b> Recast.h:640</div></div>
<div class="ttc" id="aRecast_8h_html_a64354aff947c2d8040e39bb4ceaf1a9f"><div class="ttname"><a href="Recast_8h.html#a64354aff947c2d8040e39bb4ceaf1a9f">RC_NOT_CONNECTED</a></div><div class="ttdeci">static const int RC_NOT_CONNECTED</div><div class="ttdoc">The value returned by rcGetCon if the specified direction is not connected to another span.</div><div class="ttdef"><b>Definition</b> Recast.h:644</div></div>
<div class="ttc" id="agroup__recast_html_ga7d225822d057252755aeeebdc2388cf2"><div class="ttname"><a href="group__recast.html#ga7d225822d057252755aeeebdc2388cf2">rcGetDirOffsetY</a></div><div class="ttdeci">int rcGetDirOffsetY(int direction)</div><div class="ttdoc">Gets the standard height (z-axis) offset for the specified direction.</div><div class="ttdef"><b>Definition</b> Recast.h:1263</div></div>
<div class="ttc" id="agroup__recast_html_ga7f308c34d7d5beb73eca24fe30033064"><div class="ttname"><a href="group__recast.html#ga7f308c34d7d5beb73eca24fe30033064">rcGetDirOffsetX</a></div><div class="ttdeci">int rcGetDirOffsetX(int direction)</div><div class="ttdoc">Gets the standard width (x-axis) offset for the specified direction.</div><div class="ttdef"><b>Definition</b> Recast.h:1253</div></div>
<div class="ttc" id="agroup__recast_html_gad3ccc7652b12db58c8e58c976bb34b1b"><div class="ttname"><a href="group__recast.html#gad3ccc7652b12db58c8e58c976bb34b1b">rcGetCon</a></div><div class="ttdeci">int rcGetCon(const rcCompactSpan &amp;span, int direction)</div><div class="ttdoc">Gets neighbor connection data for the specified direction.</div><div class="ttdef"><b>Definition</b> Recast.h:1244</div></div>
<div class="ttc" id="astructrcCompactCell_html"><div class="ttname"><a href="structrcCompactCell.html">rcCompactCell</a></div><div class="ttdoc">Provides information on the content of a cell column in a compact heightfield.</div><div class="ttdef"><b>Definition</b> Recast.h:337</div></div>
<div class="ttc" id="astructrcCompactCell_html_a70bb509654a28a8c9d67bcb469d0b3ce"><div class="ttname"><a href="structrcCompactCell.html#a70bb509654a28a8c9d67bcb469d0b3ce">rcCompactCell::count</a></div><div class="ttdeci">unsigned int count</div><div class="ttdoc">Number of spans in the column.</div><div class="ttdef"><b>Definition</b> Recast.h:339</div></div>
<div class="ttc" id="astructrcCompactCell_html_ad1695135ae520dfee8c39aa7b1fd41d8"><div class="ttname"><a href="structrcCompactCell.html#ad1695135ae520dfee8c39aa7b1fd41d8">rcCompactCell::index</a></div><div class="ttdeci">unsigned int index</div><div class="ttdoc">Index to the first span in the column.</div><div class="ttdef"><b>Definition</b> Recast.h:338</div></div>
<div class="ttc" id="astructrcCompactHeightfield_html_a39baf56bf3baf2b026aae0a309facaf4"><div class="ttname"><a href="structrcCompactHeightfield.html#a39baf56bf3baf2b026aae0a309facaf4">rcCompactHeightfield::ch</a></div><div class="ttdeci">float ch</div><div class="ttdoc">The height of each cell. (The minimum increment along the y-axis.)</div><div class="ttdef"><b>Definition</b> Recast.h:369</div></div>
<div class="ttc" id="astructrcCompactHeightfield_html_a75ee8e198d672db29a2f98c7463c0b31"><div class="ttname"><a href="structrcCompactHeightfield.html#a75ee8e198d672db29a2f98c7463c0b31">rcCompactHeightfield::cs</a></div><div class="ttdeci">float cs</div><div class="ttdoc">The size of each cell. (On the xz-plane.)</div><div class="ttdef"><b>Definition</b> Recast.h:368</div></div>
<div class="ttc" id="astructrcCompactSpan_html"><div class="ttname"><a href="structrcCompactSpan.html">rcCompactSpan</a></div><div class="ttdoc">Represents a span of unobstructed space within a compact heightfield.</div><div class="ttdef"><b>Definition</b> Recast.h:344</div></div>
<div class="ttc" id="astructrcCompactSpan_html_a51e8cdcf30408a3f84da22c4d2623b68"><div class="ttname"><a href="structrcCompactSpan.html#a51e8cdcf30408a3f84da22c4d2623b68">rcCompactSpan::y</a></div><div class="ttdeci">unsigned short y</div><div class="ttdoc">The lower extent of the span. (Measured from the heightfield's base.)</div><div class="ttdef"><b>Definition</b> Recast.h:345</div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__recast.html#ga766374592cc6b87d804539258e690c25" title="Allocates a compact heightfield object using the Recast allocator.">rcAllocCompactHeightfield</a>, <a class="el" href="group__recast.html#ga914ed7cee333a9c29513d917f6bb4716" title="Frees the specified compact heightfield object using the Recast allocator.">rcFreeCompactHeightfield</a>, <a class="el" href="group__recast.html#ga3dc179b83cb925eb6602cd06123bf038" title="Builds a compact heightfield representing open space, from a heightfield representing solid space.">rcBuildCompactHeightfield</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a33d0846cef5f90e605f272b61277ffb0" name="a33d0846cef5f90e605f272b61277ffb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33d0846cef5f90e605f272b61277ffb0">&#9670;&#160;</a></span>rcCompactHeightfield()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rcCompactHeightfield::rcCompactHeightfield </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aea6121b36d3fb1cab5955a7915c68809" name="aea6121b36d3fb1cab5955a7915c68809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea6121b36d3fb1cab5955a7915c68809">&#9670;&#160;</a></span>~rcCompactHeightfield()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">rcCompactHeightfield::~rcCompactHeightfield </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="abcdf0d737779779376bce23d1c0be910" name="abcdf0d737779779376bce23d1c0be910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcdf0d737779779376bce23d1c0be910">&#9670;&#160;</a></span>areas</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* rcCompactHeightfield::areas</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array containing area id data. [Size: <a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd" title="The number of spans in the heightfield.">spanCount</a>]. </p>
</div>
</div>
<a id="a5d175954135840be9d4e4fc3b36d8067" name="a5d175954135840be9d4e4fc3b36d8067"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d175954135840be9d4e4fc3b36d8067">&#9670;&#160;</a></span>bmax</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcCompactHeightfield::bmax[3]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum bounds in world space. [(x, y, z)]. </p>
</div>
</div>
<a id="ae73d55ffeafd659c189bf14e440b902f" name="ae73d55ffeafd659c189bf14e440b902f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae73d55ffeafd659c189bf14e440b902f">&#9670;&#160;</a></span>bmin</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcCompactHeightfield::bmin[3]</td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum bounds in world space. [(x, y, z)]. </p>
</div>
</div>
<a id="a675418d81ce6ade83fbd18be2dfd1647" name="a675418d81ce6ade83fbd18be2dfd1647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a675418d81ce6ade83fbd18be2dfd1647">&#9670;&#160;</a></span>borderSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcCompactHeightfield::borderSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>The AABB border size used during the build of the field. (See: <a class="el" href="structrcConfig.html#a473ec0f080862d2593099d8ee207da57" title="The size of the non-navigable border around the heightfield. [Limit: &gt;=0] [Units: vx].">rcConfig::borderSize</a>) </p>
</div>
</div>
<a id="ab497c9a9f6e0f1b8882fada13ce880a5" name="ab497c9a9f6e0f1b8882fada13ce880a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab497c9a9f6e0f1b8882fada13ce880a5">&#9670;&#160;</a></span>cells</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structrcCompactCell.html">rcCompactCell</a>* rcCompactHeightfield::cells</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array of cells. [Size: <a class="el" href="structrcCompactHeightfield.html#a98868c1df2523cd724696ed1d223ba13" title="The width of the heightfield. (Along the x-axis in cell units.)">width</a>*<a class="el" href="structrcCompactHeightfield.html#a25d9e16e5d82cf698e47b18a5740b639" title="The height of the heightfield. (Along the z-axis in cell units.)">height</a>]. </p>
</div>
</div>
<a id="a39baf56bf3baf2b026aae0a309facaf4" name="a39baf56bf3baf2b026aae0a309facaf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39baf56bf3baf2b026aae0a309facaf4">&#9670;&#160;</a></span>ch</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcCompactHeightfield::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="a75ee8e198d672db29a2f98c7463c0b31" name="a75ee8e198d672db29a2f98c7463c0b31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75ee8e198d672db29a2f98c7463c0b31">&#9670;&#160;</a></span>cs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float rcCompactHeightfield::cs</td>
</tr>
</table>
</div><div class="memdoc">
<p>The size of each cell. (On the xz-plane.) </p>
</div>
</div>
<a id="af345442d6b49e71a2191c5e2dac3ca97" name="af345442d6b49e71a2191c5e2dac3ca97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af345442d6b49e71a2191c5e2dac3ca97">&#9670;&#160;</a></span>dist</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short* rcCompactHeightfield::dist</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array containing border distance data. [Size: <a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd" title="The number of spans in the heightfield.">spanCount</a>]. </p>
</div>
</div>
<a id="a25d9e16e5d82cf698e47b18a5740b639" name="a25d9e16e5d82cf698e47b18a5740b639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25d9e16e5d82cf698e47b18a5740b639">&#9670;&#160;</a></span>height</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcCompactHeightfield::height</td>
</tr>
</table>
</div><div class="memdoc">
<p>The height of the heightfield. (Along the z-axis in cell units.) </p>
</div>
</div>
<a id="a38921b347d72bdc07487d07e7608ffc7" name="a38921b347d72bdc07487d07e7608ffc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38921b347d72bdc07487d07e7608ffc7">&#9670;&#160;</a></span>maxDistance</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short rcCompactHeightfield::maxDistance</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum distance value of any span within the field. </p>
</div>
</div>
<a id="a6bfb7a2fdb06a64b03f0fffa885edd94" name="a6bfb7a2fdb06a64b03f0fffa885edd94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bfb7a2fdb06a64b03f0fffa885edd94">&#9670;&#160;</a></span>maxRegions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short rcCompactHeightfield::maxRegions</td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum region id of any span within the field. </p>
</div>
</div>
<a id="a7206a15efe8a9e2a8e28b8c7d89b45bd" name="a7206a15efe8a9e2a8e28b8c7d89b45bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7206a15efe8a9e2a8e28b8c7d89b45bd">&#9670;&#160;</a></span>spanCount</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcCompactHeightfield::spanCount</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of spans in the heightfield. </p>
</div>
</div>
<a id="a20f5a93095dfd199b0a9baad4127bec3" name="a20f5a93095dfd199b0a9baad4127bec3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20f5a93095dfd199b0a9baad4127bec3">&#9670;&#160;</a></span>spans</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structrcCompactSpan.html">rcCompactSpan</a>* rcCompactHeightfield::spans</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array of spans. [Size: <a class="el" href="structrcCompactHeightfield.html#a7206a15efe8a9e2a8e28b8c7d89b45bd" title="The number of spans in the heightfield.">spanCount</a>]. </p>
</div>
</div>
<a id="ae403555331ef3d2624ca9433226bd683" name="ae403555331ef3d2624ca9433226bd683"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae403555331ef3d2624ca9433226bd683">&#9670;&#160;</a></span>walkableClimb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcCompactHeightfield::walkableClimb</td>
</tr>
</table>
</div><div class="memdoc">
<p>The walkable climb used during the build of the field. (See: <a class="el" href="structrcConfig.html#a9b6bbabb4857e3f4bf4428af86ee7673" title="Maximum ledge height that is considered to still be traversable. [Limit: &gt;=0] [Units: vx].">rcConfig::walkableClimb</a>) </p>
</div>
</div>
<a id="a04baed5c41b0e19e525e3136b138dc1a" name="a04baed5c41b0e19e525e3136b138dc1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04baed5c41b0e19e525e3136b138dc1a">&#9670;&#160;</a></span>walkableHeight</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcCompactHeightfield::walkableHeight</td>
</tr>
</table>
</div><div class="memdoc">
<p>The walkable height used during the build of the field. (See: <a class="el" href="structrcConfig.html#a2483649686584b9d696ac00b968dedaa" title="Minimum floor to &#39;ceiling&#39; height that will still allow the floor area to be considered walkable.">rcConfig::walkableHeight</a>) </p>
</div>
</div>
<a id="a98868c1df2523cd724696ed1d223ba13" name="a98868c1df2523cd724696ed1d223ba13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98868c1df2523cd724696ed1d223ba13">&#9670;&#160;</a></span>width</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int rcCompactHeightfield::width</td>
</tr>
</table>
</div><div class="memdoc">
<p>The width of the heightfield. (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="structrcCompactHeightfield.html">rcCompactHeightfield</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