diff options
Diffstat (limited to 'docs/doxygen/nel/a02417.html')
| -rw-r--r-- | docs/doxygen/nel/a02417.html | 1775 |
1 files changed, 1775 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02417.html b/docs/doxygen/nel/a02417.html new file mode 100644 index 00000000..8a9064e9 --- /dev/null +++ b/docs/doxygen/nel/a02417.html @@ -0,0 +1,1775 @@ +<!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::CContextSound class 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::CContextSound Class Reference</h1><code>#include <<a class="el" href="a05612.html">context_sound.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CContextSound: +<p><center><img src="a02417.png" usemap="#NLSOUND::CContextSound_map" border="0" alt=""></center> +<map name="NLSOUND::CContextSound_map"> +<area href="a02246.html" alt="NLSOUND::CSound" shape="rect" coords="0,0,165,24"> +</map> +<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundw4">TSOUND_TYPE</a> { <a class="el" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw3">SOUND_SIMPLE</a>, +<a class="el" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw1">SOUND_COMPLEX</a>, +<a class="el" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw0">SOUND_BACKGROUND</a>, +<a class="el" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw2">SOUND_CONTEXT</a> + }</td></tr> + +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda0">CContextSound</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1CContextSounda0"></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="a02246.html#NLSOUND_1_1CSounda1">getConeInnerAngle</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the inner angle of the cone. <a href="#NLSOUND_1_1CSounda1"></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="a02246.html#NLSOUND_1_1CSounda2">getConeOuterAngle</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the outer angle of the cone. <a href="#NLSOUND_1_1CSounda2"></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="a02246.html#NLSOUND_1_1CSounda3">getConeOuterGain</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the outer gain of the cone. <a href="#NLSOUND_1_1CSounda3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02246.html">CSound</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda4">getContextSound</a> (<a class="el" href="a03417.html">CSoundContext</a> &context)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounda4">getDirectionVector</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the direction vector. <a href="#NLSOUND_1_1CSounda4"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda6">getDuration</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the length of the sound in ms. <a href="#NLSOUND_1_1CContextSounda6"></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="a02246.html#NLSOUND_1_1CSounda6">getGain</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the gain. <a href="#NLSOUND_1_1CSounda6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounda7">getLooping</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the looping state. <a href="#NLSOUND_1_1CSounda7"></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="a02417.html#NLSOUND_1_1CContextSounda9">getMaxDistance</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the max distance (if detailed()). <a href="#NLSOUND_1_1CContextSounda9"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounda9">getName</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name (must be unique). <a href="#NLSOUND_1_1CSounda9"></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="a02246.html#NLSOUND_1_1CSounda10">getPitch</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the pitch. <a href="#NLSOUND_1_1CSounda10"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a82">TSoundPriority</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounda11">getPriority</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the initial priority. <a href="#NLSOUND_1_1CSounda11"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02246.html#NLSOUND_1_1CSoundw4">TSOUND_TYPE</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda13">getSoundType</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the sound. <a href="#NLSOUND_1_1CContextSounda13"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda14">getSubSoundList</a> (std::vector< std::pair< std::string, <a class="el" href="a02246.html">CSound</a> * > > &subsounds) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Used by the george sound plugin to check sound recursion (ie sound 'toto' use sound 'titi' witch also use sound 'toto' ...). <a href="#NLSOUND_1_1CContextSounda14"></a><br><br></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="a02246.html#NLSOUND_1_1CSounda14">getUserVarControler</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda16">importForm</a> (const std::string &<a class="el" href="a04560.html#a1">filename</a>, <a class="el" href="a02551.html">NLGEORGES::UFormElm</a> &formRoot)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Load the sound parameters from georges' form. <a href="#NLSOUND_1_1CContextSounda16"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda17">init</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda18">isDetailed</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if cone is meaningful. <a href="#NLSOUND_1_1CContextSounda18"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounda17">operator<</a> (const <a class="el" href="a02246.html">CSound</a> &otherSound) const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda20">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &<a class="el" href="a04223.html#a626">s</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounda19">setLooping</a> (bool looping)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set looping. <a href="#NLSOUND_1_1CSounda19"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSounda22">~CContextSound</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1CContextSounda22"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02246.html">CSound</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSounde0">createSound</a> (const std::string &<a class="el" href="a04560.html#a1">filename</a>, <a class="el" href="a02551.html">NLGEORGES::UFormElm</a> &formRoot)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Factory for specialized sound. <a href="#NLSOUND_1_1CSounde0"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp0">_ConeInnerAngle</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp1">_ConeOuterAngle</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp2">_ConeOuterGain</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp3">_Direction</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp4">_Gain</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp5">_Looping</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp6">_MaxDist</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Clipping distance for complex or backgound sound. <a href="#NLSOUND_1_1CSoundp6"></a><br><br></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="a02246.html#NLSOUND_1_1CSoundp7">_Name</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp8">_Pitch</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a05381.html#a82">TSoundPriority</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02246.html#NLSOUND_1_1CSoundp9">_Priority</a></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="a02246.html#NLSOUND_1_1CSoundp10">_UserVarControler</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">An optional user var controler. <a href="#NLSOUND_1_1CSoundp10"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The base name, that is the constante part of the name (before the first joker). <a href="#NLSOUND_1_1CContextSoundr0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03849.html">IContextSoundContainer</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">container for all the candidate sounds <a href="#NLSOUND_1_1CContextSoundr1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr2">_PatternName</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The context sound pattern name. <a href="#NLSOUND_1_1CContextSoundr2"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a11">uint32</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr3">_Random</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The random lenght (0 mean no random). <a href="#NLSOUND_1_1CContextSoundr3"></a><br><br></td></tr> +</table> +<hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSoundw4" doxytag="NLSOUND::CContextSound::TSOUND_TYPE" ></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"> enum <a class="el" href="a02246.html#NLSOUND_1_1CSoundw4">NLSOUND::CSound::TSOUND_TYPE</a><code> [inherited]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw3" doxytag="SOUND_SIMPLE" ></a>SOUND_SIMPLE</em> </td><td> +</td></tr> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw1" doxytag="SOUND_COMPLEX" ></a>SOUND_COMPLEX</em> </td><td> +</td></tr> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw0" doxytag="SOUND_BACKGROUND" ></a>SOUND_BACKGROUND</em> </td><td> +</td></tr> +<tr><td valign=top><em><a class="anchor" name="NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw2" doxytag="SOUND_CONTEXT" ></a>SOUND_CONTEXT</em> </td><td> +</td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="a06407.html#l00067">67</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +<div class="fragment"><pre>00068 { +00069 <a class="code" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw3">SOUND_SIMPLE</a>, +00070 <a class="code" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw1">SOUND_COMPLEX</a>, +00071 <a class="code" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw0">SOUND_BACKGROUND</a>, +00072 <a class="code" href="a02246.html#NLSOUND_1_1CSoundw4NLSOUND_1_1CSoundw2">SOUND_CONTEXT</a> +00073 }; +</pre></div> </td> + </tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CContextSounda0" doxytag="NLSOUND::CContextSound::CContextSound" ></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"> NLSOUND::CContextSound::CContextSound </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="a05611.html#l00042">42</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +<div class="fragment"><pre>00043 : <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>(0) +00044 { +00045 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda22" doxytag="NLSOUND::CContextSound::~CContextSound" ></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"> NLSOUND::CContextSound::~<a class="el" href="a02417.html">CContextSound</a> </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> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="a05611.html#l00047">47</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +<div class="fragment"><pre>00048 { +00049 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> != 0) +00050 <span class="keyword">delete</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>; +00051 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CSounde0" doxytag="NLSOUND::CContextSound::createSound" ></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="a02246.html">CSound</a> * NLSOUND::CSound::createSound </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 class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02551.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> [static, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Factory for specialized sound. +<p> + +<p> +Definition at line <a class="el" href="a06406.html#l00043">43</a> of file <a class="el" href="a06406.html">sound.cpp</a>. +<p> +References <a class="el" href="a02551.html#NLGEORGES_1_1UFormElma15">NLGEORGES::UFormElm::getDfnName()</a>, <a class="el" href="a02551.html#NLGEORGES_1_1UFormElma17">NLGEORGES::UFormElm::getNodeByName()</a>, <a class="el" href="a06406.html#l00140">NLSOUND::CSound::importForm()</a>, <a class="el" href="a05622.html#l00333">nlassertex</a>, and <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +<div class="fragment"><pre>00044 { +00045 NL_ALLOC_CONTEXT(NLSOUND_CSound); +00046 <a class="code" href="a02246.html#NLSOUND_1_1CSounda0">CSound</a> *ret = NULL; +00047 string soundType; +00048 +00049 <a class="code" href="a02551.html">NLGEORGES::UFormElm</a> *psoundType; +00050 +00051 <span class="keywordflow">if</span> (!formRoot.<a class="code" href="a02551.html#NLGEORGES_1_1UFormElma17">getNodeByName</a>(&psoundType, <span class="stringliteral">".SoundType"</span>)) +00052 { +00053 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"No SoundType in : %s"</span>, <a class="code" href="a05377.html#a2">filename</a>.c_str()); +00054 <span class="keywordflow">return</span> 0; +00055 } +00056 +00057 <span class="keywordflow">if</span> (psoundType != NULL) +00058 { +00059 std::string dfnName; +00060 psoundType-><a class="code" href="a02551.html#NLGEORGES_1_1UFormElma15">getDfnName</a>(dfnName); +00061 +00062 <span class="keywordflow">if</span> (dfnName == <span class="stringliteral">"simple_sound.dfn"</span>) +00063 { +00064 ret = <span class="keyword">new</span> CSimpleSound(); +00065 ret->importForm(filename, formRoot); +00066 } +00067 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (dfnName == <span class="stringliteral">"complex_sound.dfn"</span>) +00068 { +00069 ret = <span class="keyword">new</span> CComplexSound(); +00070 ret->importForm(filename, formRoot); +00071 } +00072 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (dfnName == <span class="stringliteral">"background_sound.dfn"</span>) +00073 { +00074 ret = <span class="keyword">new</span> CBackgroundSound(); +00075 ret->importForm(filename, formRoot); +00076 } +00077 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (dfnName == <span class="stringliteral">"context_sound.dfn"</span>) +00078 { +00079 ret = <span class="keyword">new</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSounda0">CContextSound</a>(); +00080 ret->importForm(filename, formRoot); +00081 } +00082 <span class="keywordflow">else</span> +00083 { +00084 <a class="code" href="a04199.html#a8">nlassertex</a>(<span class="keyword">false</span>, (<span class="stringliteral">"SoundType unsuported : %s"</span>, dfnName.c_str())); +00085 } +00086 +00087 } +00088 +00089 <span class="keywordflow">return</span> ret; +00090 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda1" doxytag="NLSOUND::CContextSound::getConeInnerAngle" ></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 NLSOUND::CSound::getConeInnerAngle </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the inner angle of the cone. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00098">98</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00134">NLSOUND::CSound::_ConeInnerAngle</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00290">NLSOUND::CSimpleSource::setDirection()</a>. +<p> +<div class="fragment"><pre>00098 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp0">_ConeInnerAngle</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda2" doxytag="NLSOUND::CContextSound::getConeOuterAngle" ></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 NLSOUND::CSound::getConeOuterAngle </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the outer angle of the cone. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00100">100</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00134">NLSOUND::CSound::_ConeOuterAngle</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00290">NLSOUND::CSimpleSource::setDirection()</a>. +<p> +<div class="fragment"><pre>00100 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp1">_ConeOuterAngle</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda3" doxytag="NLSOUND::CContextSound::getConeOuterGain" ></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 NLSOUND::CSound::getConeOuterGain </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the outer gain of the cone. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00102">102</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00134">NLSOUND::CSound::_ConeOuterGain</a>. +<p> +Referenced by <a class="el" href="a06390.html#l00290">NLSOUND::CSimpleSource::setDirection()</a>. +<p> +<div class="fragment"><pre>00102 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp2">_ConeOuterGain</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda4" doxytag="NLSOUND::CContextSound::getContextSound" ></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="a02246.html">CSound</a> * NLSOUND::CContextSound::getContextSound </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03417.html">CSoundContext</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>context</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="a05611.html#l00135">135</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a03849.html#NLSOUND_1_1IContextSoundContainera2">NLSOUND::IContextSoundContainer::getSound()</a>, <a class="el" href="a05611.html#l00165">init()</a>, <a class="el" href="a06630.html#l00060">NLSOUND::CSoundContext::PreviousRandom</a>, <a class="el" href="a05646.html#l00993">r</a>, and <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>. +<p> +<div class="fragment"><pre>00136 { +00137 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> == 0) +00138 { +00139 <span class="comment">// need to init the sound container.</span> +00140 <a class="code" href="a02417.html#NLSOUND_1_1CContextSounda17">init</a>(); +00141 +00142 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> == 0) +00143 <span class="keywordflow">return</span> 0; +00144 } +00145 +00146 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr3">_Random</a> > 1) +00147 { +00148 <span class="comment">// compute the random value.</span> +00149 <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a04223.html#a628">r</a>; +00150 <span class="keywordflow">do</span> +00151 { +00152 <a class="code" href="a04223.html#a628">r</a> = rand()%<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr3">_Random</a>; +00153 } <span class="keywordflow">while</span> (<a class="code" href="a04223.html#a628">r</a> == context.PreviousRandom); +00154 +00155 context.PreviousRandom = <a class="code" href="a04223.html#a628">r</a>; +00156 +00157 <span class="keywordflow">return</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>->getSound(context, r); +00158 } +00159 <span class="keywordflow">else</span> +00160 <span class="keywordflow">return</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>->getSound(context, 0); +00161 +00162 +00163 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda4" doxytag="NLSOUND::CContextSound::getDirectionVector" ></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"> const <a class="el" href="a03128.html">NLMISC::CVector</a>& NLSOUND::CSound::getDirectionVector </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the direction vector. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00104">104</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +<div class="fragment"><pre>00104 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp3">_Direction</a>;} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda6" doxytag="NLSOUND::CContextSound::getDuration" ></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="a04558.html#a11">uint32</a> NLSOUND::CContextSound::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="a02246.html#NLSOUND_1_1CSounda5">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05611.html#l00106">106</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a05611.html#l00122">getSubSoundList()</a>, and <a class="el" href="a05981.html#l00100">uint32</a>. +<p> +<div class="fragment"><pre>00107 { +00108 std::vector<std::pair<std::string, CSound*> > sounds; +00109 <a class="code" href="a02417.html#NLSOUND_1_1CContextSounda14">getSubSoundList</a>(sounds); +00110 +00111 <a class="code" href="a04558.html#a11">uint32</a> duration = 0; +00112 +00113 std::vector<std::pair<std::string, CSound*> >::iterator first(sounds.begin()), last(sounds.end()); +00114 <span class="keywordflow">for</span> (; first != last; ++first) +00115 { +00116 duration = std::max(duration, first->second->getDuration()); +00117 } +00118 <span class="keywordflow">return</span> duration; +00119 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda6" doxytag="NLSOUND::CContextSound::getGain" ></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 NLSOUND::CSound::getGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the gain. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00090">90</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a05465.html#l01017">NLSOUND::CAudioMixerUser::addUserControledSource()</a>, <a class="el" href="a05593.html#l00037">NLSOUND::CComplexSource::CComplexSource()</a>, <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. +<p> +<div class="fragment"><pre>00090 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp4">_Gain</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda7" doxytag="NLSOUND::CContextSound::getLooping" ></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"> bool NLSOUND::CSound::getLooping </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, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the looping state. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00088">88</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00137">NLSOUND::CSound::_Looping</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00037">NLSOUND::CComplexSource::CComplexSource()</a>, and <a class="el" href="a05593.html#l00698">NLSOUND::CComplexSource::checkup()</a>. +<p> +<div class="fragment"><pre>00088 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp5">_Looping</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda9" doxytag="NLSOUND::CContextSound::getMaxDistance" ></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 NLSOUND::CContextSound::getMaxDistance </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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the max distance (if detailed()). +<p> + +<p> +Reimplemented from <a class="el" href="a02246.html#NLSOUND_1_1CSounda8">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05611.html#l00091">91</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a03849.html#NLSOUND_1_1IContextSoundContainera1">NLSOUND::IContextSoundContainer::getMaxDistance()</a>. +<p> +<div class="fragment"><pre>00092 { +00093 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> == 0) +00094 { +00095 const_cast<CContextSound*>(<span class="keyword">this</span>)->init(); +00096 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> == 0) +00097 { +00098 <span class="comment">// invalid state</span> +00099 <span class="keywordflow">return</span> 0; +00100 } +00101 } +00102 <span class="keywordflow">return</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>->getMaxDistance();; +00103 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda9" doxytag="NLSOUND::CContextSound::getName" ></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"> const <a class="el" href="a05378.html#a236">NLMISC::TStringId</a>& NLSOUND::CSound::getName </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the name (must be unique). +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00108">108</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06414.html#l00151">NLSOUND::CSoundBank::addSound()</a>, <a class="el" href="a05612.html#l00136">NLSOUND::CContextSoundContainer< NbJoker, UseRandom, Shift >::addSound()</a>, and <a class="el" href="a05593.html#l00456">NLSOUND::CComplexSource::onUpdate()</a>. +<p> +<div class="fragment"><pre>00108 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp7">_Name</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda10" doxytag="NLSOUND::CContextSound::getPitch" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NLSOUND::CSound::getPitch </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the pitch. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00092">92</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00037">NLSOUND::CComplexSource::CComplexSource()</a>, <a class="el" href="a05465.html#l01576">NLSOUND::CAudioMixerUser::createSource()</a>, <a class="el" href="a05593.html#l00577">NLSOUND::CComplexSource::onEvent()</a>, <a class="el" href="a05593.html#l00105">NLSOUND::CComplexSource::playStuf()</a>, and <a class="el" href="a05473.html#l00165">NLSOUND::CBackgroundSource::updateFilterValues()</a>. +<p> +<div class="fragment"><pre>00092 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp8">_Pitch</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda11" doxytag="NLSOUND::CContextSound::getPriority" ></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="a05381.html#a82">TSoundPriority</a> NLSOUND::CSound::getPriority </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the initial priority. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00094">94</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00133">NLSOUND::CSound::_Priority</a>, and <a class="el" href="a06630.html#l00072">NLSOUND::TSoundPriority</a>. +<p> +Referenced by <a class="el" href="a05593.html#l00037">NLSOUND::CComplexSource::CComplexSource()</a>. +<p> +<div class="fragment"><pre>00094 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp9">_Priority</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda13" doxytag="NLSOUND::CContextSound::getSoundType" ></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="a02246.html#NLSOUND_1_1CSoundw4">TSOUND_TYPE</a> NLSOUND::CContextSound::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, 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="a02246.html#NLSOUND_1_1CSounda12">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05612.html#l00287">287</a> of file <a class="el" href="a05612.html">context_sound.h</a>. +<p> +<div class="fragment"><pre>00287 { <span class="keywordflow">return</span> CSound::SOUND_CONTEXT; }; +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda14" doxytag="NLSOUND::CContextSound::getSubSoundList" ></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::CContextSound::getSubSoundList </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::vector< std::pair< std::string, <a class="el" href="a02246.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="a02246.html#NLSOUND_1_1CSounda13">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05611.html#l00122">122</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a03849.html#NLSOUND_1_1IContextSoundContainera3">NLSOUND::IContextSoundContainer::getSoundList()</a>. +<p> +Referenced by <a class="el" href="a05611.html#l00106">getDuration()</a>. +<p> +<div class="fragment"><pre>00123 { +00124 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> == 0) +00125 { +00126 const_cast<CContextSound*>(<span class="keyword">this</span>)->init(); +00127 } +00128 +00129 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>) +00130 { +00131 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>->getSoundList(subsounds); +00132 } +00133 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda14" doxytag="NLSOUND::CContextSound::getUserVarControler" ></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> NLSOUND::CSound::getUserVarControler </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, inherited]</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="a06407.html#l00121">121</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00145">NLSOUND::CSound::_UserVarControler</a>. +<p> +<div class="fragment"><pre>00121 { <span class="keywordflow">return</span> <a class="code" href="a02246.html#NLSOUND_1_1CSoundp10">_UserVarControler</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda16" doxytag="NLSOUND::CContextSound::importForm" ></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::CContextSound::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 class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a02551.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> + +<p> +Reimplemented from <a class="el" href="a02246.html#NLSOUND_1_1CSounda15">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05611.html#l00067">67</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a05612.html#l00313">_PatternName</a>, <a class="el" href="a02551.html#NLGEORGES_1_1UFormElma15">NLGEORGES::UFormElm::getDfnName()</a>, <a class="el" href="a02551.html#NLGEORGES_1_1UFormElma17">NLGEORGES::UFormElm::getNodeByName()</a>, <a class="el" href="a02551.html#NLGEORGES_1_1UFormElma44">NLGEORGES::UFormElm::getValueByName()</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>. +<p> +<div class="fragment"><pre>00068 { +00069 <a class="code" href="a02551.html">NLGEORGES::UFormElm</a> *psoundType; +00070 std::string dfnName; +00071 +00072 <span class="comment">// some basic checking.</span> +00073 formRoot.<a class="code" href="a02551.html#NLGEORGES_1_1UFormElma17">getNodeByName</a>(&psoundType, <span class="stringliteral">".SoundType"</span>); +00074 <a class="code" href="a04199.html#a6">nlassert</a>(psoundType != NULL); +00075 psoundType-><a class="code" href="a02551.html#NLGEORGES_1_1UFormElma15">getDfnName</a>(dfnName); +00076 <a class="code" href="a04199.html#a6">nlassert</a>(dfnName == <span class="stringliteral">"context_sound.dfn"</span>); +00077 +00078 <span class="comment">// Call the base class</span> +00079 CSound::importForm(filename, formRoot); +00080 +00081 <span class="comment">// Read the pattern name</span> +00082 formRoot.<a class="code" href="a02551.html#NLGEORGES_1_1UFormElma44">getValueByName</a>(_PatternName, <span class="stringliteral">".SoundType.PatternName"</span>); +00083 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda17" doxytag="NLSOUND::CContextSound::init" ></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::CContextSound::init </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> + +<p> +Definition at line <a class="el" href="a05611.html#l00165">165</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a05612.html#l00315">_BaseName</a>, <a class="el" href="a05612.html#l00313">_PatternName</a>, <a class="el" href="a03849.html#NLSOUND_1_1IContextSoundContainera0">NLSOUND::IContextSoundContainer::addSound()</a>, <a class="el" href="a05646.html#l00225">index</a>, <a class="el" href="a03849.html#NLSOUND_1_1IContextSoundContainera4">NLSOUND::IContextSoundContainer::init()</a>, <a class="el" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, <a class="el" href="a05622.html#l00101">nldebug</a>, <a class="el" href="a05622.html#l00135">nlwarning</a>, and <a class="el" href="a05981.html#l00105">uint</a>. +<p> +Referenced by <a class="el" href="a05611.html#l00135">getContextSound()</a>. +<p> +<div class="fragment"><pre>00166 { +00167 NL_ALLOC_CONTEXT(NLSOUND_CContextSound); +00168 <a class="code" href="a04558.html#a15">uint</a> nbJoker = 0; +00169 <a class="code" href="a04558.html#a15">uint</a> contextArgIndex[SoundContextNbArgs]; +00170 <span class="keywordtype">bool</span> useRandom = <span class="keyword">false</span>; +00171 <span class="keywordtype">bool</span> parseArg = <span class="keyword">false</span>; +00172 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a> = <span class="stringliteral">""</span>; +00173 +00174 <a class="code" href="a04199.html#a0">nldebug</a>(<span class="stringliteral">"Init the context sound %s"</span>, <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr2">_PatternName</a>.c_str()); +00175 +00176 string::iterator first(<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr2">_PatternName</a>.begin()), last(<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr2">_PatternName</a>.end()); +00177 <span class="comment">// 1st loop until the first joker</span> +00178 <span class="keywordflow">for</span>(; first != last && *first != <span class="charliteral">'%'</span>; ++first) +00179 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a> += *first; +00180 +00181 <span class="comment">// 2nd loop, now we read the context arg index for each joker.</span> +00182 std::string <a class="code" href="a04223.html#a566">index</a>; +00183 <span class="keywordflow">for</span> (; first != last; ++first) +00184 { +00185 <span class="keywordflow">if</span> (parseArg) +00186 { +00187 <span class="keywordflow">if</span> (isdigit(<span class="keywordtype">int</span>(*first))) +00188 { +00189 <a class="code" href="a04223.html#a566">index</a> += *first; +00190 } +00191 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!<a class="code" href="a04223.html#a566">index</a>.empty()) +00192 { +00193 <span class="keywordflow">if</span> (useRandom) +00194 { +00195 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr3">_Random</a> = atoi(<a class="code" href="a04223.html#a566">index</a>.c_str()); +00196 } +00197 <span class="keywordflow">else</span> +00198 { +00199 <a class="code" href="a04199.html#a6">nlassert</a>(nbJoker < SoundContextNbArgs); +00200 contextArgIndex[nbJoker++] = atoi(<a class="code" href="a04223.html#a566">index</a>.c_str()); +00201 parseArg = <span class="keyword">false</span>; +00202 <a class="code" href="a04223.html#a566">index</a> = <span class="stringliteral">""</span>; +00203 } +00204 } +00205 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*first == <span class="charliteral">'r'</span>) +00206 { +00207 <a class="code" href="a04199.html#a6">nlassert</a>(useRandom == <span class="keyword">false</span>); +00208 useRandom = <span class="keyword">true</span>; +00209 } +00210 } +00211 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*first == <span class="charliteral">'%'</span>) +00212 { +00213 <a class="code" href="a04199.html#a6">nlassert</a>(useRandom == <span class="keyword">false</span>); +00214 parseArg = <span class="keyword">true</span>; +00215 } +00216 } +00217 +00218 <span class="comment">// read the last char...</span> +00219 <span class="keywordflow">if</span> (!<a class="code" href="a04223.html#a566">index</a>.empty()) +00220 { +00221 <span class="keywordflow">if</span> (useRandom) +00222 { +00223 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr3">_Random</a> = atoi(<a class="code" href="a04223.html#a566">index</a>.c_str()); +00224 } +00225 <span class="keywordflow">else</span> +00226 { +00227 <a class="code" href="a04199.html#a6">nlassert</a>(nbJoker < SoundContextNbArgs); +00228 contextArgIndex[nbJoker++] = atoi(<a class="code" href="a04223.html#a566">index</a>.c_str()); +00229 parseArg = <span class="keyword">false</span>; +00230 } +00231 } +00232 +00233 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a> != 0) +00234 <span class="keyword">delete</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>; +00235 +00236 <span class="comment">// A little macro to make life easier (LM stand for Local Macro)</span> +00237 <span class="preprocessor">#define LM_CASE_CONTAINER_CREATOR(size) case (size):\</span> +00238 <span class="preprocessor"> if (useRandom)\</span> +00239 <span class="preprocessor"> _ContextSounds = new CContextSoundContainer<(size), true>;\</span> +00240 <span class="preprocessor"> else\</span> +00241 <span class="preprocessor"> _ContextSounds = new CContextSoundContainer<(size), false>;\</span> +00242 <span class="preprocessor"> break;</span> +00243 <span class="preprocessor"></span> +00244 <span class="comment">// ok, now instantiate the correct container</span> +00245 <span class="keywordflow">switch</span> (nbJoker) +00246 { +00247 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(0) +00248 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(1) +00249 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(2) +00250 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(3) +00251 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(4) +00252 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(5) +00253 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(6) +00254 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(7) +00255 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(8) +00256 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(9) +00257 <a class="code" href="a04188.html#a0">LM_CASE_CONTAINER_CREATOR</a>(10) +00258 <span class="keywordflow">default</span>: +00259 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"Unsuported number of context argument !"</span>); +00260 <span class="keywordflow">return</span>; +00261 } +00262 <span class="comment">// cleanup macro</span> +00263 <span class="preprocessor">#undef LM_CASE_CONTAINER_CREATOR</span> +00264 <span class="preprocessor"></span> +00265 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>->init(contextArgIndex); +00266 +00267 <span class="comment">// ok, we have the container, now fill it with the sound</span> +00268 { +00269 std::vector<NLMISC::TStringId> allSounds; +00270 <span class="comment">// CSoundBank::getSoundNames(allSounds);</span> +00271 CAudioMixerUser::instance()->getSoundNames(allSounds); +00272 +00273 std::vector<NLMISC::TStringId>::iterator first(allSounds.begin()), last(allSounds.end()); +00274 <span class="keywordflow">for</span> (; first != last; ++first) +00275 { +00276 <span class="keyword">const</span> std::string &soundName = CStringMapper::unmap(*first); +00277 <span class="keywordflow">if</span> (soundName.size() > <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a>.size()) +00278 { +00279 <a class="code" href="a04558.html#a15">uint</a> i; +00280 <span class="keywordflow">for</span> (i=0; i<<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a>.size(); ++i) +00281 { +00282 <span class="keywordflow">if</span> (soundName[i] != <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a>[i]) +00283 <span class="keywordflow">break</span>; +00284 } +00285 <span class="keywordflow">if</span> (i == <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr0">_BaseName</a>.size()) +00286 { +00287 <span class="comment">// The base name is ok, check that the next char is a digit (avoid conflit if some </span> +00288 <span class="comment">// sound have a longeur base name with same begining)</span> +00289 <span class="keywordflow">if</span> (soundName[i] >= <span class="charliteral">'0'</span> && soundName[i] <= <span class="charliteral">'9'</span>) +00290 <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>->addSound(CAudioMixerUser::instance()->getSoundId(*first), _BaseName); +00291 } +00292 } +00293 } +00294 } +00295 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda18" doxytag="NLSOUND::CContextSound::isDetailed" ></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"> bool NLSOUND::CContextSound::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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return true if cone is meaningful. +<p> + +<p> +Implements <a class="el" href="a02246.html#NLSOUND_1_1CSounda16">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05611.html#l00086">86</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +<div class="fragment"><pre>00087 { +00088 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00089 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda17" doxytag="NLSOUND::CContextSound::operator<" ></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"> bool NLSOUND::CSound::operator< </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a02246.html">CSound</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>otherSound</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline, inherited]</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="a06407.html#l00123">123</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00143">NLSOUND::CSound::_Name</a>, and <a class="el" href="a06470.html#l00083">NLMISC::CStringMapper::unmap()</a>. +<p> +<div class="fragment"><pre>00124 { +00125 <span class="keywordflow">return</span> <a class="code" href="a03450.html#NLMISC_1_1CStringMappere4">NLMISC::CStringMapper::unmap</a>(_Name) < <a class="code" href="a03450.html#NLMISC_1_1CStringMappere4">NLMISC::CStringMapper::unmap</a>(otherSound._Name); +00126 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSounda20" doxytag="NLSOUND::CContextSound::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::CContextSound::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><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="a02246.html#NLSOUND_1_1CSounda18">NLSOUND::CSound</a>. +<p> +Definition at line <a class="el" href="a05611.html#l00053">53</a> of file <a class="el" href="a05611.html">context_sound.cpp</a>. +<p> +References <a class="el" href="a05612.html#l00313">_PatternName</a>, and <a class="el" href="a05646.html#l00977">s</a>. +<p> +<div class="fragment"><pre>00054 { +00055 CSound::serial(s); +00056 <a class="code" href="a04223.html#a626">s</a>.serial(_PatternName); +00057 +00058 <span class="keywordflow">if</span> (<a class="code" href="a04223.html#a626">s</a>.isReading()) +00059 { +00060 <span class="keywordflow">if</span> (<a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>) +00061 <span class="keyword">delete</span> <a class="code" href="a02417.html#NLSOUND_1_1CContextSoundr1">_ContextSounds</a>; +00062 } +00063 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSounda19" doxytag="NLSOUND::CContextSound::setLooping" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CSound::setLooping </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool </td> + <td class="mdname1" valign="top" nowrap> <em>looping</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, inherited]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set looping. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00113">113</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +References <a class="el" href="a06407.html#l00137">NLSOUND::CSound::_Looping</a>. +<p> +<div class="fragment"><pre>00113 { <a class="code" href="a02246.html#NLSOUND_1_1CSoundp5">_Looping</a> = looping; } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CContextSoundr0" doxytag="NLSOUND::CContextSound::_BaseName" ></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::string <a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr0">NLSOUND::CContextSound::_BaseName</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The base name, that is the constante part of the name (before the first joker). +<p> + +<p> +Definition at line <a class="el" href="a05612.html#l00315">315</a> of file <a class="el" href="a05612.html">context_sound.h</a>. +<p> +Referenced by <a class="el" href="a05611.html#l00165">init()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp0" doxytag="NLSOUND::CContextSound::_ConeInnerAngle" ></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="a02246.html#NLSOUND_1_1CSoundp0">NLSOUND::CSound::_ConeInnerAngle</a><code> [protected, inherited]</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="a06407.html#l00134">134</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00098">NLSOUND::CSound::getConeInnerAngle()</a>, <a class="el" href="a06406.html#l00140">NLSOUND::CSound::importForm()</a>, and <a class="el" href="a06406.html#l00114">NLSOUND::CSound::serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp1" doxytag="NLSOUND::CContextSound::_ConeOuterAngle" ></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="a02246.html#NLSOUND_1_1CSoundp1">NLSOUND::CSound::_ConeOuterAngle</a><code> [protected, inherited]</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="a06407.html#l00134">134</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00100">NLSOUND::CSound::getConeOuterAngle()</a>, <a class="el" href="a06406.html#l00140">NLSOUND::CSound::importForm()</a>, and <a class="el" href="a06406.html#l00114">NLSOUND::CSound::serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp2" doxytag="NLSOUND::CContextSound::_ConeOuterGain" ></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="a02246.html#NLSOUND_1_1CSoundp2">NLSOUND::CSound::_ConeOuterGain</a><code> [protected, inherited]</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="a06407.html#l00134">134</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00102">NLSOUND::CSound::getConeOuterGain()</a>, <a class="el" href="a06406.html#l00140">NLSOUND::CSound::importForm()</a>, and <a class="el" href="a06406.html#l00114">NLSOUND::CSound::serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSoundr1" doxytag="NLSOUND::CContextSound::_ContextSounds" ></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="a03849.html">IContextSoundContainer</a>* <a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr1">NLSOUND::CContextSound::_ContextSounds</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +container for all the candidate sounds +<p> + +<p> +Definition at line <a class="el" href="a05612.html#l00323">323</a> of file <a class="el" href="a05612.html">context_sound.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp3" doxytag="NLSOUND::CContextSound::_Direction" ></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="a03128.html">NLMISC::CVector</a> <a class="el" href="a02246.html#NLSOUND_1_1CSoundp3">NLSOUND::CSound::_Direction</a><code> [protected, inherited]</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="a06407.html#l00135">135</a> of file <a class="el" href="a06407.html">sound.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp4" doxytag="NLSOUND::CContextSound::_Gain" ></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="a02246.html#NLSOUND_1_1CSoundp4">NLSOUND::CSound::_Gain</a><code> [protected, inherited]</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="a06407.html#l00131">131</a> of file <a class="el" href="a06407.html">sound.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp5" doxytag="NLSOUND::CContextSound::_Looping" ></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"> bool <a class="el" href="a02246.html#NLSOUND_1_1CSoundp5">NLSOUND::CSound::_Looping</a><code> [protected, inherited]</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="a06407.html#l00137">137</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00088">NLSOUND::CSound::getLooping()</a>, <a class="el" href="a06406.html#l00140">NLSOUND::CSound::importForm()</a>, <a class="el" href="a06406.html#l00114">NLSOUND::CSound::serial()</a>, and <a class="el" href="a06407.html#l00113">NLSOUND::CSound::setLooping()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp6" doxytag="NLSOUND::CContextSound::_MaxDist" ></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="a02246.html#NLSOUND_1_1CSoundp6">NLSOUND::CSound::_MaxDist</a><code> [protected, inherited]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Clipping distance for complex or backgound sound. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00140">140</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a05591.html#l00177">NLSOUND::CComplexSound::getMaxDistance()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp7" doxytag="NLSOUND::CContextSound::_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="a02246.html#NLSOUND_1_1CSoundp7">NLSOUND::CSound::_Name</a><code> [protected, inherited]</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="a06407.html#l00143">143</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00123">NLSOUND::CSound::operator<()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSoundr2" doxytag="NLSOUND::CContextSound::_PatternName" ></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::string <a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr2">NLSOUND::CContextSound::_PatternName</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The context sound pattern name. +<p> + +<p> +Definition at line <a class="el" href="a05612.html#l00313">313</a> of file <a class="el" href="a05612.html">context_sound.h</a>. +<p> +Referenced by <a class="el" href="a05611.html#l00067">importForm()</a>, <a class="el" href="a05611.html#l00165">init()</a>, and <a class="el" href="a05611.html#l00053">serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp8" doxytag="NLSOUND::CContextSound::_Pitch" ></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="a02246.html#NLSOUND_1_1CSoundp8">NLSOUND::CSound::_Pitch</a><code> [protected, inherited]</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="a06407.html#l00132">132</a> of file <a class="el" href="a06407.html">sound.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp9" doxytag="NLSOUND::CContextSound::_Priority" ></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="a05381.html#a82">TSoundPriority</a> <a class="el" href="a02246.html#NLSOUND_1_1CSoundp9">NLSOUND::CSound::_Priority</a><code> [protected, inherited]</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="a06407.html#l00133">133</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00094">NLSOUND::CSound::getPriority()</a>, <a class="el" href="a06406.html#l00140">NLSOUND::CSound::importForm()</a>, and <a class="el" href="a06406.html#l00114">NLSOUND::CSound::serial()</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CContextSoundr3" doxytag="NLSOUND::CContextSound::_Random" ></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="a04558.html#a11">uint32</a> <a class="el" href="a02417.html#NLSOUND_1_1CContextSoundr3">NLSOUND::CContextSound::_Random</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The random lenght (0 mean no random). +<p> + +<p> +Definition at line <a class="el" href="a05612.html#l00318">318</a> of file <a class="el" href="a05612.html">context_sound.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CSoundp10" doxytag="NLSOUND::CContextSound::_UserVarControler" ></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="a02246.html#NLSOUND_1_1CSoundp10">NLSOUND::CSound::_UserVarControler</a><code> [protected, inherited]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +An optional user var controler. +<p> + +<p> +Definition at line <a class="el" href="a06407.html#l00145">145</a> of file <a class="el" href="a06407.html">sound.h</a>. +<p> +Referenced by <a class="el" href="a06407.html#l00121">NLSOUND::CSound::getUserVarControler()</a>, and <a class="el" href="a05465.html#l00895">NLSOUND::CAudioMixerUser::initUserVar()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a05612.html">context_sound.h</a><li><a class="el" href="a05611.html">context_sound.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:37:50 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> |