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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
<!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::UEnvSound 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::UEnvSound Class Reference</h1><code>#include <<a class="el" href="a06600.html">u_env_sound.h</a>></code>
<p>
<p>Inheritance diagram for NLSOUND::UEnvSound:
<p><center><img src="a02458.png" usemap="#NLSOUND::UEnvSound_map" border="0" alt=""></center>
<map name="NLSOUND::UEnvSound_map">
<area href="a02457.html" alt="NLSOUND::CEnvSoundUser" shape="rect" coords="0,56,171,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Game interface for localized environment sounds <p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd></dd></dl>
An envsound object is a node of an envsound tree, the root of which is returned by UAudioMixer::loadEnvSounds(). The root is the world envsound: it has no bounds. The areas of children envsounds have bounds and they must be totally included in the area of their parent envsound.<p>
For arguments as 3D vectors, use the NeL vector coordinate system: <pre class="fragment"><div>
* (top)
* z
* | y (front)
* | /
* -----x (right)
* </div></pre><p>
An envsound source plays with the priority HighPri, and has the priority LowPri when not playing.<p>
<dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <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="a06600.html#l00079">79</a> of file <a class="el" href="a06600.html">u_env_sound.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>virtual std::vector< <a class="el" href="a02458.html">UEnvSound</a> * > & </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda0">getChildren</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the children envsounds. <a href="#NLSOUND_1_1UEnvSounda0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda1">getPos</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &pos) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the position. <a href="#NLSOUND_1_1UEnvSounda1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda2">play</a> (bool children_too=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Play this node, and all descendants if children_too is true. <a href="#NLSOUND_1_1UEnvSounda2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda3">selectEnv</a> (const char *tag, bool children_too=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select the current env for this node, and for all descendants if children_too is true. <a href="#NLSOUND_1_1UEnvSounda3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda4">setPos</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Moves the envsound (and its transition envsound if it has one). <a href="#NLSOUND_1_1UEnvSounda4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda5">stop</a> (bool children_too=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop playing this node, and all descendants if children_too is true. <a href="#NLSOUND_1_1UEnvSounda5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSounda6">~UEnvSound</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1UEnvSounda6"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a02458.html#NLSOUND_1_1UEnvSoundb0">UEnvSound</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1UEnvSoundb0"></a><br><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="NLSOUND_1_1UEnvSounda6" doxytag="NLSOUND::UEnvSound::~UEnvSound" ></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"> virtual NLSOUND::UEnvSound::~<a class="el" href="a02458.html">UEnvSound</a> </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, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
<p>
Definition at line <a class="el" href="a06600.html#l00100">100</a> of file <a class="el" href="a06600.html">u_env_sound.h</a>.
<p>
<div class="fragment"><pre>00100 {}
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1UEnvSoundb0" doxytag="NLSOUND::UEnvSound::UEnvSound" ></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::UEnvSound::UEnvSound </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, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
<p>
Definition at line <a class="el" href="a06600.html#l00105">105</a> of file <a class="el" href="a06600.html">u_env_sound.h</a>.
<p>
<div class="fragment"><pre>00105 {}
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NLSOUND_1_1UEnvSounda0" doxytag="NLSOUND::UEnvSound::getChildren" ></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"> virtual std::vector<<a class="el" href="a02458.html">UEnvSound</a>*>& NLSOUND::UEnvSound::getChildren </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the children envsounds.
<p>
<p>
Implemented in <a class="el" href="a02457.html#NLSOUND_1_1CEnvSoundUsera4">NLSOUND::CEnvSoundUser</a>. </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1UEnvSounda1" doxytag="NLSOUND::UEnvSound::getPos" ></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"> virtual void NLSOUND::UEnvSound::getPos </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a03128.html">NLMISC::CVector</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>pos</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the position.
<p>
</td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1UEnvSounda2" doxytag="NLSOUND::UEnvSound::play" ></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"> virtual void NLSOUND::UEnvSound::play </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>children_too</em> = false </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Play this node, and all descendants if children_too is true.
<p>
<p>
Implemented in <a class="el" href="a02457.html#NLSOUND_1_1CEnvSoundUsera10">NLSOUND::CEnvSoundUser</a>. </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1UEnvSounda3" doxytag="NLSOUND::UEnvSound::selectEnv" ></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"> virtual void NLSOUND::UEnvSound::selectEnv </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>children_too</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Select the current env for this node, and for all descendants if children_too is true.
<p>
<p>
Implemented in <a class="el" href="a02457.html#NLSOUND_1_1CEnvSoundUsera12">NLSOUND::CEnvSoundUser</a>. </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1UEnvSounda4" doxytag="NLSOUND::UEnvSound::setPos" ></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"> virtual void NLSOUND::UEnvSound::setPos </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>pos</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Moves the envsound (and its transition envsound if it has one).
<p>
<p>
Implemented in <a class="el" href="a02457.html#NLSOUND_1_1CEnvSoundUsera13">NLSOUND::CEnvSoundUser</a>. </td>
</tr>
</table>
<a class="anchor" name="NLSOUND_1_1UEnvSounda5" doxytag="NLSOUND::UEnvSound::stop" ></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"> virtual void NLSOUND::UEnvSound::stop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>children_too</em> = false </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Stop playing this node, and all descendants if children_too is true.
<p>
<p>
Implemented in <a class="el" href="a02457.html#NLSOUND_1_1CEnvSoundUsera15">NLSOUND::CEnvSoundUser</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a06600.html">u_env_sound.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:53:27 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>
|
