Scarfski/recastnavigation
1
0
Fork 0
mirror of https://github.com/recastnavigation/recastnavigation.git synced 2026-08-30 06:58:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4829bffd3257cd64a69d7f784ea4554d18d1f1fd
recastnavigation/classFileIO.html

361 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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: FileIO Class 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="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('classFileIO.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="#pub-methods">Public Member Functions</a> &#124;
<a href="classFileIO-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FileIO Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>stdio file implementation.
<a href="classFileIO.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SampleInterfaces_8h_source.html">SampleInterfaces.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FileIO:</div>
<div class="dyncontent">
<div class="center">
<img src="classFileIO.png" usemap="#FileIO_map" alt=""/>
<map id="FileIO_map" name="FileIO_map">
<area href="structduFileIO.html" alt="duFileIO" shape="rect" coords="0,0,60,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8b0d602c3461181e12c05f655dea5018"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#a8b0d602c3461181e12c05f655dea5018">FileIO</a> ()</td></tr>
<tr class="separator:a8b0d602c3461181e12c05f655dea5018"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc3caa8f1e5d76274d8ffb8b5c17288b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#adc3caa8f1e5d76274d8ffb8b5c17288b">~FileIO</a> ()</td></tr>
<tr class="separator:adc3caa8f1e5d76274d8ffb8b5c17288b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7fcae34c0941ffe183fbe1cdc180f22"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#ae7fcae34c0941ffe183fbe1cdc180f22">openForWrite</a> (const char *path)</td></tr>
<tr class="separator:ae7fcae34c0941ffe183fbe1cdc180f22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a96ca80a7c66c14883007e88679e87e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#a3a96ca80a7c66c14883007e88679e87e">openForRead</a> (const char *path)</td></tr>
<tr class="separator:a3a96ca80a7c66c14883007e88679e87e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02526e6d91e126ce105adaf614ab863c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#a02526e6d91e126ce105adaf614ab863c">isWriting</a> () const</td></tr>
<tr class="separator:a02526e6d91e126ce105adaf614ab863c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd4cbb0b54a4d450b53294ce24866346"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#acd4cbb0b54a4d450b53294ce24866346">isReading</a> () const</td></tr>
<tr class="separator:acd4cbb0b54a4d450b53294ce24866346"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2ff5f1db6c224a0fa15f3b039a6009d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#aa2ff5f1db6c224a0fa15f3b039a6009d">write</a> (const void *ptr, const size_t size)</td></tr>
<tr class="separator:aa2ff5f1db6c224a0fa15f3b039a6009d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11dcd9d7e8a00db63db74abf437dc4a7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileIO.html#a11dcd9d7e8a00db63db74abf437dc4a7">read</a> (void *ptr, const size_t size)</td></tr>
<tr class="separator:a11dcd9d7e8a00db63db74abf437dc4a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structduFileIO"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structduFileIO')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structduFileIO.html">duFileIO</a></td></tr>
<tr class="memitem:afab2836e1a3b9909bebe00e9ab81aae8 inherit pub_methods_structduFileIO"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structduFileIO.html#afab2836e1a3b9909bebe00e9ab81aae8">~duFileIO</a> ()</td></tr>
<tr class="separator:afab2836e1a3b9909bebe00e9ab81aae8 inherit pub_methods_structduFileIO"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>stdio file implementation. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8b0d602c3461181e12c05f655dea5018"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b0d602c3461181e12c05f655dea5018">&#9670;&nbsp;</a></span>FileIO()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileIO::FileIO </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adc3caa8f1e5d76274d8ffb8b5c17288b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc3caa8f1e5d76274d8ffb8b5c17288b">&#9670;&nbsp;</a></span>~FileIO()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FileIO::~FileIO </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acd4cbb0b54a4d450b53294ce24866346"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd4cbb0b54a4d450b53294ce24866346">&#9670;&nbsp;</a></span>isReading()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileIO::isReading </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="structduFileIO.html#a853e4af9415fdaa073bb785151f6b28c">duFileIO</a>.</p>
</div>
</div>
<a id="a02526e6d91e126ce105adaf614ab863c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02526e6d91e126ce105adaf614ab863c">&#9670;&nbsp;</a></span>isWriting()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileIO::isWriting </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="structduFileIO.html#ab436e18b116c61875dbdf5faafda9694">duFileIO</a>.</p>
</div>
</div>
<a id="a3a96ca80a7c66c14883007e88679e87e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a96ca80a7c66c14883007e88679e87e">&#9670;&nbsp;</a></span>openForRead()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileIO::openForRead </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae7fcae34c0941ffe183fbe1cdc180f22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7fcae34c0941ffe183fbe1cdc180f22">&#9670;&nbsp;</a></span>openForWrite()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FileIO::openForWrite </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a11dcd9d7e8a00db63db74abf437dc4a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11dcd9d7e8a00db63db74abf437dc4a7">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileIO::read </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="structduFileIO.html#af9c0d46a4697c00c657fa75636d0cf67">duFileIO</a>.</p>
</div>
</div>
<a id="aa2ff5f1db6c224a0fa15f3b039a6009d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2ff5f1db6c224a0fa15f3b039a6009d">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool FileIO::write </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="structduFileIO.html#aec33f1c0d1d0d1ec464fc1a5c135cb00">duFileIO</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SampleInterfaces_8h_source.html">SampleInterfaces.h</a></li>
<li><a class="el" href="SampleInterfaces_8cpp.html">SampleInterfaces.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="classFileIO.html">FileIO</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