blob: 30636c9c959acf01d32345336d102d275184cbef (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>NeL: NLSOUND::CSoundSerializer class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"> <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NLSOUND::CSoundSerializer Class Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Pseudo serializer for packed sheet loading/saving. This class act as a wrapper to create sound from xml document being read, call the serialisation method to read/write packed sheet and to delete sounds that are no more needed.
<p>
<p>
Definition at line <a class="el" href="a06414.html#l00170">170</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializera0">CSoundSerializer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#NLSOUND_1_1CSoundSerializera0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializera1">readGeorges</a> (const <a class="el" href="a03408.html">NLMISC::CSmartPtr</a>< <a class="el" href="a03926.html">NLGEORGES::UForm</a> > &form, const std::string &name)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializera2">removed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializera3">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &<a class="el" href="a04223.html#a626">s</a>)</td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a15">uint</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializere0">getVersion</a> ()</td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02246.html">CSound</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The sound beeing managed by this serializer. <a href="#NLSOUND_1_1CSoundSerializero0"></a><br><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="NLSOUND_1_1CSoundSerializera0" doxytag="NLSOUND::CSoundSerializer::CSoundSerializer" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> NLSOUND::CSoundSerializer::CSoundSerializer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default constructor.
<p>
<p>
Definition at line <a class="el" href="a06414.html#l00177">177</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>.
<p>
<div class="fragment"><pre>00178 : <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a>(0)
00179 {}
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NLSOUND_1_1CSoundSerializere0" doxytag="NLSOUND::CSoundSerializer::getVersion" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="a04558.html#a15">uint</a> NLSOUND::CSoundSerializer::getVersion </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="a06414.html#l00269">269</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>.
<p>
References <a class="el" href="a05981.html#l00105">uint</a>.
<p>
<div class="fragment"><pre>00269 { <span class="keywordflow">return</span> 3; }
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1CSoundSerializera1" doxytag="NLSOUND::CSoundSerializer::readGeorges" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void NLSOUND::CSoundSerializer::readGeorges </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="a03408.html">NLMISC::CSmartPtr</a>< <a class="el" href="a03926.html">NLGEORGES::UForm</a> > & </td>
<td class="mdname" nowrap> <em>form</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const std::string & </td>
<td class="mdname" nowrap> <em>name</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="a06414.html#l00182">182</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>.
<p>
<div class="fragment"><pre>00183 {
00184 <span class="comment">// just call the sound creation method with the xml form.</span>
00185 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> = CSound::createSound(name, form->getRootNode());
00186
00187 <span class="comment">// success ?</span>
00188 <span class="comment">// if (_Sound != 0)</span>
00189 <span class="comment">// CSoundBank::instance()->addSound(_Sound);</span>
00190 }
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1CSoundSerializera2" doxytag="NLSOUND::CSoundSerializer::removed" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void NLSOUND::CSoundSerializer::removed </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
called by <a class="el" href="a04503.html#a6">GEORGE::loadForm</a> when a sheet read from the packed sheet is no more in the directories.
<p>
Definition at line <a class="el" href="a06414.html#l00258">258</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>.
<p>
<div class="fragment"><pre>00259 {
00260 <span class="keywordflow">if</span> (<a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> != 0)
00261 {
00262 <span class="comment">// we remove the sound from the bank and delete it.</span>
00263 <span class="comment">// CSoundBank::instance()->removeSound(_Sound->getName());</span>
00264 <span class="keyword">delete</span> <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a>;
00265 }
00266 }
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1CSoundSerializera3" doxytag="NLSOUND::CSoundSerializer::serial" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void NLSOUND::CSoundSerializer::serial </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>s</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="a06414.html#l00193">193</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>.
<p>
References <a class="el" href="a02246.html#NLSOUND_1_1CSounda12">NLSOUND::CSound::getSoundType()</a>, <a class="el" href="a05646.html#l00977">s</a>, <a class="el" href="a06406.html#l00114">NLSOUND::CSound::serial()</a>, <a class="el" href="a05646.html#l00244">type</a>, and <a class="el" href="a05981.html#l00100">uint32</a>.
<p>
<div class="fragment"><pre>00194 {
00195 NL_ALLOC_CONTEXT(NLSOUND_CSoundSerializer);
00196 <span class="keywordflow">if</span> (<a class="code" href="a04223.html#a626">s</a>.isReading())
00197 {
00198 <span class="comment">// read the first item to find the type</span>
00199 CSound::TSOUND_TYPE <a class="code" href="a04223.html#a581">type</a>;
00200 <a class="code" href="a04223.html#a626">s</a>.serialEnum(type);
00201 <span class="comment">// read the sound name</span>
00202 <span class="comment">// std::string name;</span>
00203 <span class="comment">// s.serial(name);</span>
00204
00205 <span class="comment">// Instantiate the corresponding sound.</span>
00206 <span class="keywordflow">switch</span>(CSound::TSOUND_TYPE(type))
00207 {
00208 <span class="keywordflow">case</span> CSound::SOUND_SIMPLE:
00209 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> = <span class="keyword">new</span> CSimpleSound();
00210 <span class="keywordflow">break</span>;
00211 <span class="keywordflow">case</span> CSound::SOUND_COMPLEX:
00212 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> = <span class="keyword">new</span> CComplexSound();
00213 <span class="keywordflow">break</span>;
00214 <span class="keywordflow">case</span> CSound::SOUND_CONTEXT:
00215 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> = <span class="keyword">new</span> CContextSound();
00216 <span class="keywordflow">break</span>;
00217 <span class="keywordflow">case</span> CSound::SOUND_BACKGROUND:
00218 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> = <span class="keyword">new</span> CBackgroundSound();
00219 <span class="keywordflow">break</span>;
00220 <span class="keywordflow">default</span>:
00221 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> = 0;
00222 }
00223
00224 <span class="comment">// nlassert(_Sound != 0);</span>
00225 <span class="keywordflow">if</span> (<a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a>)
00226 {
00227 <span class="comment">// read the sound data</span>
00228 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a>->serial(s);
00229 <span class="comment">// CSoundBank::instance()->addSound(_Sound);</span>
00230 }
00231 }
00232 <span class="keywordflow">else</span>
00233 {
00234 <span class="keywordflow">if</span> (<a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a> == 0)
00235 {
00236 <span class="comment">// the sound doesn't exist</span>
00237 <a class="code" href="a04558.html#a11">uint32</a> i = -1;
00238 <a class="code" href="a04223.html#a626">s</a>.serialEnum(i);
00239 <span class="comment">// s.serial(std::string("bad sound"));</span>
00240 }
00241 <span class="keywordflow">else</span>
00242 {
00243 <span class="comment">// write the sound type.</span>
00244 CSound::TSOUND_TYPE <a class="code" href="a04223.html#a581">type</a> = <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a>->getSoundType();
00245 <a class="code" href="a04223.html#a626">s</a>.serialEnum(type);
00246 <span class="comment">// write the sound name</span>
00247 <span class="comment">// s.serial(const_cast<std::string&>(_Sound->getName()));</span>
00248
00249 <span class="comment">// and write the sound data</span>
00250 <a class="code" href="a03426.html#NLSOUND_1_1CSoundSerializero0">Sound</a>->serial(s);
00251 }
00252 }
00253 }
</pre></div> </td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="NLSOUND_1_1CSoundSerializero0" doxytag="NLSOUND::CSoundSerializer::Sound" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="a02246.html">CSound</a>* <a class="el" href="a03426.html#NLSOUND_1_1CSoundSerializero0">NLSOUND::CSoundSerializer::Sound</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The sound beeing managed by this serializer.
<p>
<p>
Definition at line <a class="el" href="a06414.html#l00174">174</a> of file <a class="el" href="a06414.html">sound_bank.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a06414.html">sound_bank.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:45:41 2004 for NeL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.6 </small></address>
</body>
</html>
|
