aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_loader.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_loader.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_loader.html256
1 files changed, 256 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_loader.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_loader.html
new file mode 100644
index 0000000..00b6b26
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_loader.html
@@ -0,0 +1,256 @@
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::scene::ISceneLoader 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_1scene_1_1_i_scene_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::scene::ISceneLoader Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::scene::ISceneLoader" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Class which can load a scene into the scene manager.
95 <a href="classirr_1_1scene_1_1_i_scene_loader.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_scene_loader_8h_source.html">ISceneLoader.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::scene::ISceneLoader:</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_1scene_1_1_i_scene_loader.png" usemap="#irr::scene::ISceneLoader_map" alt=""/>
105 <map id="irr::scene::ISceneLoader_map" name="irr::scene::ISceneLoader_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,150,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1scene_1_1_i_scene_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 bool <a class="el" href="classirr_1_1scene_1_1_i_scene_loader.html#a55b0367762135b84a077ef75ca942594">isALoadableFileExtension</a> (const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp;filename) const =0
115<dl class="el"><dd class="mdescRight">Returns true if the class might be able to load this file. <a href="#a55b0367762135b84a077ef75ca942594"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1scene_1_1_i_scene_loader.html#a5f1b2f44fcac12acdc2f1948d8f3b258">isALoadableFileFormat</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *file) const =0
116<dl class="el"><dd class="mdescRight">Returns true if the class might be able to load this file. <a href="#a5f1b2f44fcac12acdc2f1948d8f3b258"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1scene_1_1_i_scene_loader.html#a55282c77040a78c2b172d77bbcff8ae8">loadScene</a> (<a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *file, <a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html">ISceneUserDataSerializer</a> *userDataSerializer=0, <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *rootNode=0)=0
117<dl class="el"><dd class="mdescRight">Loads the scene into the scene manager. <a href="#a55282c77040a78c2b172d77bbcff8ae8"></a><br/></dl></ul>
118<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
119<div class="textblock"><p>Class which can load a scene into the scene manager. </p>
120<p>If you want Irrlicht to be able to load currently unsupported scene file formats (e.g. .vrml), then implement this and add your new Sceneloader to the engine with <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html#a8f0bc0221c4faaca80ac8f560ee424ef" title="Adds an external scene loader for extending the engine with new file formats.">ISceneManager::addExternalSceneLoader()</a>. </p>
121
122<p>Definition at line <a class="el" href="_i_scene_loader_8h_source.html#l00026">26</a> of file <a class="el" href="_i_scene_loader_8h_source.html">ISceneLoader.h</a>.</p>
123</div><hr/><h2>Member Function Documentation</h2>
124<a class="anchor" id="a55b0367762135b84a077ef75ca942594"></a><!-- doxytag: member="irr::scene::ISceneLoader::isALoadableFileExtension" ref="a55b0367762135b84a077ef75ca942594" args="(const io::path &amp;filename) const =0" -->
125<div class="memitem">
126<div class="memproto">
127 <table class="memname">
128 <tr>
129 <td class="memname">virtual bool irr::scene::ISceneLoader::isALoadableFileExtension </td>
130 <td>(</td>
131 <td class="paramtype">const <a class="el" href="namespaceirr_1_1io.html#ab1bdc45edb3f94d8319c02bc0f840ee1">io::path</a> &amp;&#160;</td>
132 <td class="paramname"><em>filename</em></td><td>)</td>
133 <td> const<code> [pure virtual]</code></td>
134 </tr>
135 </table>
136</div>
137<div class="memdoc">
138
139<p>Returns true if the class might be able to load this file. </p>
140<p>This decision should be based on the file extension (e.g. ".vrml") only. </p>
141<dl><dt><b>Parameters:</b></dt><dd>
142 <table class="params">
143 <tr><td class="paramname">filename</td><td>Name of the file to test. </td></tr>
144 </table>
145 </dd>
146</dl>
147<dl class="return"><dt><b>Returns:</b></dt><dd>True if the extension is a recognised type. </dd></dl>
148
149</div>
150</div>
151<a class="anchor" id="a5f1b2f44fcac12acdc2f1948d8f3b258"></a><!-- doxytag: member="irr::scene::ISceneLoader::isALoadableFileFormat" ref="a5f1b2f44fcac12acdc2f1948d8f3b258" args="(io::IReadFile *file) const =0" -->
152<div class="memitem">
153<div class="memproto">
154 <table class="memname">
155 <tr>
156 <td class="memname">virtual bool irr::scene::ISceneLoader::isALoadableFileFormat </td>
157 <td>(</td>
158 <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *&#160;</td>
159 <td class="paramname"><em>file</em></td><td>)</td>
160 <td> const<code> [pure virtual]</code></td>
161 </tr>
162 </table>
163</div>
164<div class="memdoc">
165
166<p>Returns true if the class might be able to load this file. </p>
167<p>This decision will be based on a quick look at the contents of the file. </p>
168<dl><dt><b>Parameters:</b></dt><dd>
169 <table class="params">
170 <tr><td class="paramname">file</td><td>The file to test. </td></tr>
171 </table>
172 </dd>
173</dl>
174<dl class="return"><dt><b>Returns:</b></dt><dd>True if the extension is a recognised type. </dd></dl>
175
176</div>
177</div>
178<a class="anchor" id="a55282c77040a78c2b172d77bbcff8ae8"></a><!-- doxytag: member="irr::scene::ISceneLoader::loadScene" ref="a55282c77040a78c2b172d77bbcff8ae8" args="(io::IReadFile *file, ISceneUserDataSerializer *userDataSerializer=0, ISceneNode *rootNode=0)=0" -->
179<div class="memitem">
180<div class="memproto">
181 <table class="memname">
182 <tr>
183 <td class="memname">virtual bool irr::scene::ISceneLoader::loadScene </td>
184 <td>(</td>
185 <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_read_file.html">io::IReadFile</a> *&#160;</td>
186 <td class="paramname"><em>file</em>, </td>
187 </tr>
188 <tr>
189 <td class="paramkey"></td>
190 <td></td>
191 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html">ISceneUserDataSerializer</a> *&#160;</td>
192 <td class="paramname"><em>userDataSerializer</em> = <code>0</code>, </td>
193 </tr>
194 <tr>
195 <td class="paramkey"></td>
196 <td></td>
197 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
198 <td class="paramname"><em>rootNode</em> = <code>0</code>&#160;</td>
199 </tr>
200 <tr>
201 <td></td>
202 <td>)</td>
203 <td></td><td><code> [pure virtual]</code></td>
204 </tr>
205 </table>
206</div>
207<div class="memdoc">
208
209<p>Loads the scene into the scene manager. </p>
210<dl><dt><b>Parameters:</b></dt><dd>
211 <table class="params">
212 <tr><td class="paramname">file</td><td>File which contains the scene. </td></tr>
213 <tr><td class="paramname">userDataSerializer,:</td><td>If you want to load user data which may be attached to some some scene nodes in the file, implement the <a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html" title="Interface to read and write user data to and from .irr files.">ISceneUserDataSerializer</a> interface and provide it as parameter here. Otherwise, simply specify 0 as this parameter. </td></tr>
214 <tr><td class="paramname">rootNode</td><td>The node to load the scene into, if none is provided then the scene will be loaded into the root node. </td></tr>
215 </table>
216 </dd>
217</dl>
218<dl class="return"><dt><b>Returns:</b></dt><dd>Returns true on success, false on failure. Returns 0 if loading failed. </dd></dl>
219
220</div>
221</div>
222<hr/>The documentation for this class was generated from the following file:<ul>
223<li><a class="el" href="_i_scene_loader_8h_source.html">ISceneLoader.h</a></li>
224</ul>
225</div>
226</div>
227 <div id="nav-path" class="navpath">
228 <ul>
229 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
230 <li class="navelem"><a class="el" href="namespaceirr_1_1scene.html">scene</a> </li>
231 <li class="navelem"><a class="el" href="classirr_1_1scene_1_1_i_scene_loader.html">ISceneLoader</a> </li>
232<!-- window showing the filter options -->
233<div id="MSearchSelectWindow"
234 onmouseover="return searchBox.OnSearchSelectShow()"
235 onmouseout="return searchBox.OnSearchSelectHide()"
236 onkeydown="return searchBox.OnSearchSelectKey(event)">
237<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>
238
239<!-- iframe showing the search results (closed by default) -->
240<div id="MSearchResultsWindow">
241<iframe src="javascript:void(0)" frameborder="0"
242 name="MSearchResults" id="MSearchResults">
243</iframe>
244</div>
245
246
247 <li class="footer">
248<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
249Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:47 for Irrlicht 3D Engine by
250<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
251 </ul>
252 </div>
253
254
255</body>
256</html>
generated by cgit v1.1 at 2024-06-27 09:17:07 +0000