diff options
Diffstat (limited to 'docs/doxygen/nel/a03428.html')
| -rw-r--r-- | docs/doxygen/nel/a03428.html | 1347 |
1 files changed, 1347 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03428.html b/docs/doxygen/nel/a03428.html new file mode 100644 index 00000000..b74ad92e --- /dev/null +++ b/docs/doxygen/nel/a03428.html @@ -0,0 +1,1347 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLSOUND::ISource class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLSOUND::ISource Class Reference</h1><code>#include <<a class="el" href="a06424.html">source.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::ISource: +<p><center><img src="a03428.png" usemap="#NLSOUND::ISource_map" border="0" alt=""></center> +<map name="NLSOUND::ISource_map"> +<area href="a03427.html" alt="NLSOUND::CSourceAL" shape="rect" coords="0,56,173,80"> +<area href="a03430.html" alt="NLSOUND::CSourceDSound" shape="rect" coords="183,56,356,80"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Sound source interface (implemented in sound driver dynamic library)<p> +<ul> +<li>If the buffer is mono, the source is played in 3D mode. For arguments as 3D vectors, use the NeL vector coordinate system: <pre class="fragment"><div> + * (top) + * z + * | y (front) + * | / + * -----x (right) + * </div></pre></li></ul> +<p> +<ul> +<li>If the buffer is stereo, the source is played in stereo mode.</li></ul> +<p> +<dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06424.html#l00059">59</a> of file <a class="el" href="a06424.html">source.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Source properties</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_0">getCone</a> (float &innerAngle, float &outerAngle, float &outerGain) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the cone angles (in radian). <a href="#NLSOUND_1_1ISourcez1334_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_1">getDirection</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &dir) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the direction vector. <a href="#NLSOUND_1_1ISourcez1334_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_2">getGain</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the gain. <a href="#NLSOUND_1_1ISourcez1334_2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_3">getMinMaxDistances</a> (float &mindist, float &maxdist) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the min and max distances. <a href="#NLSOUND_1_1ISourcez1334_3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_4">getPitch</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the pitch. <a href="#NLSOUND_1_1ISourcez1334_4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_5">getPos</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_6">getSourceRelativeMode</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the source relative mode. <a href="#NLSOUND_1_1ISourcez1334_6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_7">getVelocity</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &vel) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the velocity vector. <a href="#NLSOUND_1_1ISourcez1334_7"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_8">setAlpha</a> (double a)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Testing. <a href="#NLSOUND_1_1ISourcez1334_8"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_9">setCone</a> (float innerAngle, float outerAngle, float outerGain)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the cone angles (in radian) and gain (in [0 , 1]) (default: 2PI, 2PI, 0). <a href="#NLSOUND_1_1ISourcez1334_9"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_10">setDirection</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &dir)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the direction vector (3D mode only, ignored in stereo mode) (default: (0,0,0) as non-directional). <a href="#NLSOUND_1_1ISourcez1334_10"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_11">setEAXProperty</a> (<a class="el" href="a04558.html#a15">uint</a> prop, void *<a class="el" href="a04223.html#a658">value</a>, <a class="el" href="a04558.html#a15">uint</a> valuesize)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set any EAX source property if EAX available. <a href="#NLSOUND_1_1ISourcez1334_11"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_12">setGain</a> (float gain)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_13">setMinMaxDistances</a> (float mindist, float maxdist, bool deferred=true)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the min and max distances (default: 1, MAX_FLOAT) (3D mode only). <a href="#NLSOUND_1_1ISourcez1334_13"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_14">setPitch</a> (float pitch)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_15">setPos</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos, bool deffered=true)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_16">setSourceRelativeMode</a> (bool mode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the source relative mode. If true, positions are interpreted relative to the listener position. <a href="#NLSOUND_1_1ISourcez1334_16"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_17">setVelocity</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &vel, bool deferred=true)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). <a href="#NLSOUND_1_1ISourcez1334_17"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Playback control</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_0">getLooping</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the looping state. <a href="#NLSOUND_1_1ISourcez1332_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_1">getTime</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of milliseconds the source has been playing. <a href="#NLSOUND_1_1ISourcez1332_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_2">isPlaying</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the playing state. <a href="#NLSOUND_1_1ISourcez1332_2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_3">isStopped</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if playing is finished or <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_7">stop()</a> has been called. <a href="#NLSOUND_1_1ISourcez1332_3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_4">pause</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pause. Call <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_5">play()</a> to resume. <a href="#NLSOUND_1_1ISourcez1332_4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_5">play</a> ()=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_6">setLooping</a> (bool l)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set looping on/off for future playbacks (default: off). <a href="#NLSOUND_1_1ISourcez1332_6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_7">stop</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop playing. <a href="#NLSOUND_1_1ISourcez1332_7"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_8">update</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the source (e.g. continue to stream the data in). <a href="#NLSOUND_1_1ISourcez1332_8"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Initialization</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a02298.html">IBuffer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1330_0">getStaticBuffer</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the buffer, or NULL if streaming is used. <a href="#NLSOUND_1_1ISourcez1330_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1330_1">setStaticBuffer</a> (<a class="el" href="a02298.html">IBuffer</a> *<a class="el" href="a04223.html#a589">buffer</a>)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcez1330_2">setStreamLoader</a> (<a class="el" href="a03862.html">ILoader</a> *loader)</td></tr> + +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcea0">ISource</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1ISourcea0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcea1">~ISource</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1ISourcea1"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03862.html">ILoader</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a03428.html#NLSOUND_1_1ISourcep0">_Loader</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1ISourcea0" doxytag="NLSOUND::ISource::ISource" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::ISource::ISource </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]</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="a06424.html#l00159">159</a> of file <a class="el" href="a06424.html">source.h</a>. +<p> +References <a class="el" href="a06424.html#l00170">_Loader</a>. +<p> +<div class="fragment"><pre>00159 : <span class="comment">/*_Buffer(NULL),*/</span> <a class="code" href="a03428.html#NLSOUND_1_1ISourcep0">_Loader</a>(NULL) {} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcea1" doxytag="NLSOUND::ISource::~ISource" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLSOUND::ISource::~<a class="el" href="a03428.html">ISource</a> </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="a06424.html#l00162">162</a> of file <a class="el" href="a06424.html">source.h</a>. +<p> +References <a class="el" href="a06424.html#l00170">_Loader</a>. +<p> +<div class="fragment"><pre>00162 { <span class="comment">/*_Buffer=NULL;*/</span> <a class="code" href="a03428.html#NLSOUND_1_1ISourcep0">_Loader</a>=NULL; } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_0" doxytag="NLSOUND::ISource::getCone" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::getCone </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float & </td> + <td class="mdname" nowrap> <em>innerAngle</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>outerAngle</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>outerGain</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> 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 cone angles (in radian). +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_0">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_0">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_1" doxytag="NLSOUND::ISource::getDirection" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::getDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03128.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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_1">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_1">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_2" doxytag="NLSOUND::ISource::getGain" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLSOUND::ISource::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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_2">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_2">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_0" doxytag="NLSOUND::ISource::getLooping" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::ISource::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="a03430.html#NLSOUND_1_1CSourceDSoundz1312_0">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_0">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_3" doxytag="NLSOUND::ISource::getMinMaxDistances" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::getMinMaxDistances </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float & </td> + <td class="mdname" nowrap> <em>mindist</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float & </td> + <td class="mdname" nowrap> <em>maxdist</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> 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 min and max distances. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_3">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_3">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_4" doxytag="NLSOUND::ISource::getPitch" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLSOUND::ISource::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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_4">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_4">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_5" doxytag="NLSOUND::ISource::getPos" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual const <a class="el" href="a03128.html">NLMISC::CVector</a>& NLSOUND::ISource::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. See <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1334_15">setPos()</a> for details. +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_5">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_5">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_6" doxytag="NLSOUND::ISource::getSourceRelativeMode" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::ISource::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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_6">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_6">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1330_0" doxytag="NLSOUND::ISource::getStaticBuffer" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a02298.html">IBuffer</a>* NLSOUND::ISource::getStaticBuffer </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 buffer, or NULL if streaming is used. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1310_0">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALa1">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_1" doxytag="NLSOUND::ISource::getTime" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="a04558.html#a11">uint32</a> NLSOUND::ISource::getTime </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </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> +Returns the number of milliseconds the source has been playing. +<p> + +<p> +Reimplemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1312_1">NLSOUND::CSourceDSound</a>. +<p> +Definition at line <a class="el" href="a06424.html#l00101">101</a> of file <a class="el" href="a06424.html">source.h</a>. +<p> +References <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00071">NLSOUND::CSimpleSource::getTime()</a>. +<p> +<div class="fragment"><pre>00101 { <span class="keywordflow">return</span> 0; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_7" doxytag="NLSOUND::ISource::getVelocity" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03128.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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_7">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_7">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_2" doxytag="NLSOUND::ISource::isPlaying" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::ISource::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> 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 playing state. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1312_3">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_1">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06037.html#l00063">NLSOUND::CTrack::isPlaying()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_3" doxytag="NLSOUND::ISource::isStopped" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::ISource::isStopped </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 true if playing is finished or <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_7">stop()</a> has been called. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1312_4">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_2">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06037.html#l00061">NLSOUND::CTrack::isAvailable()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_4" doxytag="NLSOUND::ISource::pause" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::pause </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> +Pause. Call <a class="el" href="a03428.html#NLSOUND_1_1ISourcez1332_5">play()</a> to resume. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1312_5">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_3">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_5" doxytag="NLSOUND::ISource::play" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::ISource::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 the static buffer (or stream in and play). This method can return false if the sample for this sound is unloaded. +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1312_6">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_4">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_8" doxytag="NLSOUND::ISource::setAlpha" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setAlpha </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">double </td> + <td class="mdname1" valign="top" nowrap> <em>a</em> </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> +Testing. +<p> + +<p> +Reimplemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSounda4">NLSOUND::CSourceDSound</a>. +<p> +Definition at line <a class="el" href="a06424.html#l00154">154</a> of file <a class="el" href="a06424.html">source.h</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>. +<p> +<div class="fragment"><pre>00154 { } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_9" doxytag="NLSOUND::ISource::setCone" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setCone </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>innerAngle</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>outerAngle</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>outerGain</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the cone angles (in radian) and gain (in [0 , 1]) (default: 2PI, 2PI, 0). +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_8">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_8">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00290">NLSOUND::CSimpleSource::setDirection()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_10" doxytag="NLSOUND::ISource::setDirection" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setDirection </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_9">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_9">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00290">NLSOUND::CSimpleSource::setDirection()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_11" doxytag="NLSOUND::ISource::setEAXProperty" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setEAXProperty </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>prop</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a04558.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>valuesize</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set any EAX source property if EAX available. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_10">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_10">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_12" doxytag="NLSOUND::ISource::setGain" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::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]). (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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_11">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_11">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, <a class="el" href="a06390.html#l00326">NLSOUND::CSimpleSource::setGain()</a>, and <a class="el" href="a06390.html#l00337">NLSOUND::CSimpleSource::setRelativeGain()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_6" doxytag="NLSOUND::ISource::setLooping" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::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="a03430.html#NLSOUND_1_1CSourceDSoundz1312_7">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_5">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, and <a class="el" href="a06390.html#l00093">NLSOUND::CSimpleSource::setLooping()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_13" doxytag="NLSOUND::ISource::setMinMaxDistances" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setMinMaxDistances </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>mindist</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>maxdist</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>deferred</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the min and max distances (default: 1, MAX_FLOAT) (3D mode only). +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_12">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_12">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_14" doxytag="NLSOUND::ISource::setPitch" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::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. 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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_13">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_13">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, and <a class="el" href="a06390.html#l00352">NLSOUND::CSimpleSource::setPitch()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_15" doxytag="NLSOUND::ISource::setPos" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>deffered</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><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)). 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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_14">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_14">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, and <a class="el" href="a06390.html#l00258">NLSOUND::CSimpleSource::setPos()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_16" doxytag="NLSOUND::ISource::setSourceRelativeMode" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::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. +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1314_15">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_15">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, and <a class="el" href="a06390.html#l00367">NLSOUND::CSimpleSource::setSourceRelativeMode()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1330_1" doxytag="NLSOUND::ISource::setStaticBuffer" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setStaticBuffer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02298.html">IBuffer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>buffer</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 buffer that will be played (no streaming) If the buffer is stereo, the source mode becomes stereo and the source relative mode is on, otherwise the source is considered as a 3D source. +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1310_1">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1324_0">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, and <a class="el" href="a06390.html#l00217">NLSOUND::CSimpleSource::stop()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1330_2" doxytag="NLSOUND::ISource::setStreamLoader" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setStreamLoader </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03862.html">ILoader</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>loader</em> </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> +Set the sound loader that will be used to stream in the data to play If the buffer is stereo, the source mode becomes stereo and the source relative mode is on, otherwise the source is considered as a 3D source. +<p> +Definition at line <a class="el" href="a06424.html#l00076">76</a> of file <a class="el" href="a06424.html">source.h</a>. +<p> +References <a class="el" href="a06424.html#l00170">_Loader</a>. +<p> +<div class="fragment"><pre>00076 { <a class="code" href="a03428.html#NLSOUND_1_1ISourcep0">_Loader</a> = loader; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1334_17" doxytag="NLSOUND::ISource::setVelocity" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>vel</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>bool </td> + <td class="mdname" nowrap> <em>deferred</em> = true</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><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="a03430.html#NLSOUND_1_1CSourceDSoundz1314_16">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1328_16">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00126">NLSOUND::CSimpleSource::play()</a>, and <a class="el" href="a06390.html#l00274">NLSOUND::CSimpleSource::setVelocity()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_7" doxytag="NLSOUND::ISource::stop" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::ISource::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="a03430.html#NLSOUND_1_1CSourceDSoundz1312_8">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_6">NLSOUND::CSourceAL</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00217">NLSOUND::CSimpleSource::stop()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1ISourcez1332_8" doxytag="NLSOUND::ISource::update" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::ISource::update </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> +Update the source (e.g. continue to stream the data in). +<p> + +<p> +Implemented in <a class="el" href="a03430.html#NLSOUND_1_1CSourceDSoundz1312_9">NLSOUND::CSourceDSound</a>, and <a class="el" href="a03427.html#NLSOUND_1_1CSourceALz1326_7">NLSOUND::CSourceAL</a>. </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLSOUND_1_1ISourcep0" doxytag="NLSOUND::ISource::_Loader" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03862.html">ILoader</a>* <a class="el" href="a03428.html#NLSOUND_1_1ISourcep0">NLSOUND::ISource::_Loader</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06424.html#l00170">170</a> of file <a class="el" href="a06424.html">source.h</a>. +<p> +Referenced by <a class="el" href="a06424.html#l00159">ISource()</a>, <a class="el" href="a06424.html#l00076">setStreamLoader()</a>, and <a class="el" href="a06424.html#l00162">~ISource()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06424.html">source.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:52:19 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |