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::Sound3DActor</title> 49 </head> 50 <body> 51 <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::Sound3DActor</CODE> Class</h1> 52 <div class="section"> 53 <b>Header file: </b>nw/snd/snd_Sound3DActor.h</div> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class Sound3DActor : <br /> public <a href="../../../nw/snd/SoundActor/Overview.html">nw::snd::SoundActor</a>,<br /> public nw::snd::internal::BasicSound::AmbientArgUpdateCallback</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>A 3D sound actor class used to represent an audio source within a 3D space.</p><p>A single actor can simultaneously manage multiple sounds.</p><p>During the time an actor instance exists, the <CODE><A href="../Sound3DManager/snd_Sound3DManager_Overview.html">nw::snd::Sound3DManager</A></CODE> class calculates and sets the sound's parameters, based on the position information set in the actor. If the instance of an actor ceases to exist, sound playback for that actor will continue, but the 3D parameters are no longer updated.</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="static_style" title="static">S</span> 68 </td> 69 <th> 70 <span class="argument"><a href="../../../nw/snd/SoundActor/ACTOR_PLAYER_COUNT.html"><CODE>ACTOR_PLAYER_COUNT</CODE></a></span> 71 </th> 72 <td width="100"><CODE>const int</CODE></td> 73 <td>The number of actor players that are retained.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 74 </tr> </table> 75 </div> 76 </a> <a name="function" id="function"> 77 <h2>Member Functions</h2> 78 <div class="section"> 79 <table class="members"> 80 <tr> 81 <th class="category" colspan="3">Constructors/Destructors</th> 82 </tr> 83 <tr> 84 <td width="100"> </td> 85 <th> 86 <a href="../../../nw/snd/Sound3DActor/Sound3DActor.html">Sound3DActor</a> 87 </th> 88 <td>Constructor.</td> 89 </tr> 90 <tr> 91 <td width="100"> <span class="virtual_style" title="virtual">V</span> 92 </td> 93 <th> 94 <a href="../../../nw/snd/Sound3DActor/~Sound3DActor.html">~Sound3DActor</a> 95 </th> 96 <td>Destructor.</td> 97 </tr> 98 <tr> 99 <th class="category" colspan="3">Initialization</th> 100 </tr> 101 <tr> 102 <td width="100"> </td> 103 <th> 104 <a href="../../../nw/snd/Sound3DActor/Initialize.html"><CODE>Initialize</CODE></a> 105 </th> 106 <td>Initializes the 3D sound actor.</td> 107 </tr> 108 <tr> 109 <td width="100"> </td> 110 <th> 111 <a href="../../../nw/snd/Sound3DActor/Finalize.html">Finalize</a> 112 </th> 113 <td>Destroys the 3D sound actor.</td> 114 </tr> 115 <tr> 116 <th class="category" colspan="3">Sets or gets position and velocity.</th> 117 </tr> 118 <tr> 119 <td width="100"> </td> 120 <th> 121 <a href="../../../nw/snd/Sound3DActor/SetPosition.html">SetPosition</a> 122 </th> 123 <td>This function sets actor position information.</td> 124 </tr> 125 <tr> 126 <td width="100"> </td> 127 <th> 128 <a href="../../../nw/snd/Sound3DActor/GetPosition.html">GetPosition</a> 129 </th> 130 <td>This function gets actor position information.</td> 131 </tr> 132 <tr> 133 <td width="100"> </td> 134 <th> 135 <a href="../../../nw/snd/Sound3DActor/ResetPosition.html">ResetPosition</a> 136 </th> 137 <td>Resets actor position information.</td> 138 </tr> 139 <tr> 140 <td width="100"> </td> 141 <th> 142 <a href="../../../nw/snd/Sound3DActor/SetVelocity.html">SetVelocity</a> 143 </th> 144 <td>This function sets an actor's velocity.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149 <a href="../../../nw/snd/Sound3DActor/GetVelocity.html">GetVelocity</a> 150 </th> 151 <td>Gets the actor's velocity.</td> 152 </tr> 153 <tr> 154 <th class="category" colspan="3">Setting, Getting Parameters</th> 155 </tr> 156 <tr> 157 <td width="100"> </td> 158 <th> 159 <a href="../../../nw/snd/Sound3DActor/SetUserParam.html">SetUserParam</a> 160 </th> 161 <td>Sets the user parameter for an actor.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166 <a href="../../../nw/snd/Sound3DActor/GetUserParam.html">GetUserParam</a> 167 </th> 168 <td>Gets the actor's user parameter.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173 <a href="../../../nw/snd/SoundActor/SetVolume.html">SetVolume</a> 174 </th> 175 <td>Changes the volume of the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180 <a href="../../../nw/snd/SoundActor/GetVolume.html"><CODE>GetVolume</CODE></a> 181 </th> 182 <td>Gets the volume set for the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 183 </tr> 184 <tr> 185 <td width="100"> </td> 186 <th> 187 <a href="../../../nw/snd/SoundActor/SetPitch.html">SetPitch</a> 188 </th> 189 <td>Changes the pitch of the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 190 </tr> 191 <tr> 192 <td width="100"> </td> 193 <th> 194 <a href="../../../nw/snd/SoundActor/GetPitch.html"><CODE>GetPitch</CODE></a> 195 </th> 196 <td>Gets the pitch set for the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 197 </tr> 198 <tr> 199 <td width="100"> </td> 200 <th> 201 <a href="../../../nw/snd/SoundActor/SetPan.html">SetPan</a> 202 </th> 203 <td>Changes the pan (left/right orientation) of the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 204 </tr> 205 <tr> 206 <td width="100"> </td> 207 <th> 208 <a href="../../../nw/snd/SoundActor/GetPan.html">GetPan</a> 209 </th> 210 <td>Gets the pan set for the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 211 </tr> 212 <tr> 213 <td width="100"> </td> 214 <th> 215 <a href="../../../nw/snd/SoundActor/GetPlayingSoundCount.html"><CODE>GetPlayingSoundCount</CODE></a> 216 </th> 217 <td>Returns the number of sounds currently playing in the actor player.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 218 </tr> 219 <tr> 220 <td width="100"> </td> 221 <th> 222 <a href="../../../nw/snd/SoundActor/SetPlayableSoundCount.html"><CODE>SetPlayableSoundCount</CODE></a> 223 </th> 224 <td>Sets the number of sounds that are simultaneously playable.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 225 </tr> 226 <tr> 227 <td width="100"> </td> 228 <th> 229 <a href="../../../nw/snd/SoundActor/GetPlayableSoundCount.html"><CODE>GetPlayableSoundCount</CODE></a> 230 </th> 231 <td>Gets the number of sounds that can be simultaneously played by the actor player.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 232 </tr> 233 <tr> 234 <th class="category" colspan="3">Play</th> 235 </tr> 236 <tr> 237 <td width="100"> </td> 238 <th> 239 <a href="../../../nw/snd/SoundActor/StopAllSound.html">StopAllSound</a> 240 </th> 241 <td>Stops all sounds currently playing on the actor.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 242 </tr> 243 <tr> 244 <td width="100"> </td> 245 <th> 246 <a href="../../../nw/snd/SoundActor/PauseAllSound.html">PauseAllSound</a> 247 </th> 248 <td>Pauses or restarts all sounds that the actor is currently playing.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253 <a href="../../../nw/snd/SoundStartable/StartSound.html"><CODE>StartSound</CODE></a> 254 </th> 255 <td>Plays the sound having the specified ID.(Inherited from <a href="../../../nw/snd/SoundStartable/Overview.html"><CODE>SoundStartable</CODE></a>.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../../nw/snd/SoundStartable/HoldSound.html"><CODE>HoldSound</CODE></a> 261 </th> 262 <td>Plays or continues the sound with the specified ID.(Inherited from <a href="../../../nw/snd/SoundStartable/Overview.html"><CODE>SoundStartable</CODE></a>.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267 <a href="../../../nw/snd/SoundStartable/PrepareSound.html"><CODE>PrepareSound</CODE></a> 268 </th> 269 <td>Prepares to play the sound with the specified ID.(Inherited from <a href="../../../nw/snd/SoundStartable/Overview.html"><CODE>SoundStartable</CODE></a>.</td> 270 </tr> 271 <tr> 272 <th class="category" colspan="3">Other</th> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277 <a href="../../../nw/snd/SoundActor/ForEachSound.html">ForEachSound</a> 278 </th> 279 <td>Performs processing for all sounds that the actor is currently playing.(Inherited from <a href="../../../nw/snd/SoundArchive/Overview.html"><CODE>SoundArchive</CODE></a>.)</td> 280 </tr> 281 <tr> 282 <td width="100"> 283 <span class="protected_style" title="protected">protected</span> <span class="virtual_style" title="virtual">V</span> 284 </td> 285 <th> 286 <a href="../../../nw/snd/Sound3DActor/SetupSound.html"><CODE>SetupSound</CODE></a> 287 </th> 288 <td>Virtual function called when a sound is played.</td> 289 </tr> </table> 290 </div> 291 </a> 292 <h2>Class Hierarchy</h2> 293 <div class="section"> 294 <p class="hierarchy"><a href="../../../nw/snd/SoundStartable/Overview.html">nw::snd::SoundStartable</a><br /> <a href="../../../nw/snd/SoundActor/Overview.html">nw::snd::SoundActor</a><br /> <b>nw::snd::Sound3DActor</b> 295 </p> 296 </div> 297 <h2>See Also</h2> 298 <div class="section"> 299 <p class="reference"><CODE>Sound3DManager</CODE> Class </p> 300 </div> 301 <h2>Revision History</h2> 302 <div class="section"> 303 <dl class="history"> 304 <dt>2010/02/25</dt> 305 <dd>Initial version.<br /> 306 </dd> 307 </dl> 308 </div> 309 <hr><p>CONFIDENTIAL</p></body> 310</html> 311