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::Sound3DEngine</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::Sound3DEngine</CODE> Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_Sound3DEngine.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class Sound3DEngine : public nw::snd::internal::ISound3DEngine</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A parameter calculation engine class for 3D sounds.</p><p>Calculates various types of parameters set for sounds, such as volume and pan, from the position information of 3D sound actors and 3D sound listeners, among other information. Standard parameter calculations for 3D sounds are defined in this class.</p><p>An initialized instance of this class is registered in 3D Sound Manager.</p><p>If you wish to customize the 3D sound engine, you can inherit from this class and create a unique engine class. By registering it with the 3D Sound Manager in <a href="../../../nw/snd/Sound3DManager/SetEngine.html">Sound3DManager::SetEngine</a>, a customized engine class can be used in place of the default engine class.</p></div> 61 <a name="constant" id="constant"> 62 <h2>Member Constants</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> 67 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> 68 </td> 69 <th> 70 <span class="argument"><a href="../../../nw/snd/Sound3DEngine/UPDATE_VOLUME.html">UPDATE_VOLUME</a></span> 71 </th> 72 <td width="100"><CODE>const <span>u32</span></CODE></td> 73 <td>Flag indicating that a volume calculation using UpdateAmbientParam is required.</td> 74 </tr> 75 <tr> 76 <td width="100"> 77 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> 78 </td> 79 <th> 80 <span class="argument"><a href="../../../nw/snd/Sound3DEngine/UPDATE_PRIORITY.html">UPDATE_PRIORITY</a></span> 81 </th> 82 <td width="100"><CODE>const <span>u32</span></CODE></td> 83 <td>Flag indicating that a priority calculation using UpdateAmbientParam is required.</td> 84 </tr> 85 <tr> 86 <td width="100"> 87 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> 88 </td> 89 <th> 90 <span class="argument"><a href="../../../nw/snd/Sound3DEngine/UPDATE_PAN.html">UPDATE_PAN</a></span> 91 </th> 92 <td width="100"><CODE>const <span>u32</span></CODE></td> 93 <td>Flag indicating that a pan calculation using UpdateAmbientParam is required.</td> 94 </tr> 95 <tr> 96 <td width="100"> 97 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> 98 </td> 99 <th> 100 <span class="argument"><a href="../../../nw/snd/Sound3DEngine/UPDATE_PITCH.html">UPDATE_PITCH</a></span> 101 </th> 102 <td width="100"><CODE>const <span>u32</span></CODE></td> 103 <td>Flag indicating that a pitch calculation using UpdateAmbientParam is required.</td> 104 </tr> 105 <tr> 106 <td width="100"> 107 <span class="protected_style" title="protected">protected</span> <span class="static_style" title="static">S</span> 108 </td> 109 <th> 110 <span class="argument"><a href="../../../nw/snd/Sound3DEngine/UPDATE_START_PRIORITY.html">UPDATE_START_PRIORITY</a></span> 111 </th> 112 <td width="100"><CODE>const <span>u32</span></CODE></td> 113 <td>Flag indicating that UpdateAmbientParam has been called to calculate priority before the sound starts.</td> 114 </tr> </table> 115 </div> 116 </a> <a name="function" id="function"> 117 <h2>Member Functions</h2> 118 <div class="section"> 119 <table class="members"> 120 <tr> 121 <th class="category" colspan="3">Constructors/Destructors</th> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126 <a href="../../../nw/snd/Sound3DEngine/Sound3DEngine.html">Sound3DEngine</a> 127 </th> 128 <td>Constructor.</td> 129 </tr> 130 <tr> 131 <td width="100"> <span class="virtual_style" title="virtual">V</span> 132 </td> 133 <th> 134 <a href="../../../nw/snd/Sound3DEngine/~Sound3DEngine.html">~Sound3DEngine</a> 135 </th> 136 <td>Destructor.</td> 137 </tr> 138 <tr> 139 <th class="category" colspan="3">Settings</th> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144 <a href="../../../nw/snd/Sound3DEngine/SetCalcPanParam.html">SetCalcPanParam</a> 145 </th> 146 <td>Sets the parameter structure for pan calculation.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151 <a href="../../../nw/snd/Sound3DEngine/GetCalcPanParam.html">GetCalcPanParam</a> 152 </th> 153 <td>Gets the pan calculation parameter structure that is currently set.</td> 154 </tr> 155 <tr> 156 <th class="category" colspan="3">Parameters</th> 157 </tr> 158 <tr> 159 <td width="100"> 160 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 161 </td> 162 <th> 163 <a href="../../../nw/snd/Sound3DEngine/UpdateAmbientParam.html">UpdateAmbientParam</a> 164 </th> 165 <td>Calculates 3D sound parameters.</td> 166 </tr> </table> 167 </div> 168 </a> 169 <h2>Class Hierarchy</h2> 170 <div class="section"> 171 <p class="hierarchy">nw::snd::internal::ISound3DEngine<br /> <b>nw::snd::Sound3DEngine</b> 172 </p> 173 </div> 174 <h2>See Also</h2> 175 <div class="section"> 176 <p class="reference"><a href="../../../nw/snd/Sound3DManager/Overview.html"><CODE>Sound3DManager</CODE></a> Class<br /><CODE><a href="../../../nw/snd/Sound3DManager/SetEngine.html">Sound3DManager::SetEngine</a></CODE><br /> </p> 177 </div> 178 <h2>Revision History</h2> 179 <div class="section"> 180 <dl class="history"> 181 <dt>2010/03/12</dt> 182 <dd>Initial version.<br /> 183 </dd> 184 </dl> 185 </div> 186 <hr><p>CONFIDENTIAL</p></body> 187</html> 188