aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_archive_loader.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_archive_loader.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_archive_loader.html329
1 files changed, 329 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_archive_loader.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_archive_loader.html
new file mode 100644
index 0000000..1b4b9ec
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1io_1_1_i_archive_loader.html
@@ -0,0 +1,329 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::io::IArchiveLoader Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1io_1_1_i_archive_loader.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::io::IArchiveLoader Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::io::IArchiveLoader" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Class which is able to create an archive from a file.
95 <a href="classirr_1_1io_1_1_i_archive_loader.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::io::IArchiveLoader:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1io_1_1_i_archive_loader.png" usemap="#irr::io::IArchiveLoader_map" alt=""/>
105 <map id="irr::io::IArchiveLoader_map" name="irr::io::IArchiveLoader_map">
106<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,140,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1io_1_1_i_archive_loader-members.html">List of all members.</a></p>
111<h2><a name="pub-methods"></a>
112Public Member Functions</h2>
113<ul>
114<li>virtual <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> * <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html#a55e9586f190588e5fea6d17f63fb7aad">createArchive</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &amp;filename, bool ignoreCase, bool ignorePaths) const =0
115<dl class="el"><dd class="mdescRight">Creates an archive from the filename. <a href="#a55e9586f190588e5fea6d17f63fb7aad"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a> * <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html#acd4a78189c62db96e4e10aa89c934980">createArchive</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *file, bool ignoreCase, bool ignorePaths) const =0
116<dl class="el"><dd class="mdescRight">Creates an archive from the file. <a href="#acd4a78189c62db96e4e10aa89c934980"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html#a9835ccbfd2c261edf4a738421c488ce3">isALoadableFileFormat</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &amp;filename) const =0
117<dl class="el"><dd class="mdescRight">Check if the file might be loaded by this class. <a href="#a9835ccbfd2c261edf4a738421c488ce3"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html#acda22c3c2a5268665a4a4cf17379931b">isALoadableFileFormat</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *file) const =0
118<dl class="el"><dd class="mdescRight">Check if the file might be loaded by this class. <a href="#acda22c3c2a5268665a4a4cf17379931b"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1io_1_1_i_archive_loader.html#af60c081f27ab941702a4a32dfe482c05">isALoadableFileFormat</a> (<a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a> fileType) const =0
119<dl class="el"><dd class="mdescRight">Check to see if the loader can create archives of this type. <a href="#af60c081f27ab941702a4a32dfe482c05"></a><br/></dl></ul>
120<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
121<div class="textblock"><p>Class which is able to create an archive from a file. </p>
122<p>If you want the Irrlicht Engine be able to load archives of currently unsupported file formats (e.g .wad), then implement this and add your new Archive loader with <a class="el" href="classirr_1_1io_1_1_i_file_system.html#ad56456302b4697c49b461a909d9269b9" title="Adds an external archive loader to the engine.">IFileSystem::addArchiveLoader()</a> to the engine. </p>
123
124<p>Definition at line <a class="el" href="_i_file_archive_8h_source.html#l00091">91</a> of file <a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a>.</p>
125</div><hr/><h2>Member Function Documentation</h2>
126<a class="anchor" id="a55e9586f190588e5fea6d17f63fb7aad"></a><!-- doxytag: member="irr::io::IArchiveLoader::createArchive" ref="a55e9586f190588e5fea6d17f63fb7aad" args="(const path &amp;filename, bool ignoreCase, bool ignorePaths) const =0" -->
127<div class="memitem">
128<div class="memproto">
129 <table class="memname">
130 <tr>
131 <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a>* irr::io::IArchiveLoader::createArchive </td>
132 <td>(</td>
133 <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &amp;&#160;</td>
134 <td class="paramname"><em>filename</em>, </td>
135 </tr>
136 <tr>
137 <td class="paramkey"></td>
138 <td></td>
139 <td class="paramtype">bool&#160;</td>
140 <td class="paramname"><em>ignoreCase</em>, </td>
141 </tr>
142 <tr>
143 <td class="paramkey"></td>
144 <td></td>
145 <td class="paramtype">bool&#160;</td>
146 <td class="paramname"><em>ignorePaths</em>&#160;</td>
147 </tr>
148 <tr>
149 <td></td>
150 <td>)</td>
151 <td></td><td> const<code> [pure virtual]</code></td>
152 </tr>
153 </table>
154</div>
155<div class="memdoc">
156
157<p>Creates an archive from the filename. </p>
158<dl><dt><b>Parameters:</b></dt><dd>
159 <table class="params">
160 <tr><td class="paramname">filename</td><td>File to use. </td></tr>
161 <tr><td class="paramname">ignoreCase</td><td>Searching is performed without regarding the case </td></tr>
162 <tr><td class="paramname">ignorePaths</td><td>Files are searched for without checking for the directories </td></tr>
163 </table>
164 </dd>
165</dl>
166<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to newly created archive, or 0 upon error. </dd></dl>
167
168</div>
169</div>
170<a class="anchor" id="acd4a78189c62db96e4e10aa89c934980"></a><!-- doxytag: member="irr::io::IArchiveLoader::createArchive" ref="acd4a78189c62db96e4e10aa89c934980" args="(io::IReadFile *file, bool ignoreCase, bool ignorePaths) const =0" -->
171<div class="memitem">
172<div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_file_archive.html">IFileArchive</a>* irr::io::IArchiveLoader::createArchive </td>
176 <td>(</td>
177 <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *&#160;</td>
178 <td class="paramname"><em>file</em>, </td>
179 </tr>
180 <tr>
181 <td class="paramkey"></td>
182 <td></td>
183 <td class="paramtype">bool&#160;</td>
184 <td class="paramname"><em>ignoreCase</em>, </td>
185 </tr>
186 <tr>
187 <td class="paramkey"></td>
188 <td></td>
189 <td class="paramtype">bool&#160;</td>
190 <td class="paramname"><em>ignorePaths</em>&#160;</td>
191 </tr>
192 <tr>
193 <td></td>
194 <td>)</td>
195 <td></td><td> const<code> [pure virtual]</code></td>
196 </tr>
197 </table>
198</div>
199<div class="memdoc">
200
201<p>Creates an archive from the file. </p>
202<dl><dt><b>Parameters:</b></dt><dd>
203 <table class="params">
204 <tr><td class="paramname">file</td><td>File handle to use. </td></tr>
205 <tr><td class="paramname">ignoreCase</td><td>Searching is performed without regarding the case </td></tr>
206 <tr><td class="paramname">ignorePaths</td><td>Files are searched for without checking for the directories </td></tr>
207 </table>
208 </dd>
209</dl>
210<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to newly created archive, or 0 upon error. </dd></dl>
211
212</div>
213</div>
214<a class="anchor" id="a9835ccbfd2c261edf4a738421c488ce3"></a><!-- doxytag: member="irr::io::IArchiveLoader::isALoadableFileFormat" ref="a9835ccbfd2c261edf4a738421c488ce3" args="(const path &amp;filename) const =0" -->
215<div class="memitem">
216<div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">virtual bool irr::io::IArchiveLoader::isALoadableFileFormat </td>
220 <td>(</td>
221 <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">path</a> &amp;&#160;</td>
222 <td class="paramname"><em>filename</em></td><td>)</td>
223 <td> const<code> [pure virtual]</code></td>
224 </tr>
225 </table>
226</div>
227<div class="memdoc">
228
229<p>Check if the file might be loaded by this class. </p>
230<p>Check based on the file extension (e.g. ".zip") </p>
231<dl><dt><b>Parameters:</b></dt><dd>
232 <table class="params">
233 <tr><td class="paramname">filename</td><td>Name of file to check. </td></tr>
234 </table>
235 </dd>
236</dl>
237<dl class="return"><dt><b>Returns:</b></dt><dd>True if file seems to be loadable. </dd></dl>
238
239</div>
240</div>
241<a class="anchor" id="acda22c3c2a5268665a4a4cf17379931b"></a><!-- doxytag: member="irr::io::IArchiveLoader::isALoadableFileFormat" ref="acda22c3c2a5268665a4a4cf17379931b" args="(io::IReadFile *file) const =0" -->
242<div class="memitem">
243<div class="memproto">
244 <table class="memname">
245 <tr>
246 <td class="memname">virtual bool irr::io::IArchiveLoader::isALoadableFileFormat </td>
247 <td>(</td>
248 <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *&#160;</td>
249 <td class="paramname"><em>file</em></td><td>)</td>
250 <td> const<code> [pure virtual]</code></td>
251 </tr>
252 </table>
253</div>
254<div class="memdoc">
255
256<p>Check if the file might be loaded by this class. </p>
257<p>This check may look into the file. </p>
258<dl><dt><b>Parameters:</b></dt><dd>
259 <table class="params">
260 <tr><td class="paramname">file</td><td>File handle to check. </td></tr>
261 </table>
262 </dd>
263</dl>
264<dl class="return"><dt><b>Returns:</b></dt><dd>True if file seems to be loadable. </dd></dl>
265
266</div>
267</div>
268<a class="anchor" id="af60c081f27ab941702a4a32dfe482c05"></a><!-- doxytag: member="irr::io::IArchiveLoader::isALoadableFileFormat" ref="af60c081f27ab941702a4a32dfe482c05" args="(E_FILE_ARCHIVE_TYPE fileType) const =0" -->
269<div class="memitem">
270<div class="memproto">
271 <table class="memname">
272 <tr>
273 <td class="memname">virtual bool irr::io::IArchiveLoader::isALoadableFileFormat </td>
274 <td>(</td>
275 <td class="paramtype"><a class="el" href="namespaceirr_1_1io.html#adb3e3c445ec8e608ed1f0f93306da14f">E_FILE_ARCHIVE_TYPE</a>&#160;</td>
276 <td class="paramname"><em>fileType</em></td><td>)</td>
277 <td> const<code> [pure virtual]</code></td>
278 </tr>
279 </table>
280</div>
281<div class="memdoc">
282
283<p>Check to see if the loader can create archives of this type. </p>
284<p>Check based on the archive type. </p>
285<dl><dt><b>Parameters:</b></dt><dd>
286 <table class="params">
287 <tr><td class="paramname">fileType</td><td>The archive type to check. </td></tr>
288 </table>
289 </dd>
290</dl>
291<dl class="return"><dt><b>Returns:</b></dt><dd>True if the archile loader supports this type, false if not </dd></dl>
292
293</div>
294</div>
295<hr/>The documentation for this class was generated from the following file:<ul>
296<li><a class="el" href="_i_file_archive_8h_source.html">IFileArchive.h</a></li>
297</ul>
298</div>
299</div>
300 <div id="nav-path" class="navpath">
301 <ul>
302 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
303 <li class="navelem"><a class="el" href="namespaceirr_1_1io.html">io</a> </li>
304 <li class="navelem"><a class="el" href="classirr_1_1io_1_1_i_archive_loader.html">IArchiveLoader</a> </li>
305<!-- window showing the filter options -->
306<div id="MSearchSelectWindow"
307 onmouseover="return searchBox.OnSearchSelectShow()"
308 onmouseout="return searchBox.OnSearchSelectHide()"
309 onkeydown="return searchBox.OnSearchSelectKey(event)">
310<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
311
312<!-- iframe showing the search results (closed by default) -->
313<div id="MSearchResultsWindow">
314<iframe src="javascript:void(0)" frameborder="0"
315 name="MSearchResults" id="MSearchResults">
316</iframe>
317</div>
318
319
320 <li class="footer">
321<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
322Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:44 for Irrlicht 3D Engine by
323<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
324 </ul>
325 </div>
326
327
328</body>
329</html>
generated by cgit v1.1 at 2024-05-16 00:55:12 +0000