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
|
<!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> <A CLASS=uplinks HREF=><b>Home</B></FONT></A> </TD>
<TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=><b>nevrax.com</B></FONT></A> </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>
<!-- 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> </td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.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">Compound List</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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> </center>
<hr><h1>env_sound_user.h</h1><a href="env__sound__user_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_ENV_SOUND_USER_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_ENV_SOUND_USER_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="u__env__sound_8h.html">nel/sound/u_env_sound.h</a>"</font>
00031 <font class="preprocessor">#include "<a class="code" href="source__user_8h.html">source_user.h</a>"</font>
00032 <font class="preprocessor">#include <vector></font>
00033
00034
00035 <font class="keyword">namespace </font>NLSOUND {
00036
00037
00038 <font class="keyword">class </font>CListenerUser;
00039 <font class="keyword">class </font>IPlayable;
00040 <font class="keyword">class </font>IBoundingShape;
00041
00042
00043 <font class="comment">// Number of environment channels</font>
<a name="l00044"></a><a class="code" href="env__sound__user_8h.html#a0">00044</a> <font class="preprocessor">#define MAX_ENV_CHANNELS 3</font>
<a name="l00045"></a><a class="code" href="env__sound__user_8h.html#a1">00045</a> <font class="preprocessor"></font><font class="preprocessor">#define AMBIANT_CH1 0</font>
<a name="l00046"></a><a class="code" href="env__sound__user_8h.html#a2">00046</a> <font class="preprocessor"></font><font class="preprocessor">#define AMBIANT_CH2 1</font>
<a name="l00047"></a><a class="code" href="env__sound__user_8h.html#a3">00047</a> <font class="preprocessor"></font><font class="preprocessor">#define SPARSE_CH 2</font>
00048 <font class="preprocessor"></font>
00049
<a name="l00082"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html">00082</a> <font class="keyword">class </font>CEnvSoundUser : <font class="keyword">public</font> UEnvSound
00083 {
00084 <font class="keyword">public</font>:
00085
00087 <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a0">CEnvSoundUser</a>();
00088
00090 <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a1">~CEnvSoundUser</a>();
00091
00092
00094 <font class="comment">//void serial( NLMISC::IStream& s );</font>
00096 <font class="comment"> //static void serialFileHeader( NLMISC::IStream& s );</font>
00098 <font class="comment"> //static uint32 load( CEnvSoundUser* &envSoundTreeRoot, NLMISC::IStream& s );</font>
00099
00100
00102 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a2">getPos</a>( <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& pos ) <font class="keyword">const</font>;
00104 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a3">setPos</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& pos );
00106 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a4">selectEnv</a>( <font class="keyword">const</font> <font class="keywordtype">char</font> *tag, <font class="keywordtype">bool</font> children_too=<font class="keyword">false</font> ) ;
00108 <font class="keyword">virtual</font> std::vector<UEnvSound*>& <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a5">getChildren</a>();
00109
00110
00112 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a6">recompute</a>();
00114 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a7">update</a>();
00115
00116
00118 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a8">play</a>( <font class="keywordtype">bool</font> children_too=<font class="keyword">false</font> );
00120 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a9">stop</a>( <font class="keywordtype">bool</font> children_too=<font class="keyword">false</font> );
<a name="l00122"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a10">00122</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a10">mustPlay</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o0">_Play</a>; }
00123
00124
00126 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a11">setProperties</a>( <font class="keywordtype">bool</font> transition, IBoundingShape *bshape );
00128 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a12">addChild</a>( <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a0">CEnvSoundUser</a> *child );
00132 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a13">addEnvTag</a>( IPlayable *source, <font class="keyword">const</font> std::string& tag=<font class="stringliteral">""</font> );
00134 <font class="comment">//static void save( CEnvSoundUser *envSoundTreeRoot, NLMISC::IStream& s );</font>
<a name="l00136"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a14">00136</a> <font class="comment"> IBoundingShape *getBoundingShape() { return _BoundingShape; }</font>
<a name="l00138"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a15">00138</a> <font class="comment"> IPlayable *getSource() { return _Source; }</font>
<a name="l00140"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a16">00140</a> <font class="comment"> CEnvSoundUser *getParent() { return _Parent; }</font>
00141
00142 <font class="keyword">protected</font>:
00143
00144 <font class="comment">// Return true if the envsound is a leaf in the hierarchy tree</font>
00145 <font class="comment">//bool isLeaf() const { return _Children.empty(); }</font>
00146
<a name="l00148"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b0">00148</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b0">isRoot</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o6">_Parent</a>==NULL; }
00149
00150 <font class="comment">// Enable/disable the source and set general gain if enabled, and reset the source mark (recursive)</font>
00151 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b1">applySourcesMarks</a>();
00152
00154 <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a0">CEnvSoundUser</a> *<a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b2">findCurrentEnv</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& listenerpos );
00155
00159 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b3">markSources</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& listenerpos, <font class="keywordtype">float</font> gain );
00160
00162 <a class="code" href="types__nl_8h.html#a10">uint32</a> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b4">getCount</a>() <font class="keyword">const</font>;
00163
00165 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b5">playSub</a>( <font class="keywordtype">bool</font> children_too=<font class="keyword">false</font> );
00166
00168 <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#b6">stopSub</a>( <font class="keywordtype">bool</font> children_too=<font class="keyword">false</font> );
00169
00170
00171 <font class="keyword">private</font>:
00172
00173 <font class="comment">// Must play or not</font>
<a name="l00174"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o0">00174</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o0">_Play</a>;
00175
00176 <font class="comment">// Current sound source (3D source or ambiant source) and all possible sources</font>
<a name="l00177"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o1">00177</a> IPlayable *<a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o1">_Source</a>;
<a name="l00178"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o2">00178</a> std::vector<IPlayable*> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o2">_SrcBank</a>;
<a name="l00179"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o3">00179</a> std::vector<std::string> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o3">_Tags</a>;
00180
00181 <font class="comment">// Area</font>
<a name="l00182"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o4">00182</a> IBoundingShape *<a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o4">_BoundingShape</a>;
00183
00184 <font class="comment">// Transition shape ?</font>
<a name="l00185"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o5">00185</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o5">_Transition</a>;
00186
00187 <font class="comment">// Hierarchy</font>
<a name="l00188"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o6">00188</a> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#a0">CEnvSoundUser</a> *<a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o6">_Parent</a>;
<a name="l00189"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o7">00189</a> std::vector<CEnvSoundUser*> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o7">_Children</a>;
00190
00191 <font class="comment">// Playing preparation</font>
<a name="l00192"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o8">00192</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o8">_Mark</a>;
<a name="l00193"></a><a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o9">00193</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CEnvSoundUser.html#o9">_Gain</a>;
00194
00195 };
00196
00197
00198 } <font class="comment">// NLSOUND</font>
00199
00200
00201 <font class="preprocessor">#endif // NL_ENV_SOUND_USER_H</font>
00202 <font class="preprocessor"></font>
00203 <font class="comment">/* End of env_sound_user.h */</font>
</pre></div>
<!-- footer -->
<BR><FONT Size=+5> </FONT>
</TD>
<TD WIDTH=15><IMG SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
