diff options
Diffstat (limited to 'libraries/irrlicht-1.8/doc/html/classirr_1_1scene_1_1_i_scene_user_data_serializer.html')
-rw-r--r-- | libraries/irrlicht-1.8/doc/html/classirr_1_1scene_1_1_i_scene_user_data_serializer.html | 236 |
1 files changed, 0 insertions, 236 deletions
diff --git a/libraries/irrlicht-1.8/doc/html/classirr_1_1scene_1_1_i_scene_user_data_serializer.html b/libraries/irrlicht-1.8/doc/html/classirr_1_1scene_1_1_i_scene_user_data_serializer.html deleted file mode 100644 index f3b6d55..0000000 --- a/libraries/irrlicht-1.8/doc/html/classirr_1_1scene_1_1_i_scene_user_data_serializer.html +++ /dev/null | |||
@@ -1,236 +0,0 @@ | |||
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::ISceneUserDataSerializer 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"> | ||
69 | var 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_user_data_serializer.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::ISceneUserDataSerializer Class Reference</div> </div> | ||
91 | </div> | ||
92 | <div class="contents"> | ||
93 | <!-- doxytag: class="irr::scene::ISceneUserDataSerializer" --> | ||
94 | <p>Interface to read and write user data to and from .irr files. | ||
95 | <a href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html#details">More...</a></p> | ||
96 | |||
97 | <p><code>#include <<a class="el" href="_i_scene_user_data_serializer_8h_source.html">ISceneUserDataSerializer.h</a>></code></p> | ||
98 | |||
99 | <p><a href="classirr_1_1scene_1_1_i_scene_user_data_serializer-members.html">List of all members.</a></p> | ||
100 | <h2><a name="pub-methods"></a> | ||
101 | Public Member Functions</h2> | ||
102 | <ul> | ||
103 | <li>virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html#a02175cc96f2121b3ea231938be21e4bc">~ISceneUserDataSerializer</a> () | ||
104 | <li>virtual <a class="el" href="classirr_1_1io_1_1_i_attributes.html">io::IAttributes</a> * <a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html#a8d276882257602ffc03a23a38290ea44">createUserData</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *forSceneNode)=0 | ||
105 | <dl class="el"><dd class="mdescRight">Called when the scene manager is writing a scene node to an xml file for example. <a href="#a8d276882257602ffc03a23a38290ea44"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html#af025f0c9ee60be56d91f34bc9ab15115">OnCreateNode</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *node)=0 | ||
106 | <dl class="el"><dd class="mdescRight">Called when the scene manager create a scene node while loading a file. <a href="#af025f0c9ee60be56d91f34bc9ab15115"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html#a48276bde0e05343d39ec25c6933f122d">OnReadUserData</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *forSceneNode, <a class="el" href="classirr_1_1io_1_1_i_attributes.html">io::IAttributes</a> *userData)=0 | ||
107 | <dl class="el"><dd class="mdescRight">Called when the scene manager read a scene node while loading a file. <a href="#a48276bde0e05343d39ec25c6933f122d"></a><br/></dl></ul> | ||
108 | <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> | ||
109 | <div class="textblock"><p>Interface to read and write user data to and from .irr files. </p> | ||
110 | <p>This interface is to be implemented by the user, to make it possible to read and write user data when reading or writing .irr files via <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html" title="The Scene Manager manages scene nodes, mesh recources, cameras and all the other stuff.">ISceneManager</a>. To be used with <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html#aa7641dd33e84fca7946ed17047349a3e" title="Loads a scene. Note that the current scene is not cleared before.">ISceneManager::loadScene()</a> and <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html#a6dd059e96ff4f7233b7ba1ed7e39c337" title="Saves the current scene into a file.">ISceneManager::saveScene()</a> </p> | ||
111 | |||
112 | <p>Definition at line <a class="el" href="_i_scene_user_data_serializer_8h_source.html#l00024">24</a> of file <a class="el" href="_i_scene_user_data_serializer_8h_source.html">ISceneUserDataSerializer.h</a>.</p> | ||
113 | </div><hr/><h2>Constructor & Destructor Documentation</h2> | ||
114 | <a class="anchor" id="a02175cc96f2121b3ea231938be21e4bc"></a><!-- doxytag: member="irr::scene::ISceneUserDataSerializer::~ISceneUserDataSerializer" ref="a02175cc96f2121b3ea231938be21e4bc" args="()" --> | ||
115 | <div class="memitem"> | ||
116 | <div class="memproto"> | ||
117 | <table class="memname"> | ||
118 | <tr> | ||
119 | <td class="memname">virtual irr::scene::ISceneUserDataSerializer::~ISceneUserDataSerializer </td> | ||
120 | <td>(</td> | ||
121 | <td class="paramname"></td><td>)</td> | ||
122 | <td><code> [inline, virtual]</code></td> | ||
123 | </tr> | ||
124 | </table> | ||
125 | </div> | ||
126 | <div class="memdoc"> | ||
127 | |||
128 | <p>Definition at line <a class="el" href="_i_scene_user_data_serializer_8h_source.html#l00028">28</a> of file <a class="el" href="_i_scene_user_data_serializer_8h_source.html">ISceneUserDataSerializer.h</a>.</p> | ||
129 | |||
130 | </div> | ||
131 | </div> | ||
132 | <hr/><h2>Member Function Documentation</h2> | ||
133 | <a class="anchor" id="a8d276882257602ffc03a23a38290ea44"></a><!-- doxytag: member="irr::scene::ISceneUserDataSerializer::createUserData" ref="a8d276882257602ffc03a23a38290ea44" args="(ISceneNode *forSceneNode)=0" --> | ||
134 | <div class="memitem"> | ||
135 | <div class="memproto"> | ||
136 | <table class="memname"> | ||
137 | <tr> | ||
138 | <td class="memname">virtual <a class="el" href="classirr_1_1io_1_1_i_attributes.html">io::IAttributes</a>* irr::scene::ISceneUserDataSerializer::createUserData </td> | ||
139 | <td>(</td> | ||
140 | <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> * </td> | ||
141 | <td class="paramname"><em>forSceneNode</em></td><td>)</td> | ||
142 | <td><code> [pure virtual]</code></td> | ||
143 | </tr> | ||
144 | </table> | ||
145 | </div> | ||
146 | <div class="memdoc"> | ||
147 | |||
148 | <p>Called when the scene manager is writing a scene node to an xml file for example. </p> | ||
149 | <p>Implement this method and return a list of attributes containing the user data you want to be saved together with the scene node. Return 0 if no user data should be added. Please note that the scene manager will call drop() to the returned pointer after it no longer needs it, so if you didn't create a new object for the return value and returning a longer existing IAttributes object, simply call grab() before returning it. </p> | ||
150 | |||
151 | </div> | ||
152 | </div> | ||
153 | <a class="anchor" id="af025f0c9ee60be56d91f34bc9ab15115"></a><!-- doxytag: member="irr::scene::ISceneUserDataSerializer::OnCreateNode" ref="af025f0c9ee60be56d91f34bc9ab15115" args="(ISceneNode *node)=0" --> | ||
154 | <div class="memitem"> | ||
155 | <div class="memproto"> | ||
156 | <table class="memname"> | ||
157 | <tr> | ||
158 | <td class="memname">virtual void irr::scene::ISceneUserDataSerializer::OnCreateNode </td> | ||
159 | <td>(</td> | ||
160 | <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> * </td> | ||
161 | <td class="paramname"><em>node</em></td><td>)</td> | ||
162 | <td><code> [pure virtual]</code></td> | ||
163 | </tr> | ||
164 | </table> | ||
165 | </div> | ||
166 | <div class="memdoc"> | ||
167 | |||
168 | <p>Called when the scene manager create a scene node while loading a file. </p> | ||
169 | |||
170 | </div> | ||
171 | </div> | ||
172 | <a class="anchor" id="a48276bde0e05343d39ec25c6933f122d"></a><!-- doxytag: member="irr::scene::ISceneUserDataSerializer::OnReadUserData" ref="a48276bde0e05343d39ec25c6933f122d" args="(ISceneNode *forSceneNode, io::IAttributes *userData)=0" --> | ||
173 | <div class="memitem"> | ||
174 | <div class="memproto"> | ||
175 | <table class="memname"> | ||
176 | <tr> | ||
177 | <td class="memname">virtual void irr::scene::ISceneUserDataSerializer::OnReadUserData </td> | ||
178 | <td>(</td> | ||
179 | <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> * </td> | ||
180 | <td class="paramname"><em>forSceneNode</em>, </td> | ||
181 | </tr> | ||
182 | <tr> | ||
183 | <td class="paramkey"></td> | ||
184 | <td></td> | ||
185 | <td class="paramtype"><a class="el" href="classirr_1_1io_1_1_i_attributes.html">io::IAttributes</a> * </td> | ||
186 | <td class="paramname"><em>userData</em> </td> | ||
187 | </tr> | ||
188 | <tr> | ||
189 | <td></td> | ||
190 | <td>)</td> | ||
191 | <td></td><td><code> [pure virtual]</code></td> | ||
192 | </tr> | ||
193 | </table> | ||
194 | </div> | ||
195 | <div class="memdoc"> | ||
196 | |||
197 | <p>Called when the scene manager read a scene node while loading a file. </p> | ||
198 | <p>The userData pointer contains a list of attributes with userData which were attached to the scene node in the read scene file. </p> | ||
199 | |||
200 | </div> | ||
201 | </div> | ||
202 | <hr/>The documentation for this class was generated from the following file:<ul> | ||
203 | <li><a class="el" href="_i_scene_user_data_serializer_8h_source.html">ISceneUserDataSerializer.h</a></li> | ||
204 | </ul> | ||
205 | </div> | ||
206 | </div> | ||
207 | <div id="nav-path" class="navpath"> | ||
208 | <ul> | ||
209 | <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> | ||
210 | <li class="navelem"><a class="el" href="namespaceirr_1_1scene.html">scene</a> </li> | ||
211 | <li class="navelem"><a class="el" href="classirr_1_1scene_1_1_i_scene_user_data_serializer.html">ISceneUserDataSerializer</a> </li> | ||
212 | <!-- window showing the filter options --> | ||
213 | <div id="MSearchSelectWindow" | ||
214 | onmouseover="return searchBox.OnSearchSelectShow()" | ||
215 | onmouseout="return searchBox.OnSearchSelectHide()" | ||
216 | onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
217 | <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div> | ||
218 | |||
219 | <!-- iframe showing the search results (closed by default) --> | ||
220 | <div id="MSearchResultsWindow"> | ||
221 | <iframe src="javascript:void(0)" frameborder="0" | ||
222 | name="MSearchResults" id="MSearchResults"> | ||
223 | </iframe> | ||
224 | </div> | ||
225 | |||
226 | |||
227 | <li class="footer"> | ||
228 | <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht | ||
229 | Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Tue Nov 6 2012 11:06:07 for Irrlicht 3D Engine by | ||
230 | <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> | ||
231 | </ul> | ||
232 | </div> | ||
233 | |||
234 | |||
235 | </body> | ||
236 | </html> | ||