diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1USource.html | 1003 |
1 files changed, 1003 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1USource.html b/docs/doxygen/nel/classNLSOUND_1_1USource.html new file mode 100644 index 00000000..1f0147f6 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1USource.html @@ -0,0 +1,1003 @@ +<!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>NLSOUND::USource Class Reference</h1>Game interface for sound sources (stereo or 3D sound instances). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="u__source_8h-source.html">u_source.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::USource: +<p><center><img src="classNLSOUND_1_1USource.gif" usemap="#NLSOUND::USource_map" border="0"></center> +<map name="NLSOUND::USource_map"> +<area href="classNLSOUND_1_1CSourceCommon.html" alt="NLSOUND::CSourceCommon" shape="rect" coords="206,56,402,80"> +<area href="classNLSOUND_1_1CBackgroundSource.html" alt="NLSOUND::CBackgroundSource" shape="rect" coords="0,112,196,136"> +<area href="classNLSOUND_1_1CComplexSource.html" alt="NLSOUND::CComplexSource" shape="rect" coords="206,112,402,136"> +<area href="classNLSOUND_1_1CSimpleSource.html" alt="NLSOUND::CSimpleSource" shape="rect" coords="412,112,608,136"> +</map> +<a href="classNLSOUND_1_1USource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#a0">getSound</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the sound binded to the source (or NULL if there is no sound).</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#a1">setPriority</a> (<a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> pr)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Change the priority of the source.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#a2">~USource</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Playback control</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_0">setLooping</a> (bool l)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set looping on/off for future playbacks (default: off).</em> <a href="#z364_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_1">getLooping</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the looping state.</em> <a href="#z364_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_2">play</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Play.</em> <a href="#z364_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_3">stop</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Stop playing.</em> <a href="#z364_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_4">isPlaying</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get playing state. Return false even if the source has stopped on its own.</em> <a href="#z364_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_5">unregisterSpawnCallBack</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Tells this source not to call its callbacks when it ends. This is valid for spawned sources only.</em> <a href="#z364_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z364_6">getTime</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the number of milliseconds the source has been playing.</em> <a href="#z364_6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Source properties</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_0">setPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the position vector (default: (0,0,0)).</em> <a href="#z365_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_1">getPos</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the position vector (3D mode only).</em> <a href="#z365_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_2">setVelocity</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)).</em> <a href="#z365_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_3">getVelocity</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the velocity vector.</em> <a href="#z365_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_4">setDirection</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional).</em> <a href="#z365_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_5">getDirection</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &dir) const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the direction vector.</em> <a href="#z365_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_6">setGain</a> (float gain)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain (volume value inside [0 , 1]).</em> <a href="#z365_6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_7">getGain</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the gain.</em> <a href="#z365_7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_8">setRelativeGain</a> (float gain)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain amount (value inside [0, 1]) to map between 0 and the nominal gain (which is getSource()-><a class="el" href="classNLSOUND_1_1USource.html#z365_7">getGain</a>()).</em> <a href="#z365_8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_9">getRelativeGain</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Return the relative gain (see <a class="el" href="classNLSOUND_1_1USource.html#z365_8">setRelativeGain</a>()), or the absolute gain if getSource() is null.</em> <a href="#z365_9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_10">setPitch</a> (float pitch)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Shift the frequency.</em> <a href="#z365_10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_11">getPitch</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the pitch.</em> <a href="#z365_11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_12">setSourceRelativeMode</a> (bool mode)=0</td></tr> +<tr><td> </td><td><font size=-1><em>Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false).</em> <a href="#z365_12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#z365_13">getSourceRelativeMode</a> () const=0</td></tr> +<tr><td> </td><td><font size=-1><em>Get the source relative mode.</em> <a href="#z365_13">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1USource.html#b0">USource</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Game interface for sound sources (stereo or 3D sound instances). +<p> +The mode is 3D if the sound buffer (specified by its Sound Id) is mono, otherwise it is stereo. +<p> +For arguments as 3D vectors, use the NeL vector coordinate system: <div class="fragment"><pre> + * (top) + * z + * | y (front) + * | / + * -----x (right) + * + * The default priority is MidPri. + * Some properties are assigned at initialization's time, from the + * specified sound id (use NeL Sources Sound Builder to set these + * initial values). + * + * </pre></div> <dl compact><dt><b> +Author: </b><dd> +Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="u__source_8h-source.html#l00103">103</a> of file <a class="el" href="u__source_8h-source.html">u_source.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a2" doxytag="NLSOUND::USource::~USource"></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"> virtual NLSOUND::USource::~USource </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="u__source_8h-source.html#l00180">180</a> of file <a class="el" href="u__source_8h-source.html">u_source.h</a>. </td> + </tr> +</table> +<a name="b0" doxytag="NLSOUND::USource::USource"></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"> NLSOUND::USource::USource </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="u__source_8h-source.html#l00185">185</a> of file <a class="el" href="u__source_8h-source.html">u_source.h</a>. +<p> +Referenced by <a class="el" href="complex__source_8cpp-source.html#l00096">NLSOUND::CComplexSource::play</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z365_5" doxytag="NLSOUND::USource::getDirection"></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"> virtual void NLSOUND::USource::getDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>dir</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the direction vector. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a21">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z365_7" doxytag="NLSOUND::USource::getGain"></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"> virtual float NLSOUND::USource::getGain </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the gain. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a22">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z364_1" doxytag="NLSOUND::USource::getLooping"></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"> virtual bool NLSOUND::USource::getLooping </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the looping state. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a6">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z365_11" doxytag="NLSOUND::USource::getPitch"></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"> virtual float NLSOUND::USource::getPitch </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the pitch. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a23">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z365_1" doxytag="NLSOUND::USource::getPos"></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"> virtual const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a>& NLSOUND::USource::getPos </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the position vector (3D mode only). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a11">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z365_9" doxytag="NLSOUND::USource::getRelativeGain"></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"> virtual float NLSOUND::USource::getRelativeGain </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the relative gain (see <a class="el" href="classNLSOUND_1_1USource.html#z365_8">setRelativeGain</a>()), or the absolute gain if getSource() is null. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a16">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NLSOUND::USource::getSound"></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"> virtual <a class="el" href="namespaceNLSOUND.html#a8">TSoundId</a> NLSOUND::USource::getSound </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the sound binded to the source (or NULL if there is no sound). +<p> +The source must be of the same type as the source (ie simple or complex or background sound). +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a3">NLSOUND::CBackgroundSource</a>. </td> + </tr> +</table> +<a name="z365_13" doxytag="NLSOUND::USource::getSourceRelativeMode"></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"> virtual bool NLSOUND::USource::getSourceRelativeMode </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the source relative mode. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a24">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z364_6" doxytag="NLSOUND::USource::getTime"></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"> virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::USource::getTime </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the number of milliseconds the source has been playing. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CComplexSource.html#z964_3">NLSOUND::CComplexSource</a>. </td> + </tr> +</table> +<a name="z365_3" doxytag="NLSOUND::USource::getVelocity"></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"> virtual void NLSOUND::USource::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the velocity vector. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a20">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z364_4" doxytag="NLSOUND::USource::isPlaying"></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"> virtual bool NLSOUND::USource::isPlaying </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get playing state. Return false even if the source has stopped on its own. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CComplexSource.html#z964_2">NLSOUND::CComplexSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00103">NL3D::CPSSoundInstanceImpl::isPlaying</a>. </td> + </tr> +</table> +<a name="z364_2" doxytag="NLSOUND::USource::play"></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"> virtual void NLSOUND::USource::play </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Play. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a4">NLSOUND::CBackgroundSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00095">NL3D::CPSSoundInstanceImpl::play</a>. </td> + </tr> +</table> +<a name="z365_4" doxytag="NLSOUND::USource::setDirection"></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"> virtual void NLSOUND::USource::setDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>dir</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a11">NLSOUND::CBackgroundSource</a>. </td> + </tr> +</table> +<a name="z365_6" doxytag="NLSOUND::USource::setGain"></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"> virtual void NLSOUND::USource::setGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>gain</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the gain (volume value inside [0 , 1]). +<p> +(default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a7">NLSOUND::CBackgroundSource</a>. </td> + </tr> +</table> +<a name="z364_0" doxytag="NLSOUND::USource::setLooping"></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"> virtual void NLSOUND::USource::setLooping </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>l</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set looping on/off for future playbacks (default: off). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSimpleSource.html#z982_0">NLSOUND::CSimpleSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00163">NL3D::CPSSoundServImpl::createSound</a>. </td> + </tr> +</table> +<a name="z365_10" doxytag="NLSOUND::USource::setPitch"></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"> virtual void NLSOUND::USource::setPitch </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>pitch</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Shift the frequency. +<p> +1.0f equals identity, each reduction of 50% equals a pitch shift of one octave. 0 is not a legal value. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSimpleSource.html#a9">NLSOUND::CSimpleSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams</a>. </td> + </tr> +</table> +<a name="z365_0" doxytag="NLSOUND::USource::setPos"></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"> virtual void NLSOUND::USource::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the position vector (default: (0,0,0)). +<p> +3D mode -> 3D position st mode -> x is the pan value (from left (-1) to right (1)), set y and z to 0 +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a9">NLSOUND::CBackgroundSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::USource::setPriority"></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"> virtual void NLSOUND::USource::setPriority </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a82">TSoundPriority</a> </td> + <td class="mdname1" valign="top" nowrap> <em>pr</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Change the priority of the source. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a3">NLSOUND::CSourceCommon</a>. </td> + </tr> +</table> +<a name="z365_8" doxytag="NLSOUND::USource::setRelativeGain"></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"> virtual void NLSOUND::USource::setRelativeGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>gain</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the gain amount (value inside [0, 1]) to map between 0 and the nominal gain (which is getSource()-><a class="el" href="classNLSOUND_1_1USource.html#z365_7">getGain</a>()). +<p> +Does nothing if getSource() is null. +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a8">NLSOUND::CBackgroundSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams</a>. </td> + </tr> +</table> +<a name="z365_12" doxytag="NLSOUND::USource::setSourceRelativeMode"></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"> virtual void NLSOUND::USource::setSourceRelativeMode </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>mode</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the source relative mode. If true, positions are interpreted relative to the listener position (default: false). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSimpleSource.html#a10">NLSOUND::CSimpleSource</a>. </td> + </tr> +</table> +<a name="z365_2" doxytag="NLSOUND::USource::setVelocity"></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"> virtual void NLSOUND::USource::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a10">NLSOUND::CBackgroundSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00076">NL3D::CPSSoundInstanceImpl::setSoundParams</a>. </td> + </tr> +</table> +<a name="z364_3" doxytag="NLSOUND::USource::stop"></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"> virtual void NLSOUND::USource::stop </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Stop playing. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CBackgroundSource.html#a5">NLSOUND::CBackgroundSource</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00111">NL3D::CPSSoundInstanceImpl::stop</a>. </td> + </tr> +</table> +<a name="z364_5" doxytag="NLSOUND::USource::unregisterSpawnCallBack"></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"> virtual void NLSOUND::USource::unregisterSpawnCallBack </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Tells this source not to call its callbacks when it ends. This is valid for spawned sources only. +<p> + +<p> +Implemented in <a class="el" href="classNLSOUND_1_1CSourceCommon.html#a19">NLSOUND::CSourceCommon</a>. +<p> +Referenced by <a class="el" href="u__ps__sound__impl_8h-source.html#l00201">NL3D::CPSSoundInstanceImpl::release</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="u__source_8h-source.html">u_source.h</a></ul> + + +<!-- 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> |