File: namespaceosgAL.html

package info (click to toggle)
osgal-cvs 20060903-3
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 3,836 kB
  • ctags: 424
  • sloc: sh: 8,806; cpp: 1,815; makefile: 86
file content (298 lines) | stat: -rw-r--r-- 12,872 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>osgAL Namespace Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.15 -->
<center>
<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>osgAL Namespace Reference</h1>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1FilePathContainer.html">FilePathContainer</a></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1OccludeCallback.html">OccludeCallback</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class to calculate occlusion between the listener and the soundsource.</em> <a href="classosgAL_1_1OccludeCallback.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1SoundManager.html">SoundManager</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A <a class="el" href="classosgAL_1_1SoundManager.html">SoundManager</a> handles the sound system.</em> <a href="classosgAL_1_1SoundManager.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1SoundManager_1_1SoundStateFlyWeight.html">SoundStateFlyWeight</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class that handles all the soundstates. See FlyWeight Design pattern.</em> <a href="classosgAL_1_1SoundManager_1_1SoundStateFlyWeight.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1SoundManager_1_1SoundStateQueueItem.html">SoundStateQueueItem</a></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1SoundNode.html">SoundNode</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A placeholder for a soundstate. The transformation is updated automatically during update traversal.</em> <a href="classosgAL_1_1SoundNode.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1SoundRoot.html">SoundRoot</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A node that updates the transformation of the listener. Should traversed before any <a class="el" href="classosgAL_1_1SoundNode.html">SoundNode</a> nodes.</em> <a href="classosgAL_1_1SoundRoot.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classosgAL_1_1SoundState.html">SoundState</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class that encapsulate the settings valid for a soundsource.</em> <a href="classosgAL_1_1SoundState.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>template&lt;typename T&gt; T const&nbsp;</td><td valign=bottom><a class="el" href="namespaceosgAL.html#a0">mix</a> (T const &amp;a, T const &amp;b, float s)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Lineary interpolate from a to b using s = {0,..1}.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>template&lt;typename T&gt; T const &amp;&nbsp;</td><td valign=bottom><a class="el" href="namespaceosgAL.html#a1">min</a> (T const &amp;a, T const &amp;b)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the smallest item of a and b.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>template&lt;typename T&gt; T const &amp;&nbsp;</td><td valign=bottom><a class="el" href="namespaceosgAL.html#a2">max</a> (T const &amp;a, T const &amp;b)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the greatest item of a and b.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>template&lt;typename T&gt; T const &amp;&nbsp;</td><td valign=bottom><a class="el" href="namespaceosgAL.html#a3">clamp</a> (T const &amp;x, T const &amp;min, T const &amp;max)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the greatest item of a and b.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>OSGAL_EXPORT std::string&nbsp;</td><td valign=bottom><a class="el" href="namespaceosgAL.html#a4">getVersion</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSGAL_EXPORT std::string&nbsp;</td><td valign=bottom><a class="el" href="namespaceosgAL.html#a5">getLibraryName</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
OsgAL - OpenSceneGraph Audio Library Copyright (C) 2004 VRlab, Ume University
<p>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
<p>
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
<p>
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
<p>
<hr><h2>Function Documentation</h2>
<a name="a3" doxytag="osgAL::clamp"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template&lt;typename T&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top"> T const&amp; clamp </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>min</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>max</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

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

<p>
Return the greatest item of a and b.
<p>
    </td>
  </tr>
</table>
<a name="a5" doxytag="osgAL::getLibraryName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> OSGAL_EXPORT std::string getLibraryName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

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

<p>
    </td>
  </tr>
</table>
<a name="a4" doxytag="osgAL::getVersion"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> OSGAL_EXPORT std::string getVersion </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

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

<p>
    </td>
  </tr>
</table>
<a name="a2" doxytag="osgAL::max"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template&lt;typename T&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top"> T const&amp; max </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>b</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

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

<p>
Return the greatest item of a and b.
<p>
    </td>
  </tr>
</table>
<a name="a1" doxytag="osgAL::min"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template&lt;typename T&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top"> T const&amp; min </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>b</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

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

<p>
Return the smallest item of a and b.
<p>
    </td>
  </tr>
</table>
<a name="a0" doxytag="osgAL::mix"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template&lt;typename T&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top"> T const mix </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>a</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>T const &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>b</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>float&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>s</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

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

<p>
Lineary interpolate from a to b using s = {0,..1}.
<p>
    </td>
  </tr>
</table>
<hr><address align="right"><small>Generated on Mon Nov 22 09:27:17 2004 for OpenSceneGraphAudioLibrary(OsgAL) by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>