diff options
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CSoundAnimManager.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CSoundAnimManager.html | 884 |
1 files changed, 884 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSoundAnimManager.html b/docs/doxygen/nel/classNLSOUND_1_1CSoundAnimManager.html new file mode 100644 index 00000000..525d0202 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSoundAnimManager.html @@ -0,0 +1,884 @@ +<!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::CSoundAnimManager Class Reference</h1>The set of players. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a>></code> +<p> +<a href="classNLSOUND_1_1CSoundAnimManager-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_1CSoundAnimManager.html#a0">CSoundAnimManager</a> (<a class="el" href="classNLSOUND_1_1UAudioMixer.html">UAudioMixer</a> *mixer)</td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a1">~CSoundAnimManager</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a2">loadAnimation</a> (std::string &name)</td></tr> +<tr><td> </td><td><font size=-1><em>Load the sound animation with the specified name.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a3">createAnimation</a> (std::string &name)</td></tr> +<tr><td> </td><td><font size=-1><em>Create a new sound animation with the specified name.</em> <a href="#a3">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_1CSoundAnimManager.html#a4">saveAnimation</a> (<a class="el" href="classNLSOUND_1_1CSoundAnimation.html">CSoundAnimation</a> *anim, std::string &filname)</td></tr> +<tr><td> </td><td><font size=-1><em>Save the sound animation in the specified file.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a5">getAnimationFromName</a> (std::string &name)</td></tr> +<tr><td> </td><td><font size=-1><em>Start playing a sound animation.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNLSOUND_1_1CSoundAnimation.html">CSoundAnimation</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a6">findAnimation</a> (std::string &name)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the animation corresponding to a name.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a7">playAnimation</a> (<a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>, float time, <a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> &context)</td></tr> +<tr><td> </td><td><font size=-1><em>Start playing a sound animation.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a8">playAnimation</a> (std::string &name, float time, <a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> &context)</td></tr> +<tr><td> </td><td><font size=-1><em>Start playing a sound animation.</em> <a href="#a8">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_1CSoundAnimManager.html#a9">stopAnimation</a> (<a class="el" href="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> playbackId)</td></tr> +<tr><td> </td><td><font size=-1><em>Stop the playing of a sound animation.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a10">isPlaying</a> (<a class="el" href="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> playbackId)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns true is the animation with the specified playback ID is playing.</em> <a href="#a10">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_1CSoundAnimManager.html#a11">update</a> (float lastTime, float curTime)</td></tr> +<tr><td> </td><td><font size=-1><em>Update all the sound animations during playback.</em> <a href="#a11">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_1CSoundAnimManager.html#a12">playAnimation</a> (<a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>, float lastTime, float curTime, <a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> &context)</td></tr> +<tr><td> </td><td><font size=-1><em>Play all the events of an animation in the interval between lastTime and curTime.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#a13">idToName</a> (<a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> <a class="el" href="driver__opengl__extension__def_8h.html#a356">id</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Convert back from an anim ID to the anim name.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>CSoundAnimManager * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#d0">instance</a> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLSOUND_1_1UAudioMixer.html">UAudioMixer</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#n0">_Mixer</a></td></tr> +<tr><td> </td><td><font size=-1><em>The mixer.</em> <a href="#n0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a3">TSoundAnimMap</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#n1">_IdMap</a></td></tr> +<tr><td> </td><td><font size=-1><em>The conversion table from animation name to id.</em> <a href="#n1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a4">TSoundAnimVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#n2">_Animations</a></td></tr> +<tr><td> </td><td><font size=-1><em>The vector of all defined animations.</em> <a href="#n2">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>CSoundAnimManager * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimManager.html#q0">_Instance</a> = 0</td></tr> +<tr><td> </td><td><font size=-1><em>The one and only singleton instance.</em> <a href="#q0">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The set of players. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8h-source.html#l00072">72</a> of file <a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CSoundAnimManager::CSoundAnimManager"></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::CSoundAnimManager::CSoundAnimManager </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1UAudioMixer.html">UAudioMixer</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>mixer</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> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00044">44</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8cpp-source.html#l00040">_Instance</a>. +<p> +Referenced by <a class="el" href="sound__anim__manager_8h-source.html#l00076">instance</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CSoundAnimManager::~CSoundAnimManager"></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::CSoundAnimManager::~CSoundAnimManager </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> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00057">57</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8cpp-source.html#l00040">_Instance</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="NLSOUND::CSoundAnimManager::createAnimation"></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="namespaceNLSOUND.html#a0">TSoundAnimId</a> NLSOUND::CSoundAnimManager::createAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</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> +Create a new sound animation with the specified name. +<p> +Returns <a class="el" href="classNLSOUND_1_1CSoundAnimation.html#s1s0">CSoundAnimation::NoId</a> if the creation fails (duplicate name). <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The name of the animation to load. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00118">118</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00158">_Animations</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00155">_IdMap</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00056">NLSOUND::CSoundAnimationNoId</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00054">NLSOUND::TSoundAnimId</a>. +<p> +Referenced by <a class="el" href="sound__anim__manager_8cpp-source.html#l00076">loadAnimation</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CSoundAnimManager::findAnimation"></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_1CSoundAnimation.html">CSoundAnimation</a> * NLSOUND::CSoundAnimManager::findAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</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> +Returns the animation corresponding to a name. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The name of the animation to load. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00142">142</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00158">_Animations</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00155">_IdMap</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CSoundAnimManager::getAnimationFromName"></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="namespaceNLSOUND.html#a0">TSoundAnimId</a> NLSOUND::CSoundAnimManager::getAnimationFromName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</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> +Start playing a sound animation. +<p> +Returns true is the animation was found and is playing. <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The name of the animation to load. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00150">150</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00155">_IdMap</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00056">NLSOUND::CSoundAnimationNoId</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00054">NLSOUND::TSoundAnimId</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::CSoundAnimManager::idToName"></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::CSoundAnimManager::idToName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>id</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> +Convert back from an anim ID to the anim name. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00203">203</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00155">_IdMap</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00054">NLSOUND::TSoundAnimId</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLSOUND::CSoundAnimManager::instance"></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"> CSoundAnimManager* NLSOUND::CSoundAnimManager::instance </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, static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8h-source.html#l00076">76</a> of file <a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a>. +<p> +References <a class="el" href="sound__anim__manager_8cpp-source.html#l00040">_Instance</a>, and <a class="el" href="sound__anim__manager_8cpp-source.html#l00044">CSoundAnimManager</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CSoundAnimManager::isPlaying"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool NLSOUND::CSoundAnimManager::isPlaying </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>playbackId</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> +Returns true is the animation with the specified playback ID is playing. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The playback id that was returned by playAnimation. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00268">268</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00059">NLSOUND::TSoundAnimPlayId</a>. </td> + </tr> +</table> +<a name="a2" doxytag="NLSOUND::CSoundAnimManager::loadAnimation"></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="namespaceNLSOUND.html#a0">TSoundAnimId</a> NLSOUND::CSoundAnimManager::loadAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>name</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> +Load the sound animation with the specified name. +<p> +Returns the id of the new animation, or CSoundAnimationNoId is the file could not be found. <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The name of the animation to load. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00076">76</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00158">_Animations</a>, <a class="el" href="sound__anim__manager_8cpp-source.html#l00118">createAnimation</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00056">NLSOUND::CSoundAnimationNoId</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00054">NLSOUND::TSoundAnimId</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CSoundAnimManager::playAnimation"></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::CSoundAnimManager::playAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td> + <td class="mdname" nowrap> <em>id</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>lastTime</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>curTime</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> & </td> + <td class="mdname" nowrap> <em>context</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> +Play all the events of an animation in the interval between lastTime and curTime. +<p> +Both lastTime and curTime are measured relatively from the beginning of the animation. +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00215">215</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00158">_Animations</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00152">_Mixer</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00056">NLSOUND::CSoundAnimationNoId</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, <a class="el" href="debug_8h-source.html#l00254">nlassert</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00054">NLSOUND::TSoundAnimId</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CSoundAnimManager::playAnimation"></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="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> NLSOUND::CSoundAnimManager::playAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string & </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>time</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> & </td> + <td class="mdname" nowrap> <em>context</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> +Start playing a sound animation. +<p> +Returns an id number of this playback instance or -1 if the animation was not found. <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The name of the animation to play. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00239">239</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00059">NLSOUND::TSoundAnimPlayId</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CSoundAnimManager::playAnimation"></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="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> NLSOUND::CSoundAnimManager::playAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td> + <td class="mdname" nowrap> <em>id</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>time</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="structNLSOUND_1_1CSoundContext.html">CSoundContext</a> & </td> + <td class="mdname" nowrap> <em>context</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> +Start playing a sound animation. +<p> +Returns an id number of this playback instance or -1 if the animation was not found. <dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The id of the animation to play. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00233">233</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00218">id</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00054">NLSOUND::TSoundAnimId</a>, and <a class="el" href="sound__anim__manager_8h-source.html#l00059">NLSOUND::TSoundAnimPlayId</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CSoundAnimManager::saveAnimation"></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::CSoundAnimManager::saveAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSoundAnimation.html">CSoundAnimation</a> * </td> + <td class="mdname" nowrap> <em>anim</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>std::string & </td> + <td class="mdname" nowrap> <em>filname</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> +Save the sound animation in the specified file. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>filename</em> </td><td> +The name of the file to save the animation in. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00158">158</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CSoundAnimManager::stopAnimation"></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::CSoundAnimManager::stopAnimation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLSOUND.html#a2">TSoundAnimPlayId</a> </td> + <td class="mdname1" valign="top" nowrap> <em>playbackId</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> +Stop the playing of a sound animation. +<p> +<dl compact><dt><b> +Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> </td><td> +The playback id that was returned by playAnimation. </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00250">250</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +References <a class="el" href="sound__anim__manager_8h-source.html#l00059">NLSOUND::TSoundAnimPlayId</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CSoundAnimManager::update"></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::CSoundAnimManager::update </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>lastTime</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>curTime</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> +Update all the sound animations during playback. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00287">287</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n2" doxytag="NLSOUND::CSoundAnimManager::_Animations"></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="namespaceNLSOUND.html#a4">TSoundAnimVector</a> NLSOUND::CSoundAnimManager::_Animations<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The vector of all defined animations. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8h-source.html#l00158">158</a> of file <a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a>. +<p> +Referenced by <a class="el" href="sound__anim__manager_8cpp-source.html#l00118">createAnimation</a>, <a class="el" href="sound__anim__manager_8cpp-source.html#l00142">findAnimation</a>, <a class="el" href="sound__anim__manager_8cpp-source.html#l00076">loadAnimation</a>, and <a class="el" href="sound__anim__manager_8cpp-source.html#l00215">playAnimation</a>. </td> + </tr> +</table> +<a name="n1" doxytag="NLSOUND::CSoundAnimManager::_IdMap"></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="namespaceNLSOUND.html#a3">TSoundAnimMap</a> NLSOUND::CSoundAnimManager::_IdMap<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The conversion table from animation name to id. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8h-source.html#l00155">155</a> of file <a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a>. +<p> +Referenced by <a class="el" href="sound__anim__manager_8cpp-source.html#l00118">createAnimation</a>, <a class="el" href="sound__anim__manager_8cpp-source.html#l00142">findAnimation</a>, <a class="el" href="sound__anim__manager_8cpp-source.html#l00150">getAnimationFromName</a>, and <a class="el" href="sound__anim__manager_8cpp-source.html#l00203">idToName</a>. </td> + </tr> +</table> +<a name="q0" doxytag="NLSOUND::CSoundAnimManager::_Instance"></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"> CSoundAnimManager * NLSOUND::CSoundAnimManager::_Instance = 0<code> [static, protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The one and only singleton instance. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8cpp-source.html#l00040">40</a> of file <a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.cpp</a>. +<p> +Referenced by <a class="el" href="sound__anim__manager_8cpp-source.html#l00044">CSoundAnimManager</a>, <a class="el" href="sound__anim__manager_8h-source.html#l00076">instance</a>, and <a class="el" href="sound__anim__manager_8cpp-source.html#l00057">~CSoundAnimManager</a>. </td> + </tr> +</table> +<a name="n0" doxytag="NLSOUND::CSoundAnimManager::_Mixer"></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_1UAudioMixer.html">UAudioMixer</a>* NLSOUND::CSoundAnimManager::_Mixer<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The mixer. +<p> + +<p> +Definition at line <a class="el" href="sound__anim__manager_8h-source.html#l00152">152</a> of file <a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a>. +<p> +Referenced by <a class="el" href="sound__anim__manager_8cpp-source.html#l00215">playAnimation</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sound__anim__manager_8h-source.html">sound_anim_manager.h</a><li><a class="el" href="sound__anim__manager_8cpp-source.html">sound_anim_manager.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> |