aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02365.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/a02365.html')
-rw-r--r--docs/doxygen/nel/a02365.html338
1 files changed, 338 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02365.html b/docs/doxygen/nel/a02365.html
new file mode 100644
index 00000000..86e3485a
--- /dev/null
+++ b/docs/doxygen/nel/a02365.html
@@ -0,0 +1,338 @@
+<!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::CClusteredSound::CClusterSoundStatus 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NLSOUND::CClusteredSound::CClusterSoundStatus Struct Reference</h1><code>#include &lt;<a class="el" href="a05566.html">clustered_sound.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+This structure contain data about sound status in a cluster.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00062">62</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.<table border=0 cellpadding=0 cellspacing=0>
+<tr><td></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="a03128.html">NLMISC::CVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso0">Direction</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The direction vector for the virtual sound source. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso0"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso1">Dist</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The distance from listener. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso1"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso2">DistFactor</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The ratio distance/max earing distance. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso2"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso3">Gain</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The relative gain of sound in the cluster. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso3"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a10">sint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso4">Obstruction</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The obsctruction att db. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso4"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a04558.html#a10">sint32</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso5">Occlusion</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The occlusion att. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso5"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso6">OcclusionLFFactor</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The occlusion LF factor (see EAX spec). <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso6"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso7">OcclusionRoomRatio</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The occlusion romm ration. <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso7"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso8">PosAlpha</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The blending factor between real sound pos and virtual pos (1 mean virtual pos, 0 mean real pos). <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso8"></a><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso9">Position</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The sound virtual position (in fact Dist * Direction). <a href="#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso9"></a><br><br></td></tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso0" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso0">NLSOUND::CClusteredSound::CClusterSoundStatus::Direction</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The direction vector for the virtual sound source.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00075">75</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00957">NLSOUND::CClusteredSound::addAudibleCluster()</a>, <a class="el" href="a06390.html#l00103">NLSOUND::CSimpleSource::getVirtualPos()</a>, <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso1" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::Dist" ></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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso1">NLSOUND::CClusteredSound::CClusterSoundStatus::Dist</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The distance from listener.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00067">67</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00957">NLSOUND::CClusteredSound::addAudibleCluster()</a>, <a class="el" href="a06390.html#l00103">NLSOUND::CSimpleSource::getVirtualPos()</a>, <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso2" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::DistFactor" ></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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso2">NLSOUND::CClusteredSound::CClusterSoundStatus::DistFactor</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The ratio distance/max earing distance.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00069">69</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, and <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso3" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso3">NLSOUND::CClusteredSound::CClusterSoundStatus::Gain</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The relative gain of sound in the cluster.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00065">65</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, <a class="el" href="a05565.html#l00270">NLSOUND::CClusteredSound::update()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso4" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::Obstruction" ></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#a10">sint32</a> <a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso4">NLSOUND::CClusteredSound::CClusterSoundStatus::Obstruction</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The obsctruction att db.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00083">83</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso5" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::Occlusion" ></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#a10">sint32</a> <a class="el" href="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso5">NLSOUND::CClusteredSound::CClusterSoundStatus::Occlusion</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The occlusion att.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00077">77</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso6" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionLFFactor" ></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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso6">NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionLFFactor</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The occlusion LF factor (see EAX spec).
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00079">79</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso7" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionRoomRatio" ></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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso7">NLSOUND::CClusteredSound::CClusterSoundStatus::OcclusionRoomRatio</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The occlusion romm ration.
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00081">81</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso8" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::PosAlpha" ></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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso8">NLSOUND::CClusteredSound::CClusterSoundStatus::PosAlpha</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The blending factor between real sound pos and virtual pos (1 mean virtual pos, 0 mean real pos).
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00073">73</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a06390.html#l00103">NLSOUND::CSimpleSource::getVirtualPos()</a>, <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, and <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso9" doxytag="NLSOUND::CClusteredSound::CClusterSoundStatus::Position" ></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="a02365.html#NLSOUND_1_1CClusteredSound_1_1CClusterSoundStatuso9">NLSOUND::CClusteredSound::CClusterSoundStatus::Position</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+The sound virtual position (in fact Dist * Direction).
+<p>
+
+<p>
+Definition at line <a class="el" href="a05566.html#l00071">71</a> of file <a class="el" href="a05566.html">clustered_sound.h</a>.
+<p>
+Referenced by <a class="el" href="a06390.html#l00103">NLSOUND::CSimpleSource::getVirtualPos()</a>, <a class="el" href="a05565.html#l00481">NLSOUND::CClusteredSound::soundTraverse()</a>, <a class="el" href="a05465.html#l01268">NLSOUND::CAudioMixerUser::update()</a>, and <a class="el" href="a05471.html#l00861">NLSOUND::CBackgroundSoundManager::updateBackgroundStatus()</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="a05566.html">clustered_sound.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:35:24 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>