aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/u__source_8h-source.html
blob: 45333377b55508c06a4e4f2518101bdb2b9187a9 (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
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
	<TITLE>nevrax.org : docs</TITLE>
	<LINK REL=stylesheet TYPE="text/css" HREF="/inc/css/nevrax.css">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
</HEAD>
<BODY MARGINHEIGHT="0" MARGINWIDTH="0">

<!-- uplinks -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0>
 <TR>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=140 BGCOLOR=#dddddd><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF='/'><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
        <TD><IMG  width=6 height=14  SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF='/'><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
 </TR>
</TABLE> 

<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 WIDTH=100%>
 <TR><TD  BGCOLOR="#000000" BACKGROUND="/inc/img/black_banner.jpg"><A HREF=""><IMG  SRC="/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
</TABLE>

<!-- main table -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 height=100%>
 <TR>
	<TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
	<TD WIDTH=140   BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

		<!------ Begin Box ------>
		<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0  cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
		<FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td  colspan=2 bgcolor=#FFFFFF>
		<TABLE cellspacing=0 cellpadding=1 border=0>
			<tr><td ALIGN=middle><a  class='linkbox' href="/news/" TITLE="Rubrique news"><img width=13 height=15  hspace=5 border=0 src=/inc/img/picto-news.gif ALT=#></A></td><td><a  class='linkbox' href="/news/" TITLE="News">News</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/mail/" TITLE="Rubrique mail"><img width=15 height=11  hspace=5 border=0 src=/inc/img/picto-mail.gif ALT=#></A></td><td><a  class='linkbox' href="/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/docs/" TITLE="Rubrique docs"><img width=14 height=16  hspace=5 border=0 src=/inc/img/picto-docs.gif ALT=#></A></td><td><a  class='linkbox' href="/docs/" TITLE="Documentation">Documentation</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/cvs/" TITLE="Rubrique cvs"><img width=13 height=17  hspace=5 border=0 src=/inc/img/picto-cvs.gif ALT=#></A></td><td><a  class='linkbox' href="/cvs/" TITLE="CVS Web">CVS</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/bugs/" TITLE="Rubrique bugs"><img width=20 height=16  hspace=5 border=0 src=/inc/img/picto-bugs.gif ALT=#></A></td><td><a  class='linkbox' href="/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/GPL.php3" TITLE="Rubrique license"><img  width=18 height=12   hspace=5 border=0 src=/inc/img/picto-gpl.gif ALT=#></A></td><td><a  class='linkbox' href="/GPL.php3" TITLE="License">License</a></td></tr>
		</TABLE>
		</TD></TR></TABLE></TD></TR></TABLE>
		<!------ End Box  ------>

	</TD>
	<TD WIDTH=15><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
	<TD ALIGN=left valign=top><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

<!-- title -->
<TABLE  background="/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td>
<A HREF="/docs/"><img src="/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG  SRC="/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
&nbsp;

<!-- block -->
<TABLE  bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="/inc/img/reddots.gif"></TD>
	<TD><B>Documentation</B></TD>
	<TD ALIGN=RIGHT>&nbsp;</td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</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; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
<hr><h1>u_source.h</h1><a href="u__source_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 
00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font>
00008 <font class="comment"> *</font>
00009 <font class="comment"> * This file is part of NEVRAX NEL.</font>
00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font>
00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font>
00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font>
00013 <font class="comment"> * any later version.</font>
00014 <font class="comment"></font>
00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font>
00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
00018 <font class="comment"> * General Public License for more details.</font>
00019 <font class="comment"></font>
00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font>
00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font>
00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font>
00023 <font class="comment"> * MA 02111-1307, USA.</font>
00024 <font class="comment"> */</font>
00025 
00026 <font class="preprocessor">#ifndef NL_U_SOURCE_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_U_SOURCE_H</font>
00028 <font class="preprocessor"></font>
00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font>
00030 <font class="preprocessor">#include "<a class="code" href="vector_8h.html">nel/misc/vector.h</a>"</font>
00031 
00032 <font class="keyword">namespace </font>NLMISC {
00033 
00034 <font class="keyword">class </font>CVector;
00035 
00036 }
00037 
00038 
00039 <font class="keyword">namespace </font>NLSOUND {
00040 
00041 
00042 <font class="keyword">static</font> <font class="keyword">const</font> uint <a class="code" href="namespaceNLSOUND.html#a7">SoundContextNbArgs</a> = 10;
00043 
<a name="l00044"></a><a class="code" href="structNLSOUND_1_1CSoundContext.html">00044</a> <font class="keyword">struct </font>CSoundContext
00045 {
00046         <font class="comment">// -1 for args is a special value means that unset. Don't use negative number</font>
00047         
<a name="l00048"></a><a class="code" href="structNLSOUND_1_1CSoundContext.html#a0">00048</a>         <a class="code" href="structNLSOUND_1_1CSoundContext.html#a0">CSoundContext</a>() 
00049         :       <a class="code" href="structNLSOUND_1_1CSoundContext.html#m1">Position</a>(NLMISC::CVector::Null), 
00050                 <a class="code" href="structNLSOUND_1_1CSoundContext.html#m3">PreviousRandom</a>(100),
00051                 <a class="code" href="structNLSOUND_1_1CSoundContext.html#m0">RelativeGain</a>(1.0f)
00052         {
00053                 <font class="keywordflow">for</font> (uint i = 0; i &lt; <a class="code" href="namespaceNLSOUND.html#a7">SoundContextNbArgs</a>; i++)
00054                         <a class="code" href="structNLSOUND_1_1CSoundContext.html#m2">Args</a>[i] = -1;
00055         }
00056 
<a name="l00057"></a><a class="code" href="structNLSOUND_1_1CSoundContext.html#m0">00057</a>         <font class="keywordtype">float</font>                   <a class="code" href="structNLSOUND_1_1CSoundContext.html#m0">RelativeGain</a>;
<a name="l00058"></a><a class="code" href="structNLSOUND_1_1CSoundContext.html#m1">00058</a>         <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> <a class="code" href="structNLSOUND_1_1CSoundContext.html#m1">Position</a>;
<a name="l00059"></a><a class="code" href="structNLSOUND_1_1CSoundContext.html#m2">00059</a>         sint32                  <a class="code" href="structNLSOUND_1_1CSoundContext.html#m2">Args</a>[<a class="code" href="namespaceNLSOUND.html#a7">SoundContextNbArgs</a>];
<a name="l00060"></a><a class="code" href="structNLSOUND_1_1CSoundContext.html#m3">00060</a>         uint32                  <a class="code" href="structNLSOUND_1_1CSoundContext.html#m3">PreviousRandom</a>;
00061 };
00062 
00063 
00064 <font class="keyword">class </font>CSound;
00065 <font class="keyword">class </font>USource;
00066 
00067 
00069 <font class="keyword">typedef</font> CSound* <a class="code" href="namespaceNLSOUND.html#a8">TSoundId</a>;
00070 
00072 <font class="keyword">enum</font> <a class="code" href="namespaceNLSOUND.html#a82">TSoundPriority</a> { <a class="code" href="namespaceNLSOUND.html#a82a10">HighestPri</a>, <a class="code" href="namespaceNLSOUND.html#a82a11">HighPri</a>, <a class="code" href="namespaceNLSOUND.html#a82a12">MidPri</a>, <a class="code" href="namespaceNLSOUND.html#a82a13">LowPri</a>, <a class="code" href="namespaceNLSOUND.html#a82a14">NbSoundPriorities</a>};
00073 <font class="comment">//const uint NbSoundPriorities = 4;</font>
00074 
00076 <font class="keyword">typedef</font> <a class="code" href="driver__opengl__extension__def_8h.html#a424">void</a> (*<a class="code" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a>) (USource *, <font class="keywordtype">void</font> *);
00077 
00078 
<a name="l00103"></a><a class="code" href="classNLSOUND_1_1USource.html">00103</a> <font class="keyword">class </font>USource
00104 {
00105 <font class="keyword">public</font>:
00106 
00110 <font class="comment">//      virtual void                                    setSound( TSoundId id, CSoundContext *context = 0) = 0;</font>
00112 <font class="comment">        virtual TSoundId                                getSound() = 0;</font>
00114 <font class="comment">        virtual void                                    setPriority( TSoundPriority pr) = 0;</font>
00115 
00117 
00118 
00119         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z364_0">setLooping</a>( <font class="keywordtype">bool</font> <a class="code" href="namespaceNLAISCRIPT.html#a20">l</a> ) = 0;
00121         <font class="keyword">virtual</font> <font class="keywordtype">bool</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z364_1">getLooping</a>() <font class="keyword">const</font> = 0;
00123         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z364_2">play</a>() = 0;
00125         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z364_3">stop</a>() = 0;
00127         <font class="keyword">virtual</font> <font class="keywordtype">bool</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z364_4">isPlaying</a>() = 0;
00129         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z364_5">unregisterSpawnCallBack</a>() = 0;
00131         <font class="keyword">virtual</font> uint32                                  <a class="code" href="classNLSOUND_1_1USource.html#z364_6">getTime</a>() =0;
00133 
00134         
00136 
00137 
00141         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_0">setPos</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>&amp; pos ) = 0;
00143         <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>   &amp;<a class="code" href="classNLSOUND_1_1USource.html#z365_1">getPos</a>() <font class="keyword">const</font> = 0;
00145         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_2">setVelocity</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>&amp; vel ) = 0;
00147         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_3">getVelocity</a>( <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>&amp; vel ) <font class="keyword">const</font> = 0;
00149         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_4">setDirection</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>&amp; dir ) = 0;
00151         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_5">getDirection</a>( <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>&amp; dir ) <font class="keyword">const</font> = 0;
00158         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_6">setGain</a>( <font class="keywordtype">float</font> gain ) = 0;
00160         <font class="keyword">virtual</font> <font class="keywordtype">float</font>                                   <a class="code" href="classNLSOUND_1_1USource.html#z365_7">getGain</a>() <font class="keyword">const</font> = 0;
00164         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_8">setRelativeGain</a>( <font class="keywordtype">float</font> gain ) = 0;
00166         <font class="keyword">virtual</font> <font class="keywordtype">float</font>                                   <a class="code" href="classNLSOUND_1_1USource.html#z365_9">getRelativeGain</a>() <font class="keyword">const</font> = 0;
00170         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_10">setPitch</a>( <font class="keywordtype">float</font> pitch ) = 0;
00172         <font class="keyword">virtual</font> <font class="keywordtype">float</font>                                   <a class="code" href="classNLSOUND_1_1USource.html#z365_11">getPitch</a>() <font class="keyword">const</font> = 0;
00174         <font class="keyword">virtual</font> <font class="keywordtype">void</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_12">setSourceRelativeMode</a>( <font class="keywordtype">bool</font> mode ) = 0;
00176         <font class="keyword">virtual</font> <font class="keywordtype">bool</font>                                    <a class="code" href="classNLSOUND_1_1USource.html#z365_13">getSourceRelativeMode</a>() <font class="keyword">const</font> = 0;
00178 
<a name="l00180"></a><a class="code" href="classNLSOUND_1_1USource.html#a2">00180</a>         <font class="keyword">virtual</font>                                                 <a class="code" href="classNLSOUND_1_1USource.html#a2">~USource</a>() {}
00181         
00182 <font class="keyword">protected</font>:
00183 
<a name="l00185"></a><a class="code" href="classNLSOUND_1_1USource.html#b0">00185</a>         <a class="code" href="classNLSOUND_1_1USource.html#b0">USource</a>() {}
00186 
00187 };
00188 
00189 
00190 } <font class="comment">// NLSOUND</font>
00191 
00192 
00193 <font class="preprocessor">#endif // NL_U_SOURCE_H</font>
00194 <font class="preprocessor"></font>
00195 <font class="comment">/* End of u_source.h */</font>
</pre></div>

<!-- footer -->
<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
</TD>
<TD WIDTH=15><IMG  SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>