Files
recastnavigation/Sample_8h.html

268 lines
18 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Recast Navigation: Sample.h 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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<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.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('Sample_8h.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Sample.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="Recast_8h_source.html">Recast.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="SampleInterfaces_8h_source.html">SampleInterfaces.h</a>&quot;</code><br />
</div>
<p><a href="Sample_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSampleDebugDraw.html">SampleDebugDraw</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSampleTool.html">SampleTool</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSampleToolState.html">SampleToolState</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSample.html">Sample</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ae448bf9be534170ca5b5f8c97256125b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125b">SampleToolType</a> { <br />
&#160;&#160;<a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125baea1b4490f1a21f7bd637324c9a46474e">TOOL_NONE</a> = 0
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba3cf3ab9c4ec7c40ff509f7eaab437d1b">TOOL_TILE_EDIT</a>
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba9657bb5c075ec7d34b297a657ce25d74">TOOL_TILE_HIGHLIGHT</a>
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba5b84b6b324182b6d84255bf90ba84468">TOOL_TEMP_OBSTACLE</a>
, <br />
&#160;&#160;<a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba0b913f987aa3e318b76065cfa4985815">TOOL_NAVMESH_TESTER</a>
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba23046ac29087338ff7e8b24cc1778fef">TOOL_NAVMESH_PRUNE</a>
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba0c30e9d3ebdeca5bddecc218dc342b98">TOOL_OFFMESH_CONNECTION</a>
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba0a31d2fb717946c688d04888a81c2063">TOOL_CONVEX_VOLUME</a>
, <br />
&#160;&#160;<a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125ba2c02ab36128a429e63f30ac3beea2a12">TOOL_CROWD</a>
, <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125baf21d3b3c7a6296454122cffd465fcb25">MAX_TOOLS</a>
<br />
}</td></tr>
<tr class="memdesc:ae448bf9be534170ca5b5f8c97256125b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tool types. <a href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125b">More...</a><br /></td></tr>
<tr class="separator:ae448bf9be534170ca5b5f8c97256125b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a588cb37d59e832fa4f2606474769b6da"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6da">SamplePolyAreas</a> { <br />
&#160;&#160;<a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6daade496ba823714eb3b6d31fa9c1297388">SAMPLE_POLYAREA_GROUND</a>
, <a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6daa08ea8d5a36716a7e74a6c73a25bcadbe">SAMPLE_POLYAREA_WATER</a>
, <a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6daacb78d7e68ad58b5bc62c2313cf3b0e38">SAMPLE_POLYAREA_ROAD</a>
, <a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6daa8dde3ccaff5b35fee2ce73d5744cae9e">SAMPLE_POLYAREA_DOOR</a>
, <br />
&#160;&#160;<a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6daaa740ac4d510c2a3abe962fbfb793f1dc">SAMPLE_POLYAREA_GRASS</a>
, <a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6daac03a57a3286b6b9f4a5dcc403e269b2e">SAMPLE_POLYAREA_JUMP</a>
<br />
}</td></tr>
<tr class="memdesc:a588cb37d59e832fa4f2606474769b6da"><td class="mdescLeft">&#160;</td><td class="mdescRight">These are just sample areas to use consistent values across the samples. <a href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6da">More...</a><br /></td></tr>
<tr class="separator:a588cb37d59e832fa4f2606474769b6da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f96856c3ec53bcd8dab2396ae743f8d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8d">SamplePolyFlags</a> { <br />
&#160;&#160;<a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8da56be2036bea60e03345da8f4897a4682">SAMPLE_POLYFLAGS_WALK</a> = 0x01
, <a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8da01b0f8a3c0e3f5e7c4c9fa79c13981ea">SAMPLE_POLYFLAGS_SWIM</a> = 0x02
, <a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8da7d04a970d5e5fa624733a4be27470f3c">SAMPLE_POLYFLAGS_DOOR</a> = 0x04
, <a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8da15efc6d182fbdd962d5b28f77d3c9e8f">SAMPLE_POLYFLAGS_JUMP</a> = 0x08
, <br />
&#160;&#160;<a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8da2646db68ba40d4004ffb88a37717c4d1">SAMPLE_POLYFLAGS_DISABLED</a> = 0x10
, <a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8daa00f1707b9fb5af90130ee64d133e68f">SAMPLE_POLYFLAGS_ALL</a> = 0xffff
<br />
}</td></tr>
<tr class="separator:a7f96856c3ec53bcd8dab2396ae743f8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73f95e7eb01a7e948ecfa34b9cebcdc1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Sample_8h.html#a73f95e7eb01a7e948ecfa34b9cebcdc1">SamplePartitionType</a> { <a class="el" href="Sample_8h.html#a73f95e7eb01a7e948ecfa34b9cebcdc1a4fe0d0ba0791fe2280ff3821177766a9">SAMPLE_PARTITION_WATERSHED</a>
, <a class="el" href="Sample_8h.html#a73f95e7eb01a7e948ecfa34b9cebcdc1aa44dc0eb2004b683d4297b7d46cfe979">SAMPLE_PARTITION_MONOTONE</a>
, <a class="el" href="Sample_8h.html#a73f95e7eb01a7e948ecfa34b9cebcdc1a1fae7df00c1a8f165833e48c67692627">SAMPLE_PARTITION_LAYERS</a>
}</td></tr>
<tr class="separator:a73f95e7eb01a7e948ecfa34b9cebcdc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a73f95e7eb01a7e948ecfa34b9cebcdc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73f95e7eb01a7e948ecfa34b9cebcdc1">&#9670;&nbsp;</a></span>SamplePartitionType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="Sample_8h.html#a73f95e7eb01a7e948ecfa34b9cebcdc1">SamplePartitionType</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a73f95e7eb01a7e948ecfa34b9cebcdc1a4fe0d0ba0791fe2280ff3821177766a9"></a>SAMPLE_PARTITION_WATERSHED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a73f95e7eb01a7e948ecfa34b9cebcdc1aa44dc0eb2004b683d4297b7d46cfe979"></a>SAMPLE_PARTITION_MONOTONE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a73f95e7eb01a7e948ecfa34b9cebcdc1a1fae7df00c1a8f165833e48c67692627"></a>SAMPLE_PARTITION_LAYERS&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a588cb37d59e832fa4f2606474769b6da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a588cb37d59e832fa4f2606474769b6da">&#9670;&nbsp;</a></span>SamplePolyAreas</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="Sample_8h.html#a588cb37d59e832fa4f2606474769b6da">SamplePolyAreas</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>These are just sample areas to use consistent values across the samples. </p>
<p>The use should specify these base on his needs. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a588cb37d59e832fa4f2606474769b6daade496ba823714eb3b6d31fa9c1297388"></a>SAMPLE_POLYAREA_GROUND&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a588cb37d59e832fa4f2606474769b6daa08ea8d5a36716a7e74a6c73a25bcadbe"></a>SAMPLE_POLYAREA_WATER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a588cb37d59e832fa4f2606474769b6daacb78d7e68ad58b5bc62c2313cf3b0e38"></a>SAMPLE_POLYAREA_ROAD&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a588cb37d59e832fa4f2606474769b6daa8dde3ccaff5b35fee2ce73d5744cae9e"></a>SAMPLE_POLYAREA_DOOR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a588cb37d59e832fa4f2606474769b6daaa740ac4d510c2a3abe962fbfb793f1dc"></a>SAMPLE_POLYAREA_GRASS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a588cb37d59e832fa4f2606474769b6daac03a57a3286b6b9f4a5dcc403e269b2e"></a>SAMPLE_POLYAREA_JUMP&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a7f96856c3ec53bcd8dab2396ae743f8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f96856c3ec53bcd8dab2396ae743f8d">&#9670;&nbsp;</a></span>SamplePolyFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="Sample_8h.html#a7f96856c3ec53bcd8dab2396ae743f8d">SamplePolyFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7f96856c3ec53bcd8dab2396ae743f8da56be2036bea60e03345da8f4897a4682"></a>SAMPLE_POLYFLAGS_WALK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a7f96856c3ec53bcd8dab2396ae743f8da01b0f8a3c0e3f5e7c4c9fa79c13981ea"></a>SAMPLE_POLYFLAGS_SWIM&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a7f96856c3ec53bcd8dab2396ae743f8da7d04a970d5e5fa624733a4be27470f3c"></a>SAMPLE_POLYFLAGS_DOOR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a7f96856c3ec53bcd8dab2396ae743f8da15efc6d182fbdd962d5b28f77d3c9e8f"></a>SAMPLE_POLYFLAGS_JUMP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a7f96856c3ec53bcd8dab2396ae743f8da2646db68ba40d4004ffb88a37717c4d1"></a>SAMPLE_POLYFLAGS_DISABLED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a7f96856c3ec53bcd8dab2396ae743f8daa00f1707b9fb5af90130ee64d133e68f"></a>SAMPLE_POLYFLAGS_ALL&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="ae448bf9be534170ca5b5f8c97256125b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae448bf9be534170ca5b5f8c97256125b">&#9670;&nbsp;</a></span>SampleToolType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="Sample_8h.html#ae448bf9be534170ca5b5f8c97256125b">SampleToolType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tool types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125baea1b4490f1a21f7bd637324c9a46474e"></a>TOOL_NONE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba3cf3ab9c4ec7c40ff509f7eaab437d1b"></a>TOOL_TILE_EDIT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba9657bb5c075ec7d34b297a657ce25d74"></a>TOOL_TILE_HIGHLIGHT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba5b84b6b324182b6d84255bf90ba84468"></a>TOOL_TEMP_OBSTACLE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba0b913f987aa3e318b76065cfa4985815"></a>TOOL_NAVMESH_TESTER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba23046ac29087338ff7e8b24cc1778fef"></a>TOOL_NAVMESH_PRUNE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba0c30e9d3ebdeca5bddecc218dc342b98"></a>TOOL_OFFMESH_CONNECTION&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba0a31d2fb717946c688d04888a81c2063"></a>TOOL_CONVEX_VOLUME&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125ba2c02ab36128a429e63f30ac3beea2a12"></a>TOOL_CROWD&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae448bf9be534170ca5b5f8c97256125baf21d3b3c7a6296454122cffd465fcb25"></a>MAX_TOOLS&#160;</td><td class="fielddoc"></td></tr>
</table>
</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_bd8164545b6b3da3c53f0f7457fcb102.html">RecastDemo</a></li><li class="navelem"><a class="el" href="dir_f244c4afb4303a82689423998a79af95.html">Include</a></li><li class="navelem"><a class="el" href="Sample_8h.html">Sample.h</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>