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
|
<!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>simple_source.h</h1><a href="simple__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_SIMPLE_SOURCE_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_SIMPLE_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 <font class="preprocessor">#include "<a class="code" href="time__nl_8h.html">nel/misc/time_nl.h</a>"</font>
00032 <font class="comment">//#include "playable.h"</font>
00033 <font class="preprocessor">#include "<a class="code" href="source__common_8h.html">source_common.h</a>"</font>
00034 <font class="preprocessor">#include "<a class="code" href="simple__sound_8h.html">simple_sound.h</a>"</font>
00035
00036
00037 <font class="keyword">namespace </font>NLSOUND {
00038
00039
00040 <font class="keyword">class </font>ISource;
00041 <font class="keyword">class </font>CTrack;
00042 <font class="keyword">class </font>CSimpleSound;
00043
00044
<a name="l00051"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html">00051</a> <font class="keyword">class </font>CSimpleSource : <font class="keyword">public</font> CSourceCommon, <font class="keyword">public</font> CAudioMixerUser::IMixerEvent <font class="comment">//, public IPlayable</font>
00052 {
00053 <font class="keyword">public</font>:
00054
00056 <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a0">CSimpleSource</a>( CSimpleSound *simpleSound=NULL, <font class="keywordtype">bool</font> spawn=<font class="keyword">false</font>, <a class="code" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb=0, <font class="keywordtype">void</font> *cbUserParam = 0);
00058 <font class="keyword">virtual</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a1">~CSimpleSource</a>();
00059
00060 <font class="comment">/* </font>
00061 <font class="comment"> static void init() </font>
00062 <font class="comment"> { </font>
00063 <font class="comment"> //NLMISC_REGISTER_CLASS(CSimpleSource); </font>
00064 <font class="comment"> }</font>
00065 <font class="comment">*/</font>
00066
<a name="l00068"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#a2">00068</a> <font class="keyword">virtual</font> <a class="code" href="namespaceNLSOUND.html#a8">TSoundId</a> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a2">getSound</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#o0">_Sound</a>; }
00070 CSimpleSound *<a class="code" href="classNLSOUND_1_1CSimpleSource.html#a3">getSimpleSound</a>();
00071
00073
00074
00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_0">setLooping</a>( <font class="keywordtype">bool</font> <a class="code" href="namespaceNLAISCRIPT.html#a20">l</a> );
00077 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_1">play</a>();
00079 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_2">stop</a>();
00081 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_3">isPlaying</a>();
<a name="l00083"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_4">00083</a> <font class="keyword">virtual</font> NLMISC::TTicks <a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_4">getPlayTime</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLMISC_1_1CTime.html#d1">NLMISC::CTime::getLocalTime</a>() - <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n10">_PlayStart</a>; }
00085 <font class="keyword">virtual</font> uint32 <a class="code" href="classNLSOUND_1_1CSimpleSource.html#z982_5">getTime</a>();
00087
00088
00090
00091
00095 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a4">setPos</a>( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& pos );
00099 <font class="comment">// virtual void getPos( NLMISC::CVector& pos ) const;</font>
00101 <font class="comment"> virtual void setVelocity( const NLMISC::CVector& vel );</font>
00103 <font class="comment"> virtual void setDirection( const NLMISC::CVector& dir );</font>
00110 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a7">setGain</a>( <font class="keywordtype">float</font> gain );
00114 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a8">setRelativeGain</a>( <font class="keywordtype">float</font> gain );
00118 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a9">setPitch</a>( <font class="keywordtype">float</font> pitch );
00120 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a10">setSourceRelativeMode</a>( <font class="keywordtype">bool</font> mode );
00121
00122
<a name="l00124"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#a11">00124</a> CTrack *<a class="code" href="classNLSOUND_1_1CSimpleSource.html#a11">getTrack</a>() { <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#o2">_Track</a>; }
<a name="l00126"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#a12">00126</a> <a class="code" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#a12">getSpawnEndCallback</a>()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n13">_SpawnEndCb</a>; }
00127
00128 <font class="comment">//NLMISC_DECLARE_CLASS(CSimpleSource);</font>
00129
00130 <font class="keyword">virtual</font> IBuffer *<a class="code" href="classNLSOUND_1_1CSimpleSource.html#a13">getBuffer</a>();
00131
00132 <font class="keyword">private</font>:
00133 <font class="comment">// Mixer event call when doing muted play</font>
00134 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#c0">onEvent</a>();
00135
<a name="l00136"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#c1">00136</a> <a class="code" href="classNLSOUND_1_1CSourceCommon.html#s3">TSOURCE_TYPE</a> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#c1">getType</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSourceCommon.html#s3s0">SOURCE_SIMPLE</a>;}
00137
00138 <font class="comment">// The simple sound of this source.</font>
<a name="l00139"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#o0">00139</a> CSimpleSound *<a class="code" href="classNLSOUND_1_1CSimpleSource.html#o0">_Sound</a>;
00140
00141 <font class="comment">// The volume falloff factor.</font>
<a name="l00142"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#o1">00142</a> <font class="keywordtype">float</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#o1">_Alpha</a>;
00143
00144 <font class="comment">// Corresponding track (if selected for playing)</font>
<a name="l00145"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#o2">00145</a> CTrack *<a class="code" href="classNLSOUND_1_1CSimpleSource.html#o2">_Track</a>;
00146 <font class="comment">// True when the sound is played muted and until the mixer event notifying the end.</font>
<a name="l00147"></a><a class="code" href="classNLSOUND_1_1CSimpleSource.html#o3">00147</a> <font class="keywordtype">bool</font> <a class="code" href="classNLSOUND_1_1CSimpleSource.html#o3">_PlayMuted</a>;
00148
00149 };
00150
00151
00152 } <font class="comment">// NLSOUND</font>
00153
00154
00155 <font class="preprocessor">#endif // NL_SIMPLE_SOURCE_H</font>
00156 <font class="preprocessor"></font>
00157 <font class="comment">/* End of source_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>
|
