aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03939.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/a03939.html')
-rw-r--r--docs/doxygen/nel/a03939.html299
1 files changed, 299 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03939.html b/docs/doxygen/nel/a03939.html
new file mode 100644
index 00000000..b34f00b4
--- /dev/null
+++ b/docs/doxygen/nel/a03939.html
@@ -0,0 +1,299 @@
+<!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: NL3D::UPSSoundInstance struct 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NL3D::UPSSoundInstance Struct Reference</h1><code>#include &lt;<a class="el" href="a06623.html">u_ps_sound_interface.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NL3D::UPSSoundInstance:
+<p><center><img src="a03939.png" usemap="#NL3D::UPSSoundInstance_map" border="0" alt=""></center>
+<map name="NL3D::UPSSoundInstance_map">
+<area href="a03236.html" alt="NL3D::CPSSoundInstanceImpl" shape="rect" coords="0,56,180,80">
+</map>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+This is an interface between the particle system and a sound instance. When the system call 'release' on this interface , the sound must be detroyed. If a sound stop before relese is called, this interface must remains valid, however.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06623.html#l00069">69</a> of file <a class="el" href="a06623.html">u_ps_sound_interface.h</a>.<table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea0">getPitch</a> () const=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get pitch <a href="#NL3D_1_1UPSSoundInstancea0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea1">isPlaying</a> (void) const=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">tells wether the sound is playing <a href="#NL3D_1_1UPSSoundInstancea1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea2">play</a> (void)=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">start to play the sound <a href="#NL3D_1_1UPSSoundInstancea2"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea3">release</a> (void)=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">when this method is called, the sound is not needed anymore by the system <a href="#NL3D_1_1UPSSoundInstancea3"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea4">setLooping</a> (bool looping)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea5">setSoundParams</a> (float gain, const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;pos, const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;velocity, float frequency)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03939.html#NL3D_1_1UPSSoundInstancea6">stop</a> (void)=0</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stop the sound <a href="#NL3D_1_1UPSSoundInstancea6"></a><br><br></td></tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea0" doxytag="NL3D::UPSSoundInstance::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 NL3D::UPSSoundInstance::getPitch </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</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>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+get pitch
+<p>
+
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla1">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea1" doxytag="NL3D::UPSSoundInstance::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 NL3D::UPSSoundInstance::isPlaying </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</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>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+tells wether the sound is playing
+<p>
+
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla3">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea2" doxytag="NL3D::UPSSoundInstance::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 void NL3D::UPSSoundInstance::play </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+start to play the sound
+<p>
+
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla4">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea3" doxytag="NL3D::UPSSoundInstance::release" ></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 NL3D::UPSSoundInstance::release </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+when this method is called, the sound is not needed anymore by the system
+<p>
+
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla5">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea4" doxytag="NL3D::UPSSoundInstance::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 NL3D::UPSSoundInstance::setLooping </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">bool&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>looping</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla6">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea5" doxytag="NL3D::UPSSoundInstance::setSoundParams" ></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 NL3D::UPSSoundInstance::setSoundParams </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname" nowrap> <em>gain</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>pos</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>const <a class="el" href="a03128.html">NLMISC::CVector</a> &amp;&nbsp;</td>
+ <td class="mdname" nowrap> <em>velocity</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>float&nbsp;</td>
+ <td class="mdname" nowrap> <em>frequency</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</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>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The system will call this method to set the parameters of the sound Values are clamped
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla7">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1UPSSoundInstancea6" doxytag="NL3D::UPSSoundInstance::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 NL3D::UPSSoundInstance::stop </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">void&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+stop the sound
+<p>
+
+<p>
+Implemented in <a class="el" href="a03236.html#NL3D_1_1CPSSoundInstanceImpla8">NL3D::CPSSoundInstanceImpl</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="a06623.html">u_ps_sound_interface.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:48:53 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>