aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03237.html
blob: c4edbdbcc34ff7745c8c7852cbfb6fd38623e56f (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
<!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: NL3D::CPSSoundServImpl 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a>  | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NL3D::CPSSoundServImpl Class Reference</h1><code>#include &lt;<a class="el" href="a06622.html">u_ps_sound_impl.h</a>&gt;</code>
<p>
<p>Inheritance diagram for NL3D::CPSSoundServImpl:
<p><center><img src="a03237.png" usemap="#NL3D::CPSSoundServImpl_map" border="0" alt=""></center>
<map name="NL3D::CPSSoundServImpl_map">
<area href="a03940.html" alt="NL3D::UPSSoundServer" shape="rect" coords="0,0,160,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class implements PS sound server. It warps the calls to NEL sound. Everything is in a .h file to avoid dependency <dl compact><dt><b>Author:</b></dt><dd>Nicolas Vizerie <p>
Nevrax France </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>

<p>

<p>
Definition at line <a class="el" href="a06622.html#l00155">155</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla0">CPSSoundServImpl</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">construct this sound server; You must init it then  <a href="#NL3D_1_1CPSSoundServImpla0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03939.html">UPSSoundInstance</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla1">createSound</a> (const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &amp;soundName, bool spawned=true)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">inherited from IPSSoundServer  <a href="#NL3D_1_1CPSSoundServImpla1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla2">getAudioMixer</a> (void) const </td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla3">getAudioMixer</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the audio mixer associated with that server  <a href="#NL3D_1_1CPSSoundServImpla3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImpla4">init</a> (<a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> *audioMixer)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">init this particle system sound server, using the given audio mixer  <a href="#NL3D_1_1CPSSoundServImpla4"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a></td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="NL3D_1_1CPSSoundServImpla0" doxytag="NL3D::CPSSoundServImpl::CPSSoundServImpl" ></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"> NL3D::CPSSoundServImpl::CPSSoundServImpl </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
construct this sound server; You must init it then 
<p>

<p>
Definition at line <a class="el" href="a06622.html#l00159">159</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.
<p>
References <a class="el" href="a06622.html#l00203">_AudioMixer</a>.
<p>
<div class="fragment"><pre>00159                            : <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>(NULL)
00160         {
00161         }
</pre></div>    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NL3D_1_1CPSSoundServImpla1" doxytag="NL3D::CPSSoundServImpl::createSound" ></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="a03939.html">UPSSoundInstance</a>* NL3D::CPSSoundServImpl::createSound </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>soundName</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>spawned</em> = true</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
inherited from IPSSoundServer 
<p>

<p>
Implements <a class="el" href="a03940.html#NL3D_1_1UPSSoundServera0">NL3D::UPSSoundServer</a>.
<p>
Definition at line <a class="el" href="a06622.html#l00178">178</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.
<p>
References <a class="el" href="a06622.html#l00203">_AudioMixer</a>, <a class="el" href="a02236.html#NLSOUND_1_1UAudioMixera1">NLSOUND::UAudioMixer::createSource()</a>, <a class="el" href="a06622.html#l00066">NL3D::CPSSoundInstanceImpl::init()</a>, <a class="el" href="a03429.html#NLSOUND_1_1USourcez2137_4">NLSOUND::USource::setLooping()</a>, and <a class="el" href="a06622.html#l00209">NL3D::SpawnedSourceEndedCallback()</a>.
<p>
<div class="fragment"><pre>00179         {               
00180                 <span class="keywordflow">if</span> (!<a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>) 
00181                         <span class="keywordflow">return</span> NULL;
00182                 CPSSoundInstanceImpl *sound = <span class="keyword">new</span> CPSSoundInstanceImpl;
00183                 <a class="code" href="a03429.html">NLSOUND::USource</a> *source = <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>-&gt;<a class="code" href="a02236.html#NLSOUND_1_1UAudioMixera1">createSource</a>(soundName, spawned, SpawnedSourceEndedCallback, sound );
00184                 <span class="keywordflow">if</span> (source)
00185                 {                       
00186                         <span class="keywordflow">if</span> (spawned)
00187                         {
00188                                 source-&gt;<a class="code" href="a03429.html#NLSOUND_1_1USourcez2137_4">setLooping</a>(<span class="keyword">false</span>);
00189                         }
00190                         sound-&gt;init(source, <span class="keyword">this</span>, spawned);
00191                         <span class="keywordflow">return</span> sound;
00192                 }
00193                 <span class="keywordflow">else</span>
00194                 {
00195                         <span class="comment">// should usually not happen</span>
00196                         <span class="keyword">delete</span> sound;
00197                         <span class="keywordflow">return</span> NULL;
00198                 }
00199         }
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSSoundServImpla2" doxytag="NL3D::CPSSoundServImpl::getAudioMixer" ></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"> const <a class="el" href="a02236.html">NLSOUND::UAudioMixer</a>* NL3D::CPSSoundServImpl::getAudioMixer </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="a06622.html#l00174">174</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.
<p>
References <a class="el" href="a06622.html#l00203">_AudioMixer</a>.
<p>
<div class="fragment"><pre>00174 { <span class="keywordflow">return</span> <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>;}
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSSoundServImpla3" doxytag="NL3D::CPSSoundServImpl::getAudioMixer" ></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="a02236.html">NLSOUND::UAudioMixer</a>* NL3D::CPSSoundServImpl::getAudioMixer </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
get the audio mixer associated with that server 
<p>

<p>
Definition at line <a class="el" href="a06622.html#l00173">173</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.
<p>
References <a class="el" href="a06622.html#l00203">_AudioMixer</a>.
<p>
Referenced by <a class="el" href="a06622.html#l00217">NL3D::CPSSoundInstanceImpl::release()</a>.
<p>
<div class="fragment"><pre>00173 { <span class="keywordflow">return</span> <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a>;}
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1CPSSoundServImpla4" doxytag="NL3D::CPSSoundServImpl::init" ></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 NL3D::CPSSoundServImpl::init </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a02236.html">NLSOUND::UAudioMixer</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>audioMixer</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
init this particle system sound server, using the given audio mixer 
<p>

<p>
Definition at line <a class="el" href="a06622.html#l00166">166</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.
<p>
References <a class="el" href="a06622.html#l00203">_AudioMixer</a>.
<p>
Referenced by <a class="el" href="a06617.html#l00063">NL3D::UParticleSystemSound::setPSSound()</a>.
<p>
<div class="fragment"><pre>00167         {               
00168                 <a class="code" href="a03237.html#NL3D_1_1CPSSoundServImplp0">_AudioMixer</a> = audioMixer;
00169         }
</pre></div>    </td>
  </tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="NL3D_1_1CPSSoundServImplp0" doxytag="NL3D::CPSSoundServImpl::_AudioMixer" ></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="a02236.html">NLSOUND::UAudioMixer</a>* <a class="el" href="a03237.html#NL3D_1_1CPSSoundServImplp0">NL3D::CPSSoundServImpl::_AudioMixer</a><code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="a06622.html#l00203">203</a> of file <a class="el" href="a06622.html">u_ps_sound_impl.h</a>.
<p>
Referenced by <a class="el" href="a06622.html#l00159">CPSSoundServImpl()</a>, <a class="el" href="a06622.html#l00178">createSound()</a>, <a class="el" href="a06622.html#l00173">getAudioMixer()</a>, and <a class="el" href="a06622.html#l00166">init()</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a06622.html">u_ps_sound_impl.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:25:53 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>