1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48 <title>nw::snd::Sound3DParam</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::Sound3DParam</CODE> Structure</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_Sound3DManager.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">struct Sound3DParam 57{ 58 math::VEC3 position; 59 math::VEC3 velocity; 60 <span>u32</span> ctrlFlag; 61 <span>u32</span> actorUserParam; 62 <span>u32</span> soundUserParam; 63 <span>f32</span> decayRatio; 64 <span>u8</span> decayCurve; 65 <span>u8</span> dopplerFactor; 66}; 67</pre> 68 </div> 69 <h2>Description</h2> 70 <div class="section"> 71 <p>These are 3D sound parameters.</p><p>3D sound is calculated using these parameters.</p><p>Values set for each sound using SoundMaker are assigned to ctrlFlag, decayCurve, decayRatio, dopplerFactor and soundUserParam.</p><p>actorUserParam is assigned the value set for <a href="../../../nw/snd/Sound3DActor/SetUserParam.html">Sound3DActor::SetUserParam</a>.</p><p>dopplerFactor represents the application of the Doppler effect. Sound does not change when 0. The later the value, the greater the change.</p></div> 72 <a name="variable" id="variable"> 73 <h2>Member Variables</h2> 74 <div class="section"> 75 <table class="members"> 76 <tr> 77 <td width="100"> </td> 78 <th> 79 <span class="argument">position</span> 80 </th> 81 <td width="100">math::VEC3</td> 82 <td>The 3D sound actor's current position.</td> 83 </tr> 84 <tr> 85 <td width="100"> </td> 86 <th> 87 <span class="argument"><CODE><STRONG><EM>velocity</EM></STRONG></CODE></span> 88 </th> 89 <td width="100">math::VEC3</td> 90 <td>The 3D sound actor's velocity.</td> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95 <span class="argument">ctrlFlag</span> 96 </th> 97 <td width="100"><span>u32</span></td> 98 <td>Parameter control flag Used internally by the sound library.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <span class="argument">actorUserParam</span> 104 </th> 105 <td width="100"><span>u32</span></td> 106 <td>The user parameter set for the actor.</td> 107 </tr> 108 <tr> 109 <td width="100"> </td> 110 <th> 111 <span class="argument">soundUserParam</span> 112 </th> 113 <td width="100"><span>u32</span></td> 114 <td>The user parameter set for the sound.</td> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119 <span class="argument">decayRatio</span> 120 </th> 121 <td width="100"><span>f32</span></td> 122 <td>The attenuation rate of the sound when the actor and listener are separated by one volume attenuation unit of distance.</td> 123 </tr> 124 <tr> 125 <td width="100"> </td> 126 <th> 127 <span class="argument">decayCurve</span> 128 </th> 129 <td width="100"><span>u8</span></td> 130 <td>The type of the volume attenuation curve. Sets the value of <a href="../../../nw/snd/DecayCurve.html">DecayCurve</a>.</td> 131 </tr> 132 <tr> 133 <td width="100"> </td> 134 <th> 135 <span class="argument">dopplerFactor</span> 136 </th> 137 <td width="100"><span>u8</span></td> 138 <td>The Doppler factor.</td> 139 </tr> </table> 140 </div> 141 </a> <a name="function" id="function"> 142 <h2>Member Functions</h2> 143 <div class="section"> 144 <table class="members"> 145 <tr> 146 <td width="100"> </td> 147 <th> 148 <a href="../../../nw/snd/Sound3DParam/Sound3DParam.html">Sound3DParam</a> 149 </th> 150 <td>Constructor.</td> 151 </tr> </table> 152 </div> 153 </a> 154 <h2>See Also</h2> 155 <div class="section"> 156 <p class="reference"><a href="../../../nw/snd/Sound3DEngine/UpdateAmbientParam.html">Sound3DEngine::UpdateAmbientParam</a><br /><a href="../../../nw/snd/Sound3DActor/SetUserParam.html">Sound3DActor::SetUserParam</a><br /><a href="../../../nw/snd/DecayCurve.html">DecayCurve</a><br />nw::math::VEC3<br /> </p> 157 </div> 158 <h2>Revision History</h2> 159 <div class="section"> 160 <dl class="history"> 161 <dt>2010/03/12</dt> 162 <dd>Initial version.<br /> 163 </dd> 164 </dl> 165 </div> 166 <hr><p>CONFIDENTIAL</p></body> 167</html> 168