diff options
| author | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
|---|---|---|
| committer | neodarz <neodarz@neodarz.net> | 2018-08-11 20:21:34 +0200 |
| commit | 0ea5fc66924303d1bf73ba283a383e2aadee02f2 (patch) | |
| tree | 2568e71a7ccc44ec23b8bb3f0ff97fb6bf2ed709 /docs/doxygen/nel/classNLSOUND_1_1CSimpleSound.html | |
| download | nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.tar.xz nevrax-website-self-hostable-0ea5fc66924303d1bf73ba283a383e2aadee02f2.zip | |
Initial commit
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CSimpleSound.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CSimpleSound.html | 885 |
1 files changed, 885 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSimpleSound.html b/docs/doxygen/nel/classNLSOUND_1_1CSimpleSound.html new file mode 100644 index 00000000..5774574c --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSimpleSound.html @@ -0,0 +1,885 @@ +<!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::CSimpleSound Class Reference</h1>A sound buffer and its static properties. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CSimpleSound: +<p><center><img src="classNLSOUND_1_1CSimpleSound.gif" usemap="#NLSOUND::CSimpleSound_map" border="0"></center> +<map name="NLSOUND::CSimpleSound_map"> +<area href="classNLSOUND_1_1CSound.html" alt="NLSOUND::CSound" shape="rect" coords="0,0,160,24"> +</map> +<a href="classNLSOUND_1_1CSimpleSound-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> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a0">CSimpleSound</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">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_1CSimpleSound.html#a1">~CSimpleSound</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a1">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_1CSimpleSound.html#a2">importForm</a> (const std::string &filename, <a class="el" href="classNLGEORGES_1_1UFormElm.html">NLGEORGES::UFormElm</a> &formRoot)</td></tr> +<tr><td> </td><td><font size=-1><em>Load the sound parameters from georges' form.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const std::string & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a3">getBuffername</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the name of the buffer, can be depend of a context.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a4">getBuffer</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the buffer and the buffername if not null.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a5">isDetailed</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return true if distance and cone are meaningful.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a6">getMinDistance</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the min distance (if detailed()).</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a7">getAlpha</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the alpha attenuation value.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a8">getDuration</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the length of the sound in ms.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const std::string & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a9">getFilename</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the filename.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const std::string & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a10">getBuffername</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Return the name of the buffer (must be unique).</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a11">setBuffer</a> (<a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> *<a class="el" href="driver__opengl__extension__def_8h.html#a381">buffer</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Change the buffer.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a12">getSubSoundList</a> (std::vector< std::pair< std::string, <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> * > > &subsounds) const</td></tr> +<tr><td> </td><td><font size=-1><em>Used by the george sound plugin to check sound recursion (ie sound 'toto' use sound 'titi' witch also use sound 'toto' ...).</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#a13">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &<a class="el" href="driver__opengl__extension__def_8h.html#a383">s</a>)</td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1CSound.html#s4">TSOUND_TYPE</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#c0">getSoundType</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Get the type of the sound.</em> <a href="#c0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o0">_Registered</a></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o1">_Buffer</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o2">_Detailed</a></td></tr> +<tr><td nowrap align=right valign=top>float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o3">_MinDist</a></td></tr> +<tr><td nowrap align=right valign=top>double </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o4">_Alpha</a></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o5">_NeedContext</a></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o6">_Filename</a></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSimpleSound.html#o7">_Buffername</a></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A sound buffer and its static properties. +<p> +<dl compact><dt><b> +Author: </b><dd> +Boris Boucher , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2002 </dl> +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00045">45</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CSimpleSound::CSimpleSound"></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::CSimpleSound::CSimpleSound </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></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="simple__sound_8cpp-source.html#l00045">45</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CSimpleSound::~CSimpleSound"></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::CSimpleSound::~CSimpleSound </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> [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="simple__sound_8cpp-source.html#l00058">58</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00097">_Buffer</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a7" doxytag="NLSOUND::CSimpleSound::getAlpha"></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"> float NLSOUND::CSimpleSound::getAlpha </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> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the alpha attenuation value. +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00070">70</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00102">_Alpha</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CSimpleSound::getBuffer"></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"> <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * NLSOUND::CSimpleSound::getBuffer </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the buffer and the buffername if not null. +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8cpp-source.html#l00094">94</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00097">_Buffer</a>, <a class="el" href="simple__sound_8h-source.html#l00109">_Buffername</a>, and <a class="el" href="simple__sound_8h-source.html#l00094">_Registered</a>. +<p> +Referenced by <a class="el" href="simple__sound_8cpp-source.html#l00110">getDuration</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CSimpleSound::getBuffername"></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"> const std::string& NLSOUND::CSimpleSound::getBuffername </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> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the name of the buffer (must be unique). +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00076">76</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00109">_Buffername</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CSimpleSound::getBuffername"></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"> const std::string& NLSOUND::CSimpleSound::getBuffername </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> +Return the name of the buffer, can be depend of a context. +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00062">62</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00109">_Buffername</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CSimpleSound::getDuration"></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"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::CSimpleSound::getDuration </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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the length of the sound in ms. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1CSound.html#a13">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="simple__sound_8cpp-source.html#l00110">110</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8cpp-source.html#l00094">getBuffer</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CSimpleSound::getFilename"></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"> const std::string& NLSOUND::CSimpleSound::getFilename </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> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the filename. +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00074">74</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00108">_Filename</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CSimpleSound::getMinDistance"></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"> float NLSOUND::CSimpleSound::getMinDistance </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> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the min distance (if detailed()). +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00068">68</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00101">_MinDist</a>. </td> + </tr> +</table> +<a name="c0" doxytag="NLSOUND::CSimpleSound::getSoundType"></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"> <a class="el" href="classNLSOUND_1_1CSound.html#s4">TSOUND_TYPE</a> NLSOUND::CSimpleSound::getSoundType </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, private, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the type of the sound. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1CSound.html#a2">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00089">89</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="classNLSOUND_1_1CSound.html#s4s0">NLSOUND::CSound::SOUND_SIMPLE</a>, and <a class="el" href="sound_8h-source.html#l00064">NLSOUND::CSound::TSOUND_TYPE</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CSimpleSound::getSubSoundList"></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"> void NLSOUND::CSimpleSound::getSubSoundList </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< std::pair< std::string, <a class="el" href="classNLSOUND_1_1CSound.html">CSound</a> * > > & </td> + <td class="mdname1" valign="top" nowrap> <em>subsounds</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap> const<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Used by the george sound plugin to check sound recursion (ie sound 'toto' use sound 'titi' witch also use sound 'toto' ...). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1CSound.html#a17">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="simple__sound_8cpp-source.html#l00082">82</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00109">_Buffername</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CSimpleSound::importForm"></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"> void NLSOUND::CSimpleSound::importForm </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>filename</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLGEORGES_1_1UFormElm.html">NLGEORGES::UFormElm</a> & </td> + <td class="mdname" nowrap> <em>formRoot</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load the sound parameters from georges' form. +<p> +an input serial or a load throws an exception <a class="el" href="classNLSOUND_1_1ESoundFileNotFound.html">ESoundFileNotFound</a>) +<p> +Reimplemented from <a class="el" href="classNLSOUND_1_1CSound.html#a3">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="simple__sound_8cpp-source.html#l00149">149</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00102">_Alpha</a>, <a class="el" href="simple__sound_8h-source.html#l00109">_Buffername</a>, <a class="el" href="simple__sound_8h-source.html#l00108">_Filename</a>, <a class="el" href="sound_8h-source.html#l00135">NLSOUND::CSound::_MaxDist</a>, <a class="el" href="simple__sound_8h-source.html#l00101">_MinDist</a>, <a class="el" href="simple__sound_8h-source.html#l00105">_NeedContext</a>, <a class="el" href="classNLGEORGES_1_1UFormElm.html#a42">NLGEORGES::UFormElm::getDfnName</a>, <a class="el" href="classNLGEORGES_1_1UFormElm.html#a0">NLGEORGES::UFormElm::getNodeByName</a>, <a class="el" href="classNLGEORGES_1_1UFormElm.html#a2">NLGEORGES::UFormElm::getValueByName</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00064">setBuffer</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CSimpleSound::isDetailed"></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"> bool NLSOUND::CSimpleSound::isDetailed </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> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if distance and cone are meaningful. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1CSound.html#a8">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="simple__sound_8h-source.html#l00066">66</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00100">_Detailed</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::CSimpleSound::serial"></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"> void NLSOUND::CSimpleSound::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>s</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Reimplemented from <a class="el" href="classNLSOUND_1_1CSound.html#a18">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="simple__sound_8cpp-source.html#l00125">125</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00102">_Alpha</a>, <a class="el" href="simple__sound_8h-source.html#l00109">_Buffername</a>, <a class="el" href="simple__sound_8h-source.html#l00101">_MinDist</a>, <a class="el" href="simple__sound_8h-source.html#l00105">_NeedContext</a>, <a class="el" href="stream__inline_8h-source.html#l00062">NLMISC::IStream::isReading</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00673">s</a>, <a class="el" href="stream_8h-source.html#l00222">NLMISC::IStream::serial</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00064">setBuffer</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CSimpleSound::setBuffer"></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"> void NLSOUND::CSimpleSound::setBuffer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>buffer</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Change the buffer. +<p> + +<p> +Definition at line <a class="el" href="simple__sound_8cpp-source.html#l00064">64</a> of file <a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</a>. +<p> +References <a class="el" href="simple__sound_8h-source.html#l00097">_Buffer</a>, and <a class="el" href="simple__sound_8h-source.html#l00094">_Registered</a>. +<p> +Referenced by <a class="el" href="simple__sound_8cpp-source.html#l00149">importForm</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00125">serial</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="o4" doxytag="NLSOUND::CSimpleSound::_Alpha"></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"> double NLSOUND::CSimpleSound::_Alpha<code> [private]</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="simple__sound_8h-source.html#l00102">102</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8h-source.html#l00070">getAlpha</a>, <a class="el" href="simple__sound_8cpp-source.html#l00149">importForm</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00125">serial</a>. </td> + </tr> +</table> +<a name="o1" doxytag="NLSOUND::CSimpleSound::_Buffer"></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"> <a class="el" href="classNLSOUND_1_1IBuffer.html">IBuffer</a>* NLSOUND::CSimpleSound::_Buffer<code> [private]</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="simple__sound_8h-source.html#l00097">97</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8cpp-source.html#l00094">getBuffer</a>, <a class="el" href="simple__sound_8cpp-source.html#l00064">setBuffer</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00058">~CSimpleSound</a>. </td> + </tr> +</table> +<a name="o7" doxytag="NLSOUND::CSimpleSound::_Buffername"></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"> std::string NLSOUND::CSimpleSound::_Buffername<code> [private]</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="simple__sound_8h-source.html#l00109">109</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8cpp-source.html#l00094">getBuffer</a>, <a class="el" href="simple__sound_8h-source.html#l00062">getBuffername</a>, <a class="el" href="simple__sound_8cpp-source.html#l00082">getSubSoundList</a>, <a class="el" href="simple__sound_8cpp-source.html#l00149">importForm</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00125">serial</a>. </td> + </tr> +</table> +<a name="o2" doxytag="NLSOUND::CSimpleSound::_Detailed"></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"> bool NLSOUND::CSimpleSound::_Detailed<code> [private]</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="simple__sound_8h-source.html#l00100">100</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8h-source.html#l00066">isDetailed</a>. </td> + </tr> +</table> +<a name="o6" doxytag="NLSOUND::CSimpleSound::_Filename"></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"> std::string NLSOUND::CSimpleSound::_Filename<code> [private]</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="simple__sound_8h-source.html#l00108">108</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8h-source.html#l00074">getFilename</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00149">importForm</a>. </td> + </tr> +</table> +<a name="o3" doxytag="NLSOUND::CSimpleSound::_MinDist"></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"> float NLSOUND::CSimpleSound::_MinDist<code> [private]</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="simple__sound_8h-source.html#l00101">101</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8h-source.html#l00068">getMinDistance</a>, <a class="el" href="simple__sound_8cpp-source.html#l00149">importForm</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00125">serial</a>. </td> + </tr> +</table> +<a name="o5" doxytag="NLSOUND::CSimpleSound::_NeedContext"></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"> bool NLSOUND::CSimpleSound::_NeedContext<code> [private]</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="simple__sound_8h-source.html#l00105">105</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8cpp-source.html#l00149">importForm</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00125">serial</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CSimpleSound::_Registered"></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"> bool NLSOUND::CSimpleSound::_Registered<code> [private]</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="simple__sound_8h-source.html#l00094">94</a> of file <a class="el" href="simple__sound_8h-source.html">simple_sound.h</a>. +<p> +Referenced by <a class="el" href="simple__sound_8cpp-source.html#l00094">getBuffer</a>, and <a class="el" href="simple__sound_8cpp-source.html#l00064">setBuffer</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="simple__sound_8h-source.html">simple_sound.h</a><li><a class="el" href="simple__sound_8cpp-source.html">simple_sound.cpp</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> |