aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_factory.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_factory.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_factory.html329
1 files changed, 329 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_factory.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_factory.html
new file mode 100644
index 0000000..6e415c9
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_factory.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::scene::ISceneNodeFactory 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_node_factory.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::ISceneNodeFactory Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::scene::ISceneNodeFactory" --><!-- doxytag: inherits="irr::IReferenceCounted" -->
94<p>Interface for dynamic creation of scene nodes.
95 <a href="classirr_1_1scene_1_1_i_scene_node_factory.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_scene_node_factory_8h_source.html">ISceneNodeFactory.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::ISceneNodeFactory:</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_node_factory.png" usemap="#irr::scene::ISceneNodeFactory_map" alt=""/>
105 <map id="irr::scene::ISceneNodeFactory_map" name="irr::scene::ISceneNodeFactory_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,184,24"/>
107</map>
108 </div></div>
109
110<p><a href="classirr_1_1scene_1_1_i_scene_node_factory-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_1scene_1_1_i_scene_node.html">ISceneNode</a> * <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#a540de57f9f72a70ee622c536859f5997">addSceneNode</a> (<a class="el" href="namespaceirr_1_1scene.html#acad3d7ef92a9807d391ba29120f3b7bd">ESCENE_NODE_TYPE</a> type, <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *parent=0)=0
115<dl class="el"><dd class="mdescRight">adds a scene node to the scene graph based on its type id <a href="#a540de57f9f72a70ee622c536859f5997"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> * <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#a7964a7a29260d7f0d4d052b85df78ffb">addSceneNode</a> (const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *typeName, <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *parent=0)=0
116<dl class="el"><dd class="mdescRight">adds a scene node to the scene graph based on its type name <a href="#a7964a7a29260d7f0d4d052b85df78ffb"></a><br/></dl><li>virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#a3c1be487fb0169ee9fbb7169c451d16e">getCreatableSceneNodeTypeCount</a> () const =0
117<dl class="el"><dd class="mdescRight">returns amount of scene node types this factory is able to create <a href="#a3c1be487fb0169ee9fbb7169c451d16e"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1scene.html#acad3d7ef92a9807d391ba29120f3b7bd">ESCENE_NODE_TYPE</a> <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#aaff4e3d3dc214ec83965ecbd8e8175a3">getCreateableSceneNodeType</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> idx) const =0
118<dl class="el"><dd class="mdescRight">returns type of a createable scene node type <a href="#aaff4e3d3dc214ec83965ecbd8e8175a3"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#a259f156cc367a9a89f79159ad2b665ac">getCreateableSceneNodeTypeName</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> idx) const =0
119<dl class="el"><dd class="mdescRight">returns type name of a createable scene node type by index <a href="#a259f156cc367a9a89f79159ad2b665ac"></a><br/></dl><li>virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> * <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#addc09a5ab7a8d8b65182fbaa09c88b6f">getCreateableSceneNodeTypeName</a> (<a class="el" href="namespaceirr_1_1scene.html#acad3d7ef92a9807d391ba29120f3b7bd">ESCENE_NODE_TYPE</a> type) const =0
120<dl class="el"><dd class="mdescRight">returns type name of a createable scene node type <a href="#addc09a5ab7a8d8b65182fbaa09c88b6f"></a><br/></dl></ul>
121<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
122<div class="textblock"><p>Interface for dynamic creation of scene nodes. </p>
123<p>To be able to add custom scene nodes to Irrlicht and to make it possible for the scene manager to save and load those external scene nodes, simply implement this interface and register it in you scene manager via <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html#a75ac9315def74ae5e26a2d6a2f5a38e9" title="Adds a scene node factory to the scene manager.">ISceneManager::registerSceneNodeFactory</a>. Note: When implementing your own scene node factory, don't call ISceneNodeManager::grab() to increase the reference counter of the scene node manager. This is not necessary because the scene node manager will <a class="el" href="classirr_1_1_i_reference_counted.html#a2b7a035532e5f409ca9482dab79185f4" title="Grabs the object. Increments the reference counter by one.">grab()</a> the factory anyway, and otherwise cyclic references will be created and the scene manager and all its nodes won't get deallocated. </p>
124
125<p>Definition at line <a class="el" href="_i_scene_node_factory_8h_source.html#l00027">27</a> of file <a class="el" href="_i_scene_node_factory_8h_source.html">ISceneNodeFactory.h</a>.</p>
126</div><hr/><h2>Member Function Documentation</h2>
127<a class="anchor" id="a540de57f9f72a70ee622c536859f5997"></a><!-- doxytag: member="irr::scene::ISceneNodeFactory::addSceneNode" ref="a540de57f9f72a70ee622c536859f5997" args="(ESCENE_NODE_TYPE type, ISceneNode *parent=0)=0" -->
128<div class="memitem">
129<div class="memproto">
130 <table class="memname">
131 <tr>
132 <td class="memname">virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a>* irr::scene::ISceneNodeFactory::addSceneNode </td>
133 <td>(</td>
134 <td class="paramtype"><a class="el" href="namespaceirr_1_1scene.html#acad3d7ef92a9807d391ba29120f3b7bd">ESCENE_NODE_TYPE</a>&#160;</td>
135 <td class="paramname"><em>type</em>, </td>
136 </tr>
137 <tr>
138 <td class="paramkey"></td>
139 <td></td>
140 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
141 <td class="paramname"><em>parent</em> = <code>0</code>&#160;</td>
142 </tr>
143 <tr>
144 <td></td>
145 <td>)</td>
146 <td></td><td><code> [pure virtual]</code></td>
147 </tr>
148 </table>
149</div>
150<div class="memdoc">
151
152<p>adds a scene node to the scene graph based on its type id </p>
153<dl><dt><b>Parameters:</b></dt><dd>
154 <table class="params">
155 <tr><td class="paramname">type,:</td><td>Type of the scene node to add. </td></tr>
156 <tr><td class="paramname">parent,:</td><td>Parent scene node of the new node, can be null to add the scene node to the root. </td></tr>
157 </table>
158 </dd>
159</dl>
160<dl class="return"><dt><b>Returns:</b></dt><dd>Returns pointer to the new scene node or null if not successful. This pointer should not be dropped. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl>
161
162</div>
163</div>
164<a class="anchor" id="a7964a7a29260d7f0d4d052b85df78ffb"></a><!-- doxytag: member="irr::scene::ISceneNodeFactory::addSceneNode" ref="a7964a7a29260d7f0d4d052b85df78ffb" args="(const c8 *typeName, ISceneNode *parent=0)=0" -->
165<div class="memitem">
166<div class="memproto">
167 <table class="memname">
168 <tr>
169 <td class="memname">virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a>* irr::scene::ISceneNodeFactory::addSceneNode </td>
170 <td>(</td>
171 <td class="paramtype">const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a> *&#160;</td>
172 <td class="paramname"><em>typeName</em>, </td>
173 </tr>
174 <tr>
175 <td class="paramkey"></td>
176 <td></td>
177 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
178 <td class="paramname"><em>parent</em> = <code>0</code>&#160;</td>
179 </tr>
180 <tr>
181 <td></td>
182 <td>)</td>
183 <td></td><td><code> [pure virtual]</code></td>
184 </tr>
185 </table>
186</div>
187<div class="memdoc">
188
189<p>adds a scene node to the scene graph based on its type name </p>
190<dl><dt><b>Parameters:</b></dt><dd>
191 <table class="params">
192 <tr><td class="paramname">typeName,:</td><td>Type name of the scene node to add. </td></tr>
193 <tr><td class="paramname">parent,:</td><td>Parent scene node of the new node, can be null to add the scene node to the root. </td></tr>
194 </table>
195 </dd>
196</dl>
197<dl class="return"><dt><b>Returns:</b></dt><dd>Returns pointer to the new scene node or null if not successful. This pointer should not be dropped. See <a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a> for more information. </dd></dl>
198
199</div>
200</div>
201<a class="anchor" id="a3c1be487fb0169ee9fbb7169c451d16e"></a><!-- doxytag: member="irr::scene::ISceneNodeFactory::getCreatableSceneNodeTypeCount" ref="a3c1be487fb0169ee9fbb7169c451d16e" args="() const =0" -->
202<div class="memitem">
203<div class="memproto">
204 <table class="memname">
205 <tr>
206 <td class="memname">virtual <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> irr::scene::ISceneNodeFactory::getCreatableSceneNodeTypeCount </td>
207 <td>(</td>
208 <td class="paramname"></td><td>)</td>
209 <td> const<code> [pure virtual]</code></td>
210 </tr>
211 </table>
212</div>
213<div class="memdoc">
214
215<p>returns amount of scene node types this factory is able to create </p>
216
217</div>
218</div>
219<a class="anchor" id="aaff4e3d3dc214ec83965ecbd8e8175a3"></a><!-- doxytag: member="irr::scene::ISceneNodeFactory::getCreateableSceneNodeType" ref="aaff4e3d3dc214ec83965ecbd8e8175a3" args="(u32 idx) const =0" -->
220<div class="memitem">
221<div class="memproto">
222 <table class="memname">
223 <tr>
224 <td class="memname">virtual <a class="el" href="namespaceirr_1_1scene.html#acad3d7ef92a9807d391ba29120f3b7bd">ESCENE_NODE_TYPE</a> irr::scene::ISceneNodeFactory::getCreateableSceneNodeType </td>
225 <td>(</td>
226 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
227 <td class="paramname"><em>idx</em></td><td>)</td>
228 <td> const<code> [pure virtual]</code></td>
229 </tr>
230 </table>
231</div>
232<div class="memdoc">
233
234<p>returns type of a createable scene node type </p>
235<dl><dt><b>Parameters:</b></dt><dd>
236 <table class="params">
237 <tr><td class="paramname">idx,:</td><td>Index of scene node type in this factory. Must be a value between 0 and <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#a3c1be487fb0169ee9fbb7169c451d16e" title="returns amount of scene node types this factory is able to create">getCreatableSceneNodeTypeCount()</a> </td></tr>
238 </table>
239 </dd>
240</dl>
241
242</div>
243</div>
244<a class="anchor" id="a259f156cc367a9a89f79159ad2b665ac"></a><!-- doxytag: member="irr::scene::ISceneNodeFactory::getCreateableSceneNodeTypeName" ref="a259f156cc367a9a89f79159ad2b665ac" args="(u32 idx) const =0" -->
245<div class="memitem">
246<div class="memproto">
247 <table class="memname">
248 <tr>
249 <td class="memname">virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a>* irr::scene::ISceneNodeFactory::getCreateableSceneNodeTypeName </td>
250 <td>(</td>
251 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
252 <td class="paramname"><em>idx</em></td><td>)</td>
253 <td> const<code> [pure virtual]</code></td>
254 </tr>
255 </table>
256</div>
257<div class="memdoc">
258
259<p>returns type name of a createable scene node type by index </p>
260<dl><dt><b>Parameters:</b></dt><dd>
261 <table class="params">
262 <tr><td class="paramname">idx,:</td><td>Index of scene node type in this factory. Must be a value between 0 and <a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html#a3c1be487fb0169ee9fbb7169c451d16e" title="returns amount of scene node types this factory is able to create">getCreatableSceneNodeTypeCount()</a> </td></tr>
263 </table>
264 </dd>
265</dl>
266
267</div>
268</div>
269<a class="anchor" id="addc09a5ab7a8d8b65182fbaa09c88b6f"></a><!-- doxytag: member="irr::scene::ISceneNodeFactory::getCreateableSceneNodeTypeName" ref="addc09a5ab7a8d8b65182fbaa09c88b6f" args="(ESCENE_NODE_TYPE type) const =0" -->
270<div class="memitem">
271<div class="memproto">
272 <table class="memname">
273 <tr>
274 <td class="memname">virtual const <a class="el" href="namespaceirr.html#a9395eaea339bcb546b319e9c96bf7410">c8</a>* irr::scene::ISceneNodeFactory::getCreateableSceneNodeTypeName </td>
275 <td>(</td>
276 <td class="paramtype"><a class="el" href="namespaceirr_1_1scene.html#acad3d7ef92a9807d391ba29120f3b7bd">ESCENE_NODE_TYPE</a>&#160;</td>
277 <td class="paramname"><em>type</em></td><td>)</td>
278 <td> const<code> [pure virtual]</code></td>
279 </tr>
280 </table>
281</div>
282<div class="memdoc">
283
284<p>returns type name of a createable scene node type </p>
285<dl><dt><b>Parameters:</b></dt><dd>
286 <table class="params">
287 <tr><td class="paramname">type,:</td><td>Type of scene node. </td></tr>
288 </table>
289 </dd>
290</dl>
291<dl class="return"><dt><b>Returns:</b></dt><dd>: Returns name of scene node type if this factory can create the type, otherwise 0. </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_scene_node_factory_8h_source.html">ISceneNodeFactory.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_1scene.html">scene</a> </li>
304 <li class="navelem"><a class="el" href="classirr_1_1scene_1_1_i_scene_node_factory.html">ISceneNodeFactory</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:47 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-15 19:15:54 +0000