diff options
Diffstat (limited to 'docs/doxygen/nel/source__common_8cpp-source.html')
| -rw-r--r-- | docs/doxygen/nel/source__common_8cpp-source.html | 279 |
1 files changed, 279 insertions, 0 deletions
diff --git a/docs/doxygen/nel/source__common_8cpp-source.html b/docs/doxygen/nel/source__common_8cpp-source.html new file mode 100644 index 00000000..67d09d80 --- /dev/null +++ b/docs/doxygen/nel/source__common_8cpp-source.html @@ -0,0 +1,279 @@ +<!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="http://www.nevrax.org/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="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><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="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/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="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/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="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/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="http://www.nevrax.org/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:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>source_common.cpp</h1><a href="source__common_8cpp.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">#include "<a class="code" href="stdsound_8h.html">stdsound.h</a>"</font> +00027 +00028 <font class="preprocessor">#include "<a class="code" href="source__common_8h.html">source_common.h</a>"</font> +00029 +00030 +00031 <font class="keyword">using</font> <font class="keyword">namespace </font>NLMISC; +00032 +00033 <font class="keyword">namespace </font>NLSOUND +00034 { +00035 +<a name="l00036"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a0">00036</a> CSourceCommon::CSourceCommon(<a class="code" href="namespaceNLSOUND.html#a8">TSoundId</a> <a class="code" href="driver__opengl__extension__def_8h.html#a356">id</a>, <font class="keywordtype">bool</font> spawn, <a class="code" href="namespaceNLSOUND.html#a9">TSpawnEndCallback</a> cb, <font class="keywordtype">void</font> *cbUserParam) +00037 : _Priority(<a class="code" href="namespaceNLSOUND.html#a82a12">MidPri</a>), +00038 _Playing(false), +00039 _Looping(false), +00040 _Position(CVector::Null), +00041 _Velocity(CVector::Null), +00042 _Direction(CVector::Null), +00043 _Gain(1.0f), +00044 _InitialGain(1.0f), +00045 _Pitch(1.0f), +00046 _RelativeMode(false), +00047 _3DPosition(NULL), +00048 _PlayStart(0), +00049 _Spawn(spawn), +00050 _SpawnEndCb(cb), +00051 _CbUserParam(cbUserParam) +00052 { +00053 CAudioMixerUser::instance()->addSource(<font class="keyword">this</font>); +00054 } +00055 +<a name="l00056"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a1">00056</a> CSourceCommon::~CSourceCommon() +00057 { +00058 CAudioMixerUser::instance()->removeSource(<font class="keyword">this</font>); +00059 } +00060 +00061 +00062 <font class="comment">/*</font> +00063 <font class="comment"> * Change the priority of the source</font> +00064 <font class="comment"> */</font> +<a name="l00065"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a3">00065</a> <font class="keywordtype">void</font> CSourceCommon::setPriority( <a class="code" href="namespaceNLSOUND.html#a82">TSoundPriority</a> pr) +00066 { +00067 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n0">_Priority</a> = pr; +00068 +00069 <font class="comment">// The AudioMixer redispatches as necessary in the update() function [PH]</font> +00070 <font class="comment">// Redispatch the tracks if needed</font> +00071 <font class="comment">//if ( redispatch )</font> +00072 <font class="comment">//{</font> +00073 <font class="comment">// CAudioMixerUser::instance()->balanceSources();</font> +00074 <font class="comment">//}</font> +00075 } +00076 +00077 <font class="comment">/*</font> +00078 <font class="comment"> * Set looping on/off for future playbacks (default: off)</font> +00079 <font class="comment"> */</font> +<a name="l00080"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a5">00080</a> <font class="keywordtype">void</font> CSourceCommon::setLooping( <font class="keywordtype">bool</font> <a class="code" href="namespaceNLAISCRIPT.html#a20">l</a> ) +00081 { +00082 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n2">_Looping</a> = <a class="code" href="namespaceNLAISCRIPT.html#a20">l</a>; +00083 } +00084 +00085 <font class="comment">/*</font> +00086 <font class="comment"> * Return the looping state</font> +00087 <font class="comment"> */</font> +<a name="l00088"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a6">00088</a> <font class="keywordtype">bool</font> CSourceCommon::getLooping()<font class="keyword"> const</font> +00089 <font class="keyword"></font>{ +00090 <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n2">_Looping</a>; +00091 } +00092 +00093 <font class="comment">/*</font> +00094 <font class="comment"> * Play</font> +00095 <font class="comment"> */</font> +<a name="l00096"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a7">00096</a> <font class="keywordtype">void</font> CSourceCommon::play() +00097 { +00098 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n1">_Playing</a> = <font class="keyword">true</font>; +00099 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n10">_PlayStart</a> = CTime::getLocalTime(); +00100 } +00101 +00102 <font class="comment">/*</font> +00103 <font class="comment"> * Stop playing</font> +00104 <font class="comment"> */</font> +<a name="l00105"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a8">00105</a> <font class="keywordtype">void</font> CSourceCommon::stop() +00106 { +00107 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n1">_Playing</a> = <font class="keyword">false</font>; +00108 } +00109 +00110 <font class="comment">/* Set the position vector (default: (0,0,0)).</font> +00111 <font class="comment"> * 3D mode -> 3D position</font> +00112 <font class="comment"> * st mode -> x is the pan value (from left (-1) to right (1)), set y and z to 0</font> +00113 <font class="comment"> */</font> +<a name="l00114"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a10">00114</a> <font class="keywordtype">void</font> CSourceCommon::setPos( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& pos ) +00115 { +00116 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n3">_Position</a> = pos; +00117 } +00118 +00119 <font class="comment">/* Get the position vector.</font> +00120 <font class="comment"> * If the source is stereo, return the position vector which reference was passed to set3DPositionVector()</font> +00121 <font class="comment"> */</font> +<a name="l00122"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a11">00122</a> <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &CSourceCommon::getPos()<font class="keyword"> const</font> +00123 <font class="keyword"></font>{ +00124 <font class="keywordflow">if</font> ( <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n11">_3DPosition</a> == NULL ) +00125 { +00126 <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n3">_Position</a>; +00127 } +00128 <font class="keywordflow">else</font> +00129 { +00130 <font class="keywordflow">return</font> *<a class="code" href="classNLSOUND_1_1CSourceCommon.html#n11">_3DPosition</a>; +00131 } +00132 +00133 } +00134 +00135 <font class="comment">/* Shift the frequency. 1.0f equals identity, each reduction of 50% equals a pitch shift</font> +00136 <font class="comment"> * of one octave. 0 is not a legal value.</font> +00137 <font class="comment"> */</font> +<a name="l00138"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a27">00138</a> <font class="keywordtype">void</font> CSourceCommon::setPitch( <font class="keywordtype">float</font> pitch ) +00139 { +00140 <a class="code" href="debug_8h.html#a6">nlassert</a>( (pitch > 0) && (pitch <= 1.0f ) ); +00141 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n7">_Pitch</a> = pitch; +00142 } +00143 +00144 +00145 <font class="comment">/*</font> +00146 <font class="comment"> * Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0))</font> +00147 <font class="comment"> */</font> +<a name="l00148"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a12">00148</a> <font class="keywordtype">void</font> CSourceCommon::setVelocity( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& vel ) +00149 { +00150 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n4">_Velocity</a> = vel; +00151 } +00152 +00153 <font class="comment">/*</font> +00154 <font class="comment"> * Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional)</font> +00155 <font class="comment"> */</font> +<a name="l00156"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a13">00156</a> <font class="keywordtype">void</font> CSourceCommon::setDirection( <font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& dir ) +00157 { +00158 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n5">_Direction</a> = dir; +00159 } +00160 +00161 <font class="comment">/* Set the gain (volume value inside [0 , 1]). (default: 1)</font> +00162 <font class="comment"> * 0.0 -> silence</font> +00163 <font class="comment"> * 0.5 -> -6dB</font> +00164 <font class="comment"> * 1.0 -> no attenuation</font> +00165 <font class="comment"> * values > 1 (amplification) not supported by most drivers</font> +00166 <font class="comment"> */</font> +<a name="l00167"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a14">00167</a> <font class="keywordtype">void</font> CSourceCommon::setGain( <font class="keywordtype">float</font> gain ) +00168 { +00169 <a class="code" href="debug_8h.html#a6">nlassert</a>( (gain >= 0.0f) && (gain <= 1.0f ) ); +00170 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n9">_InitialGain</a> = <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n6">_Gain</a> = gain; +00171 } +00172 +00173 <font class="comment">/* Set the gain amount (value inside [0, 1]) to map between 0 and the nominal gain</font> +00174 <font class="comment"> * (which is getSource()->getGain()). Does nothing if getSource() is null.</font> +00175 <font class="comment"> */</font> +<a name="l00176"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a15">00176</a> <font class="keywordtype">void</font> CSourceCommon::setRelativeGain( <font class="keywordtype">float</font> gain ) +00177 { +00178 <a class="code" href="debug_8h.html#a6">nlassert</a>( (gain >= 0.0f) && (gain <= 1.0f ) ); +00179 +00180 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n6">_Gain</a> = <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n9">_InitialGain</a> * gain; +00181 } +00182 +00183 <font class="comment">/*</font> +00184 <font class="comment"> * Return the relative gain (see setRelativeGain()), or the absolute gain if getSource() is null.</font> +00185 <font class="comment"> */</font> +<a name="l00186"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a16">00186</a> <font class="keywordtype">float</font> CSourceCommon::getRelativeGain()<font class="keyword"> const</font> +00187 <font class="keyword"></font>{ +00188 <font class="keywordflow">if</font> (<a class="code" href="classNLSOUND_1_1CSourceCommon.html#n9">_InitialGain</a> == 0.0f) +00189 <font class="keywordflow">return</font> 0.0f; +00190 <font class="keywordflow">else</font> +00191 <font class="keywordflow">return</font> <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n6">_Gain</a> / <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n9">_InitialGain</a>; +00192 } +00193 +00194 <font class="comment">/*</font> +00195 <font class="comment"> * Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false)</font> +00196 <font class="comment"> */</font> +<a name="l00197"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a17">00197</a> <font class="keywordtype">void</font> CSourceCommon::setSourceRelativeMode( <font class="keywordtype">bool</font> mode ) +00198 { +00199 <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n8">_RelativeMode</a> = mode; +00200 } +00201 +00202 +<a name="l00203"></a><a class="code" href="classNLSOUND_1_1CSourceCommon.html#a28">00203</a> uint32 CSourceCommon::getTime() +00204 { +00205 <font class="comment">// default implementation</font> +00206 <font class="keywordflow">return</font> <a class="code" href="memory__common_8h.html#a11">uint32</a>(CTime::getLocalTime() - <a class="code" href="classNLSOUND_1_1CSourceCommon.html#n10">_PlayStart</a>); +00207 } +00208 +00209 +00210 } <font class="comment">// NLSOUND</font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |