mirror of
https://github.com/recastnavigation/recastnavigation.git
synced 2026-06-10 17:23:48 +00:00
312 lines
17 KiB
HTML
312 lines
17 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: RecastArea.cpp File 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('RecastArea_8cpp.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="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">RecastArea.cpp File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="Recast_8h_source.html">Recast.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="RecastAlloc_8h_source.html">RecastAlloc.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="RecastAssert_8h_source.html">RecastAssert.h</a>"</code><br />
|
|
<code>#include <string.h></code><br />
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a544f2c39b38253edc9d12e2f6567ae11" id="r_a544f2c39b38253edc9d12e2f6567ae11"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="RecastArea_8cpp.html#a544f2c39b38253edc9d12e2f6567ae11">insertSort</a> (unsigned char *data, const int dataLength)</td></tr>
|
|
<tr class="memdesc:a544f2c39b38253edc9d12e2f6567ae11"><td class="mdescLeft"> </td><td class="mdescRight">Sorts the given data in-place using insertion sort. <br /></td></tr>
|
|
<tr class="separator:a544f2c39b38253edc9d12e2f6567ae11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1499638887cce3274469f05084c60f5d" id="r_a1499638887cce3274469f05084c60f5d"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="RecastArea_8cpp.html#a1499638887cce3274469f05084c60f5d">pointInPoly</a> (int numVerts, const float *verts, const float *point)</td></tr>
|
|
<tr class="memdesc:a1499638887cce3274469f05084c60f5d"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a point is contained within a polygon. <br /></td></tr>
|
|
<tr class="separator:a1499638887cce3274469f05084c60f5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf2bf6010fc80e9b6e8f4c0c1fef7a97f" id="r_gaf2bf6010fc80e9b6e8f4c0c1fef7a97f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__recast.html#gaf2bf6010fc80e9b6e8f4c0c1fef7a97f">rcErodeWalkableArea</a> (<a class="el" href="classrcContext.html">rcContext</a> *context, const int erosionRadius, <a class="el" href="structrcCompactHeightfield.html">rcCompactHeightfield</a> &compactHeightfield)</td></tr>
|
|
<tr class="memdesc:gaf2bf6010fc80e9b6e8f4c0c1fef7a97f"><td class="mdescLeft"> </td><td class="mdescRight">Erodes the walkable area within the heightfield by the specified radius. <br /></td></tr>
|
|
<tr class="separator:gaf2bf6010fc80e9b6e8f4c0c1fef7a97f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga80e89976e7d6388f1a78ad622ef57bdf" id="r_ga80e89976e7d6388f1a78ad622ef57bdf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__recast.html#ga80e89976e7d6388f1a78ad622ef57bdf">rcMedianFilterWalkableArea</a> (<a class="el" href="classrcContext.html">rcContext</a> *context, <a class="el" href="structrcCompactHeightfield.html">rcCompactHeightfield</a> &compactHeightfield)</td></tr>
|
|
<tr class="memdesc:ga80e89976e7d6388f1a78ad622ef57bdf"><td class="mdescLeft"> </td><td class="mdescRight">Applies a median filter to walkable area types (based on area id), removing noise. <br /></td></tr>
|
|
<tr class="separator:ga80e89976e7d6388f1a78ad622ef57bdf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab76182beff7fc231b489c414b26e8638" id="r_gab76182beff7fc231b489c414b26e8638"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__recast.html#gab76182beff7fc231b489c414b26e8638">rcMarkBoxArea</a> (<a class="el" href="classrcContext.html">rcContext</a> *context, const float *boxMinBounds, const float *boxMaxBounds, unsigned char areaId, <a class="el" href="structrcCompactHeightfield.html">rcCompactHeightfield</a> &compactHeightfield)</td></tr>
|
|
<tr class="memdesc:gab76182beff7fc231b489c414b26e8638"><td class="mdescLeft"> </td><td class="mdescRight">Applies an area id to all spans within the specified bounding box. <br /></td></tr>
|
|
<tr class="separator:gab76182beff7fc231b489c414b26e8638"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0dee8037963c1452a25b3835f3e8d902" id="r_ga0dee8037963c1452a25b3835f3e8d902"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__recast.html#ga0dee8037963c1452a25b3835f3e8d902">rcMarkConvexPolyArea</a> (<a class="el" href="classrcContext.html">rcContext</a> *context, const float *verts, const int numVerts, const float minY, const float maxY, unsigned char areaId, <a class="el" href="structrcCompactHeightfield.html">rcCompactHeightfield</a> &compactHeightfield)</td></tr>
|
|
<tr class="memdesc:ga0dee8037963c1452a25b3835f3e8d902"><td class="mdescLeft"> </td><td class="mdescRight">Applies the area id to the all spans within the specified convex polygon. <br /></td></tr>
|
|
<tr class="separator:ga0dee8037963c1452a25b3835f3e8d902"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4b52279afe6cd37e7e3213e62fb1bab" id="r_ac4b52279afe6cd37e7e3213e62fb1bab"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="RecastArea_8cpp.html#ac4b52279afe6cd37e7e3213e62fb1bab">rcVsafeNormalize</a> (float *v)</td></tr>
|
|
<tr class="memdesc:ac4b52279afe6cd37e7e3213e62fb1bab"><td class="mdescLeft"> </td><td class="mdescRight">Normalizes the vector if the length is greater than zero. <br /></td></tr>
|
|
<tr class="separator:ac4b52279afe6cd37e7e3213e62fb1bab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafbf610dce5157badc30bd847684a3f9c" id="r_gafbf610dce5157badc30bd847684a3f9c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__recast.html#gafbf610dce5157badc30bd847684a3f9c">rcOffsetPoly</a> (const float *verts, const int numVerts, const float offset, float *outVerts, const int maxOutVerts)</td></tr>
|
|
<tr class="memdesc:gafbf610dce5157badc30bd847684a3f9c"><td class="mdescLeft"> </td><td class="mdescRight">Expands a convex polygon along its vertex normals by the given offset amount. <br /></td></tr>
|
|
<tr class="separator:gafbf610dce5157badc30bd847684a3f9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2c4bba9a06ae30ac063fba1a69a68cd9" id="r_ga2c4bba9a06ae30ac063fba1a69a68cd9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__recast.html#ga2c4bba9a06ae30ac063fba1a69a68cd9">rcMarkCylinderArea</a> (<a class="el" href="classrcContext.html">rcContext</a> *context, const float *position, const float radius, const float height, unsigned char areaId, <a class="el" href="structrcCompactHeightfield.html">rcCompactHeightfield</a> &compactHeightfield)</td></tr>
|
|
<tr class="memdesc:ga2c4bba9a06ae30ac063fba1a69a68cd9"><td class="mdescLeft"> </td><td class="mdescRight">Applies the area id to all spans within the specified y-axis-aligned cylinder. <br /></td></tr>
|
|
<tr class="separator:ga2c4bba9a06ae30ac063fba1a69a68cd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:ab84b0a39a5bcd3e4bd1a2d19b015bde9" id="r_ab84b0a39a5bcd3e4bd1a2d19b015bde9"><td class="memItemLeft" align="right" valign="top">static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="RecastArea_8cpp.html#ab84b0a39a5bcd3e4bd1a2d19b015bde9">EPSILON</a> = 1e-6f</td></tr>
|
|
<tr class="separator:ab84b0a39a5bcd3e4bd1a2d19b015bde9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a544f2c39b38253edc9d12e2f6567ae11" name="a544f2c39b38253edc9d12e2f6567ae11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a544f2c39b38253edc9d12e2f6567ae11">◆ </a></span>insertSort()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void insertSort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned char * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>dataLength</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sorts the given data in-place using insertion sort. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>The data to sort </td></tr>
|
|
<tr><td class="paramname">dataLength</td><td>The number of elements in <code>data</code> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1499638887cce3274469f05084c60f5d" name="a1499638887cce3274469f05084c60f5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1499638887cce3274469f05084c60f5d">◆ </a></span>pointInPoly()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static bool pointInPoly </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>numVerts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const float * </td>
|
|
<td class="paramname"><em>verts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const float * </td>
|
|
<td class="paramname"><em>point</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if a point is contained within a polygon. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">numVerts</td><td>Number of vertices in the polygon </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">verts</td><td>The polygon vertices </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">point</td><td>The point to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the point lies within the polygon, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac4b52279afe6cd37e7e3213e62fb1bab" name="ac4b52279afe6cd37e7e3213e62fb1bab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4b52279afe6cd37e7e3213e62fb1bab">◆ </a></span>rcVsafeNormalize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void rcVsafeNormalize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>v</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Normalizes the vector if the length is greater than zero. </p>
|
|
<p>If the magnitude is zero, the vector is unchanged. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">v</td><td>The vector to normalize. [(x, y, z)] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="ab84b0a39a5bcd3e4bd1a2d19b015bde9" name="ab84b0a39a5bcd3e4bd1a2d19b015bde9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab84b0a39a5bcd3e4bd1a2d19b015bde9">◆ </a></span>EPSILON</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const float EPSILON = 1e-6f</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</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="dir_e6cf54c9d4d29ff4a28752d861cf44fa.html">Recast</a></li><li class="navelem"><a class="el" href="dir_fe7f4084ac0458032f1df717ceae8313.html">Source</a></li><li class="navelem"><a class="el" href="RecastArea_8cpp.html">RecastArea.cpp</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>
|