Files
recastnavigation/RecastDump_8h_source.html

165 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: RecastDump.h Source File</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="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('RecastDump_8h_source.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="headertitle">
<div class="title">RecastDump.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="RecastDump_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright (c) 2009-2010 Mikko Mononen memon@inside.org</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// This software is provided &#39;as-is&#39;, without any express or implied</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// arising from the use of this software.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// freely, subject to the following restrictions:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// appreciated but is not required.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// misrepresented as being the original software.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef RECAST_DUMP_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define RECAST_DUMP_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structduFileIO.html"> 22</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structduFileIO.html">duFileIO</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">virtual</span> <a class="code" href="structduFileIO.html#afab2836e1a3b9909bebe00e9ab81aae8">~duFileIO</a>();</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structduFileIO.html#ab436e18b116c61875dbdf5faafda9694"> 25</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structduFileIO.html#ab436e18b116c61875dbdf5faafda9694">isWriting</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structduFileIO.html#a853e4af9415fdaa073bb785151f6b28c"> 26</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structduFileIO.html#a853e4af9415fdaa073bb785151f6b28c">isReading</a>() <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structduFileIO.html#aec33f1c0d1d0d1ec464fc1a5c135cb00"> 27</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structduFileIO.html#aec33f1c0d1d0d1ec464fc1a5c135cb00">write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size) = 0;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structduFileIO.html#af9c0d46a4697c00c657fa75636d0cf67"> 28</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structduFileIO.html#af9c0d46a4697c00c657fa75636d0cf67">read</a>(<span class="keywordtype">void</span>* ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size) = 0;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;};</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="RecastDump_8h.html#a0a79a720e9e9bbcc7c299260c7e6d327">duDumpPolyMeshToObj</a>(<span class="keyword">struct</span> <a class="code" href="structrcPolyMesh.html">rcPolyMesh</a>&amp; pmesh, <a class="code" href="structduFileIO.html">duFileIO</a>* io);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="RecastDump_8h.html#a129a91fa790aafc645396c31759dfd80">duDumpPolyMeshDetailToObj</a>(<span class="keyword">struct</span> <a class="code" href="structrcPolyMeshDetail.html">rcPolyMeshDetail</a>&amp; dmesh, <a class="code" href="structduFileIO.html">duFileIO</a>* io);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="RecastDump_8h.html#a6ae5d539309d07370f7ec5eb53e94743">duDumpContourSet</a>(<span class="keyword">struct</span> <a class="code" href="structrcContourSet.html">rcContourSet</a>&amp; cset, <a class="code" href="structduFileIO.html">duFileIO</a>* io);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="RecastDump_8h.html#a9e1f8ba842160742ce414e710c6472fb">duReadContourSet</a>(<span class="keyword">struct</span> <a class="code" href="structrcContourSet.html">rcContourSet</a>&amp; cset, <a class="code" href="structduFileIO.html">duFileIO</a>* io);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="RecastDump_8h.html#adec19cdb843932197e6538ea2e234cc1">duDumpCompactHeightfield</a>(<span class="keyword">struct</span> <a class="code" href="structrcCompactHeightfield.html">rcCompactHeightfield</a>&amp; chf, <a class="code" href="structduFileIO.html">duFileIO</a>* io);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="RecastDump_8h.html#aa11f7a7470e8e8aeea6f155e39edccf8">duReadCompactHeightfield</a>(<span class="keyword">struct</span> <a class="code" href="structrcCompactHeightfield.html">rcCompactHeightfield</a>&amp; chf, <a class="code" href="structduFileIO.html">duFileIO</a>* io);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keywordtype">void</span> <a class="code" href="RecastDump_8h.html#a32dd617dc1eeb615d779834c760131a5">duLogBuildTimes</a>(<a class="code" href="classrcContext.html">rcContext</a>&amp; ctx, <span class="keyword">const</span> <span class="keywordtype">int</span> totalTileUsec);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// RECAST_DUMP_H</span></div>
<div class="ttc" id="aRecastDump_8h_html_a0a79a720e9e9bbcc7c299260c7e6d327"><div class="ttname"><a href="RecastDump_8h.html#a0a79a720e9e9bbcc7c299260c7e6d327">duDumpPolyMeshToObj</a></div><div class="ttdeci">bool duDumpPolyMeshToObj(struct rcPolyMesh &amp;pmesh, duFileIO *io)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:43</div></div>
<div class="ttc" id="aRecastDump_8h_html_a129a91fa790aafc645396c31759dfd80"><div class="ttname"><a href="RecastDump_8h.html#a129a91fa790aafc645396c31759dfd80">duDumpPolyMeshDetailToObj</a></div><div class="ttdeci">bool duDumpPolyMeshDetailToObj(struct rcPolyMeshDetail &amp;dmesh, duFileIO *io)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:90</div></div>
<div class="ttc" id="aRecastDump_8h_html_a32dd617dc1eeb615d779834c760131a5"><div class="ttname"><a href="RecastDump_8h.html#a32dd617dc1eeb615d779834c760131a5">duLogBuildTimes</a></div><div class="ttdeci">void duLogBuildTimes(rcContext &amp;ctx, const int totalTileUsec)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:417</div></div>
<div class="ttc" id="aRecastDump_8h_html_a6ae5d539309d07370f7ec5eb53e94743"><div class="ttname"><a href="RecastDump_8h.html#a6ae5d539309d07370f7ec5eb53e94743">duDumpContourSet</a></div><div class="ttdeci">bool duDumpContourSet(struct rcContourSet &amp;cset, duFileIO *io)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:138</div></div>
<div class="ttc" id="aRecastDump_8h_html_a9e1f8ba842160742ce414e710c6472fb"><div class="ttname"><a href="RecastDump_8h.html#a9e1f8ba842160742ce414e710c6472fb">duReadContourSet</a></div><div class="ttdeci">bool duReadContourSet(struct rcContourSet &amp;cset, duFileIO *io)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:180</div></div>
<div class="ttc" id="aRecastDump_8h_html_aa11f7a7470e8e8aeea6f155e39edccf8"><div class="ttname"><a href="RecastDump_8h.html#aa11f7a7470e8e8aeea6f155e39edccf8">duReadCompactHeightfield</a></div><div class="ttdeci">bool duReadCompactHeightfield(struct rcCompactHeightfield &amp;chf, duFileIO *io)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:315</div></div>
<div class="ttc" id="aRecastDump_8h_html_adec19cdb843932197e6538ea2e234cc1"><div class="ttname"><a href="RecastDump_8h.html#adec19cdb843932197e6538ea2e234cc1">duDumpCompactHeightfield</a></div><div class="ttdeci">bool duDumpCompactHeightfield(struct rcCompactHeightfield &amp;chf, duFileIO *io)</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:262</div></div>
<div class="ttc" id="aclassrcContext_html"><div class="ttname"><a href="classrcContext.html">rcContext</a></div><div class="ttdoc">Provides an interface for optional logging and performance tracking of the Recast build process.</div><div class="ttdef"><b>Definition:</b> Recast.h:115</div></div>
<div class="ttc" id="astructduFileIO_html"><div class="ttname"><a href="structduFileIO.html">duFileIO</a></div><div class="ttdef"><b>Definition:</b> RecastDump.h:23</div></div>
<div class="ttc" id="astructduFileIO_html_a853e4af9415fdaa073bb785151f6b28c"><div class="ttname"><a href="structduFileIO.html#a853e4af9415fdaa073bb785151f6b28c">duFileIO::isReading</a></div><div class="ttdeci">virtual bool isReading() const =0</div></div>
<div class="ttc" id="astructduFileIO_html_ab436e18b116c61875dbdf5faafda9694"><div class="ttname"><a href="structduFileIO.html#ab436e18b116c61875dbdf5faafda9694">duFileIO::isWriting</a></div><div class="ttdeci">virtual bool isWriting() const =0</div></div>
<div class="ttc" id="astructduFileIO_html_aec33f1c0d1d0d1ec464fc1a5c135cb00"><div class="ttname"><a href="structduFileIO.html#aec33f1c0d1d0d1ec464fc1a5c135cb00">duFileIO::write</a></div><div class="ttdeci">virtual bool write(const void *ptr, const size_t size)=0</div></div>
<div class="ttc" id="astructduFileIO_html_af9c0d46a4697c00c657fa75636d0cf67"><div class="ttname"><a href="structduFileIO.html#af9c0d46a4697c00c657fa75636d0cf67">duFileIO::read</a></div><div class="ttdeci">virtual bool read(void *ptr, const size_t size)=0</div></div>
<div class="ttc" id="astructduFileIO_html_afab2836e1a3b9909bebe00e9ab81aae8"><div class="ttname"><a href="structduFileIO.html#afab2836e1a3b9909bebe00e9ab81aae8">duFileIO::~duFileIO</a></div><div class="ttdeci">virtual ~duFileIO()</div><div class="ttdef"><b>Definition:</b> RecastDump.cpp:27</div></div>
<div class="ttc" id="astructrcCompactHeightfield_html"><div class="ttname"><a href="structrcCompactHeightfield.html">rcCompactHeightfield</a></div><div class="ttdoc">A compact, static heightfield representing unobstructed space.</div><div class="ttdef"><b>Definition:</b> Recast.h:352</div></div>
<div class="ttc" id="astructrcContourSet_html"><div class="ttname"><a href="structrcContourSet.html">rcContourSet</a></div><div class="ttdoc">Represents a group of related contours.</div><div class="ttdef"><b>Definition:</b> Recast.h:431</div></div>
<div class="ttc" id="astructrcPolyMeshDetail_html"><div class="ttname"><a href="structrcPolyMeshDetail.html">rcPolyMeshDetail</a></div><div class="ttdoc">Contains triangle meshes that represent detailed height data associated with the polygons in its asso...</div><div class="ttdef"><b>Definition:</b> Recast.h:485</div></div>
<div class="ttc" id="astructrcPolyMesh_html"><div class="ttname"><a href="structrcPolyMesh.html">rcPolyMesh</a></div><div class="ttdoc">Represents a polygon mesh suitable for use in building a navigation mesh.</div><div class="ttdef"><b>Definition:</b> Recast.h:455</div></div>
</div><!-- fragment --></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_fc5ead6dadc041a993e0b7f2ef9bc4fa.html">DebugUtils</a></li><li class="navelem"><a class="el" href="dir_4bbe19f15d5140a0b6a9a27796f28250.html">Include</a></li><li class="navelem"><a class="el" href="RecastDump_8h.html">RecastDump.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>