diff options
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CSoundAnimation.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CSoundAnimation.html | 842 |
1 files changed, 842 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CSoundAnimation.html b/docs/doxygen/nel/classNLSOUND_1_1CSoundAnimation.html new file mode 100644 index 00000000..1de108ea --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CSoundAnimation.html @@ -0,0 +1,842 @@ +<!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::CSoundAnimation Class Reference</h1><code>#include <<a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>></code> +<p> +<a href="classNLSOUND_1_1CSoundAnimation-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <a class="el" href="classNLSOUND_1_1CSoundAnimation.html#s1s0">NoId</a> = -1 + }</td></tr> +<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_1CSoundAnimation.html#a0">CSoundAnimation</a> (std::string &name, <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 nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#a1">~CSoundAnimation</a> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#a2">addMarker</a> (<a class="el" href="classNLSOUND_1_1CSoundAnimMarker.html">CSoundAnimMarker</a> *marker)</td></tr> +<tr><td> </td><td><font size=-1><em>Add a new marker.</em> <a href="#a2">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_1CSoundAnimation.html#a3">removeMarker</a> (<a class="el" href="classNLSOUND_1_1CSoundAnimMarker.html">CSoundAnimMarker</a> *marker)</td></tr> +<tr><td> </td><td><font size=-1><em>Remove a marker.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#a4">countMarkers</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the number of markers in this track.</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="classNLSOUND_1_1CSoundAnimMarker.html">CSoundAnimMarker</a> * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#a5">getMarker</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> i)</td></tr> +<tr><td> </td><td><font size=-1><em>Return a marker of this track given its index.</em> <a href="#a5">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_1CSoundAnimation.html#a6">getName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the name of the animation.</em> <a href="#a6">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_1CSoundAnimation.html#a7">load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load from an xml file.</em> <a href="#a7">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_1CSoundAnimation.html#a8">save</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Save to an xml document.</em> <a href="#a8">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_1CSoundAnimation.html#a9">getFilename</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the filename of the animation.</em> <a href="#a9">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_1CSoundAnimation.html#a10">setFilename</a> (std::string &name)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the filename of the animation.</em> <a href="#a10">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_1CSoundAnimation.html#a11">isDirty</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns whether the sound animation changed since the last save.</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_1CSoundAnimation.html#a12">setDirty</a> (bool b)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the dirty flag (Editing support).</em> <a href="#a12">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_1CSoundAnimation.html#a13">play</a> (<a class="el" href="classNLSOUND_1_1UAudioMixer.html">UAudioMixer</a> *mixer, 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 the sounds of the markers that fall within the specified time interval.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#b0">sort</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Sort all the markers according to their time.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#n0">_Id</a></td></tr> +<tr><td> </td><td><font size=-1><em>The unique ID of the animation.</em> <a href="#n0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#n1">_Name</a></td></tr> +<tr><td> </td><td><font size=-1><em>The name of the animation.</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#a6">TMarkerVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#n2">_Markers</a></td></tr> +<tr><td> </td><td><font size=-1><em>The set of markers.</em> <a href="#n2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CSoundAnimation.html#n3">_Filename</a></td></tr> +<tr><td> </td><td><font size=-1><em>The filename.</em> <a href="#n3">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_1CSoundAnimation.html#n4">_Dirty</a></td></tr> +<tr><td> </td><td><font size=-1><em>Has the sound animation changed since the last save? (Editing support).</em> <a href="#n4">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><h2>Member Enumeration Documentation</h2> +<a name="s1" doxytag="NLSOUND::CSoundAnimation::@21"></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"> anonymous enum + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b> +Enumeration values:</b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a name="s1s0" doxytag="NoId"></a><em>NoId</em></em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00049">49</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CSoundAnimation::CSoundAnimation"></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::CSoundAnimation::CSoundAnimation </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><a class="el" href="namespaceNLSOUND.html#a0">TSoundAnimId</a> </td> + <td class="mdname" nowrap> <em>id</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</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__animation_8h-source.html#l00054">54</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>, <a class="el" href="sound__animation_8h-source.html#l00103">_Id</a>, <a class="el" href="sound__animation_8h-source.html#l00106">_Name</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="a1" doxytag="NLSOUND::CSoundAnimation::~CSoundAnimation"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLSOUND::CSoundAnimation::~CSoundAnimation </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00056">56</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="NLSOUND::CSoundAnimation::addMarker"></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::CSoundAnimation::addMarker </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSoundAnimMarker.html">CSoundAnimMarker</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>marker</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> +Add a new marker. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8cpp-source.html#l00043">43</a> of file <a class="el" href="sound__animation_8cpp-source.html">sound_animation.cpp</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>, <a class="el" href="sound__animation_8h-source.html#l00109">_Markers</a>, and <a class="el" href="sound__animation_8cpp-source.html#l00074">sort</a>. +<p> +Referenced by <a class="el" href="sound__animation_8cpp-source.html#l00159">load</a>. </td> + </tr> +</table> +<a name="a4" doxytag="NLSOUND::CSoundAnimation::countMarkers"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="memory__common_8h.html#a11">uint32</a> NLSOUND::CSoundAnimation::countMarkers </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the number of markers in this track. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00066">66</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00109">_Markers</a>. </td> + </tr> +</table> +<a name="a9" doxytag="NLSOUND::CSoundAnimation::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"> virtual std::string& NLSOUND::CSoundAnimation::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><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the filename of the animation. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00082">82</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00112">_Filename</a>. </td> + </tr> +</table> +<a name="a5" doxytag="NLSOUND::CSoundAnimation::getMarker"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNLSOUND_1_1CSoundAnimMarker.html">CSoundAnimMarker</a>* NLSOUND::CSoundAnimation::getMarker </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>i</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return a marker of this track given its index. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00069">69</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00109">_Markers</a>. </td> + </tr> +</table> +<a name="a6" doxytag="NLSOUND::CSoundAnimation::getName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual std::string& NLSOUND::CSoundAnimation::getName </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the name of the animation. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00072">72</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00106">_Name</a>. </td> + </tr> +</table> +<a name="a11" doxytag="NLSOUND::CSoundAnimation::isDirty"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual bool NLSOUND::CSoundAnimation::isDirty </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns whether the sound animation changed since the last save. +<p> +(Editing support) +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00089">89</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>. </td> + </tr> +</table> +<a name="a7" doxytag="NLSOUND::CSoundAnimation::load"></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::CSoundAnimation::load </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> +Load from an xml file. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8cpp-source.html#l00159">159</a> of file <a class="el" href="sound__animation_8cpp-source.html">sound_animation.cpp</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>, <a class="el" href="sound__animation_8h-source.html#l00112">_Filename</a>, <a class="el" href="sound__animation_8cpp-source.html#l00043">addMarker</a>, and <a class="el" href="cf__lexical_8cpp-source.html#l02654">file</a>. </td> + </tr> +</table> +<a name="a13" doxytag="NLSOUND::CSoundAnimation::play"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSoundAnimation::play </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="mdname" nowrap> <em>mixer</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 the sounds of the markers that fall within the specified time interval. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8cpp-source.html#l00142">142</a> of file <a class="el" href="sound__animation_8cpp-source.html">sound_animation.cpp</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00109">_Markers</a>, and <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="a3" doxytag="NLSOUND::CSoundAnimation::removeMarker"></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::CSoundAnimation::removeMarker </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLSOUND_1_1CSoundAnimMarker.html">CSoundAnimMarker</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>marker</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> +Remove a marker. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8cpp-source.html#l00055">55</a> of file <a class="el" href="sound__animation_8cpp-source.html">sound_animation.cpp</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>, and <a class="el" href="sound__animation_8h-source.html#l00109">_Markers</a>. </td> + </tr> +</table> +<a name="a8" doxytag="NLSOUND::CSoundAnimation::save"></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::CSoundAnimation::save </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> +Save to an xml document. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8cpp-source.html#l00081">81</a> of file <a class="el" href="sound__animation_8cpp-source.html">sound_animation.cpp</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>, <a class="el" href="sound__animation_8h-source.html#l00112">_Filename</a>, <a class="el" href="sound__animation_8h-source.html#l00109">_Markers</a>, <a class="el" href="cf__lexical_8cpp-source.html#l02654">file</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00673">s</a>, and <a class="el" href="common_8cpp-source.html#l00153">NLMISC::smprintf</a>. </td> + </tr> +</table> +<a name="a12" doxytag="NLSOUND::CSoundAnimation::setDirty"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::CSoundAnimation::setDirty </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>b</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the dirty flag (Editing support). +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00092">92</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00115">_Dirty</a>. </td> + </tr> +</table> +<a name="a10" doxytag="NLSOUND::CSoundAnimation::setFilename"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::CSoundAnimation::setFilename </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> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the filename of the animation. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00086">86</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +References <a class="el" href="sound__animation_8h-source.html#l00112">_Filename</a>. </td> + </tr> +</table> +<a name="b0" doxytag="NLSOUND::CSoundAnimation::sort"></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::CSoundAnimation::sort </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> [protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sort all the markers according to their time. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8cpp-source.html#l00074">74</a> of file <a class="el" href="sound__animation_8cpp-source.html">sound_animation.cpp</a>. +<p> +Referenced by <a class="el" href="sound__animation_8cpp-source.html#l00043">addMarker</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="n4" doxytag="NLSOUND::CSoundAnimation::_Dirty"></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::CSoundAnimation::_Dirty<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Has the sound animation changed since the last save? (Editing support). +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00115">115</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +Referenced by <a class="el" href="sound__animation_8cpp-source.html#l00043">addMarker</a>, <a class="el" href="sound__animation_8h-source.html#l00054">CSoundAnimation</a>, <a class="el" href="sound__animation_8h-source.html#l00089">isDirty</a>, <a class="el" href="sound__animation_8cpp-source.html#l00159">load</a>, <a class="el" href="sound__animation_8cpp-source.html#l00055">removeMarker</a>, <a class="el" href="sound__animation_8cpp-source.html#l00081">save</a>, and <a class="el" href="sound__animation_8h-source.html#l00092">setDirty</a>. </td> + </tr> +</table> +<a name="n3" doxytag="NLSOUND::CSoundAnimation::_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::CSoundAnimation::_Filename<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The filename. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00112">112</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +Referenced by <a class="el" href="sound__animation_8h-source.html#l00082">getFilename</a>, <a class="el" href="sound__animation_8cpp-source.html#l00159">load</a>, <a class="el" href="sound__animation_8cpp-source.html#l00081">save</a>, and <a class="el" href="sound__animation_8h-source.html#l00086">setFilename</a>. </td> + </tr> +</table> +<a name="n0" doxytag="NLSOUND::CSoundAnimation::_Id"></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::CSoundAnimation::_Id<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The unique ID of the animation. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00103">103</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +Referenced by <a class="el" href="sound__animation_8h-source.html#l00054">CSoundAnimation</a>. </td> + </tr> +</table> +<a name="n2" doxytag="NLSOUND::CSoundAnimation::_Markers"></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#a6">TMarkerVector</a> NLSOUND::CSoundAnimation::_Markers<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The set of markers. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00109">109</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +Referenced by <a class="el" href="sound__animation_8cpp-source.html#l00043">addMarker</a>, <a class="el" href="sound__animation_8h-source.html#l00066">countMarkers</a>, <a class="el" href="sound__animation_8h-source.html#l00069">getMarker</a>, <a class="el" href="sound__animation_8cpp-source.html#l00142">play</a>, <a class="el" href="sound__animation_8cpp-source.html#l00055">removeMarker</a>, and <a class="el" href="sound__animation_8cpp-source.html#l00081">save</a>. </td> + </tr> +</table> +<a name="n1" doxytag="NLSOUND::CSoundAnimation::_Name"></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::CSoundAnimation::_Name<code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The name of the animation. +<p> + +<p> +Definition at line <a class="el" href="sound__animation_8h-source.html#l00106">106</a> of file <a class="el" href="sound__animation_8h-source.html">sound_animation.h</a>. +<p> +Referenced by <a class="el" href="sound__animation_8h-source.html#l00054">CSoundAnimation</a>, and <a class="el" href="sound__animation_8h-source.html#l00072">getName</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="sound__animation_8h-source.html">sound_animation.h</a><li><a class="el" href="sound__animation_8cpp-source.html">sound_animation.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> |