diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a02237.html | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02237.html b/docs/doxygen/nel/a02237.html new file mode 100644 index 00000000..c5bbd91b --- /dev/null +++ b/docs/doxygen/nel/a02237.html @@ -0,0 +1,248 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLSOUND::CAudioMixerUser::CControledSources struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLSOUND::CAudioMixerUser::CControledSources Struct Reference</h1><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourcesa0">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &<a class="el" href="a04223.html#a626">s</a>)</td></tr> + +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05378.html#a236">NLMISC::TStringId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso0">Name</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The user var name. <a href="#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsery5">TControledParamId</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso1">ParamId</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Witch parameter to control. <a href="#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector< <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso2">SoundNames</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The controled sounds names. <a href="#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::set< <a class="el" href="a02254.html">CSourceCommon</a> * > </td><td class="memItemRight" valign=bottom><a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso3">Sources</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">All the sources controled by this variable. <a href="#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso4">Value</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Current parameter value. <a href="#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso4"></a><br><br></td></tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CAudioMixerUser_1_1CControledSourcesa0" doxytag="NLSOUND::CAudioMixerUser::CControledSources::serial" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAudioMixerUser::CControledSources::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.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></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="a05465.html#l00935">935</a> of file <a class="el" href="a05465.html">audio_mixer_user.cpp</a>. +<p> +References <a class="el" href="a05466.html#l00403">ParamId</a>, <a class="el" href="a05646.html#l00977">s</a>, <a class="el" href="a05646.html#l00645">size</a>, <a class="el" href="a05466.html#l00405">SoundNames</a>, <a class="el" href="a05981.html#l00105">uint</a>, and <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +<div class="fragment"><pre>00936 { +00937 std::string name, soundName; +00938 <span class="keywordflow">if</span> (<a class="code" href="a04223.html#a626">s</a>.isReading()) +00939 { +00940 <a class="code" href="a04223.html#a626">s</a>.serial(name); +00941 <a class="code" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso0">Name</a> = CStringMapper::map(name); +00942 <a class="code" href="a04223.html#a626">s</a>.serialEnum(ParamId); +00943 +00944 <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a04223.html#a587">size</a>; +00945 <a class="code" href="a04223.html#a626">s</a>.serial(size); +00946 <span class="keywordflow">for</span> (<a class="code" href="a04558.html#a15">uint</a> i=0; i<<a class="code" href="a04223.html#a587">size</a>; ++i) +00947 { +00948 <a class="code" href="a04223.html#a626">s</a>.serial(soundName); +00949 <a class="code" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso2">SoundNames</a>.push_back(CStringMapper::map(soundName)); +00950 } +00951 } +00952 <span class="keywordflow">else</span> +00953 { +00954 name = CStringMapper::unmap(Name); +00955 <a class="code" href="a04223.html#a626">s</a>.serial(name); +00956 <a class="code" href="a04223.html#a626">s</a>.serialEnum(ParamId); +00957 +00958 <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a04223.html#a587">size</a> = <a class="code" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso2">SoundNames</a>.size(); +00959 <a class="code" href="a04223.html#a626">s</a>.serial(size); +00960 +00961 <span class="keywordflow">for</span> (<a class="code" href="a04558.html#a15">uint</a> i=0; i<<a class="code" href="a04223.html#a587">size</a>; ++i) +00962 { +00963 soundName = CStringMapper::unmap(SoundNames[i]); +00964 <a class="code" href="a04223.html#a626">s</a>.serial(soundName); +00965 } +00966 } +00967 +00968 <span class="comment">// Default value to 0.</span> +00969 <a class="code" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso4">Value</a> = 0.0f; +00970 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso0" doxytag="NLSOUND::CAudioMixerUser::CControledSources::Name" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> <a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso0">NLSOUND::CAudioMixerUser::CControledSources::Name</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The user var name. +<p> + +<p> +Definition at line <a class="el" href="a05466.html#l00401">401</a> of file <a class="el" href="a05466.html">audio_mixer_user.h</a>. +<p> +Referenced by <a class="el" href="a05465.html#l00839">NLSOUND::CUserVarSerializer::readGeorges()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso1" doxytag="NLSOUND::CAudioMixerUser::CControledSources::ParamId" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a02235.html#NLSOUND_1_1CAudioMixerUsery5">TControledParamId</a> <a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso1">NLSOUND::CAudioMixerUser::CControledSources::ParamId</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Witch parameter to control. +<p> + +<p> +Definition at line <a class="el" href="a05466.html#l00403">403</a> of file <a class="el" href="a05466.html">audio_mixer_user.h</a>. +<p> +Referenced by <a class="el" href="a05465.html#l00839">NLSOUND::CUserVarSerializer::readGeorges()</a>, and <a class="el" href="a05465.html#l00935">serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso2" doxytag="NLSOUND::CAudioMixerUser::CControledSources::SoundNames" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::vector<<a class="el" href="a05378.html#a236">NLMISC::TStringId</a>> <a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso2">NLSOUND::CAudioMixerUser::CControledSources::SoundNames</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The controled sounds names. +<p> + +<p> +Definition at line <a class="el" href="a05466.html#l00405">405</a> of file <a class="el" href="a05466.html">audio_mixer_user.h</a>. +<p> +Referenced by <a class="el" href="a05465.html#l00839">NLSOUND::CUserVarSerializer::readGeorges()</a>, and <a class="el" href="a05465.html#l00935">serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso3" doxytag="NLSOUND::CAudioMixerUser::CControledSources::Sources" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::set<<a class="el" href="a02254.html">CSourceCommon</a>*> <a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso3">NLSOUND::CAudioMixerUser::CControledSources::Sources</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +All the sources controled by this variable. +<p> + +<p> +Definition at line <a class="el" href="a05466.html#l00409">409</a> of file <a class="el" href="a05466.html">audio_mixer_user.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso4" doxytag="NLSOUND::CAudioMixerUser::CControledSources::Value" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a02237.html#NLSOUND_1_1CAudioMixerUser_1_1CControledSourceso4">NLSOUND::CAudioMixerUser::CControledSources::Value</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Current parameter value. +<p> + +<p> +Definition at line <a class="el" href="a05466.html#l00407">407</a> of file <a class="el" href="a05466.html">audio_mixer_user.h</a>. +<p> +Referenced by <a class="el" href="a05465.html#l00839">NLSOUND::CUserVarSerializer::readGeorges()</a>. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="a05466.html">audio_mixer_user.h</a><li><a class="el" href="a05465.html">audio_mixer_user.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:30:34 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |