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 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nw::snd::Sound3DParam</title> 51 </head> 52 <body> 53 <h1>nw::snd::Sound3DParam Structure</h1> 54 <div class="section"> 55 <b>Header file: </b>nw/snd/snd_Sound3DManager.h</div> 56 <h2>Syntax</h2> 57 <div class="section"> 58 <pre class="definition">struct Sound3DParam 59{ 60 math::VEC3 position; 61 math::VEC3 velocity; 62 <span>u32</span> ctrlFlag; 63 <span>u32</span> actorUserParam; 64 <span>u32</span> soundUserParam; 65 <span>f32</span> decayRatio; 66 <span>u8</span> decayCurve; 67 <span>u8</span> dopplerFactor; 68}; 69</pre> 70 </div> 71 <h2>Description</h2> 72 <div class="section"> 73 <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> 74 <a name="variable" id="variable"> 75 <h2>Member Variables</h2> 76 <div class="section"> 77 <table class="members"> 78 <tr> 79 <td width="100"> </td> 80 <th> 81 <span class="argument">position</span> 82 </th> 83 <td>The 3D sound actor's current position.</td> 84 </tr> 85 <tr> 86 <td width="100"> </td> 87 <th> 88 <span class="argument"><CODE><STRONG><EM>velocity</EM></STRONG></CODE></span> 89 </th> 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>Parameter control flag Used internally by the sound library.</td> 98 </tr> 99 <tr> 100 <td width="100"> </td> 101 <th> 102 <span class="argument">actorUserParam</span> 103 </th> 104 <td>The user parameter set for the actor.</td> 105 </tr> 106 <tr> 107 <td width="100"> </td> 108 <th> 109 <span class="argument">soundUserParam</span> 110 </th> 111 <td>The user parameter set for the sound.</td> 112 </tr> 113 <tr> 114 <td width="100"> </td> 115 <th> 116 <span class="argument">decayRatio</span> 117 </th> 118 <td>The decay rate of the sound when the actor and listener are separated by a sound decay unit of distance.</td> 119 </tr> 120 <tr> 121 <td width="100"> </td> 122 <th> 123 <span class="argument">decayCurve</span> 124 </th> 125 <td>The type of the volume attenuation curve. Sets the value of <a href="../../../nw/snd/DecayCurve.html">DecayCurve</a>.</td> 126 </tr> 127 <tr> 128 <td width="100"> </td> 129 <th> 130 <span class="argument">dopplerFactor</span> 131 </th> 132 <td>The Doppler factor.</td> 133 </tr> </table> 134 </div> 135 </a> <a name="function" id="function"> 136 <h2>Member Functions</h2> 137 <div class="section"> 138 <table class="members"> 139 <tr> 140 <td width="100"> </td> 141 <th> 142 <a href="../../../nw/snd/Sound3DParam/Sound3DParam.html">Sound3DParam</a> 143 </th> 144 <td>Constructor.</td> 145 </tr> </table> 146 </div> 147 </a> 148 <h2>See Also</h2> 149 <div class="section"> 150 <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> 151 </div> 152 <h2>Revision History</h2> 153 <div class="section"> 154 <dl class="history"> 155 <dt>2010/03/12</dt> 156 <dd>Initial version.<br /> 157 </dd> 158 </dl> 159 </div> 160 <hr><p>CONFIDENTIAL</p></body> 161</html>