PositionalAudioHelper.html 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:Object3D] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">This helper displays the directional cone of a [page:PositionalAudio].</p>
  14. <h2>Example</h2>
  15. <div>[example:webaudio_orientation webaudio / orientation ]</div>
  16. <h2>Code Example</h2>
  17. <code>
  18. var positionalAudio = new THREE.PositionalAudio( listener );
  19. positionalAudio.setDirectionalCone( 180, 230, 0.1 );
  20. var helper = new PositionalAudioHelper( positionalAudio );
  21. positionalAudio.add( helper );
  22. </code>
  23. <h2>Constructor</h2>
  24. <h3>[name]( [param:PositionalAudio audio], [param:Number range] )</h3>
  25. <p>
  26. [page:PositionalAudio audio] -- The [page:PositionalAudio] to be visualized. <br /><br/>
  27. [page:Number range] -- (optional) The range of the directional cone. <br /><br/>
  28. [page:Number divisionsInnerAngle] -- (optional) The amount of divisions of the inner part of the directional cone. <br /><br/>
  29. [page:Number divisionsOuterAngle] -- (optional) The amount of divisions of the outer part of the directional cone. <br /><br/>
  30. </p>
  31. <h2>Properties</h2>
  32. <p>See the base [page:Object3D] class for common properties.</p>
  33. <h3>[property:PositionalAudio audio]</h3>
  34. <p>[page:PositionalAudio] to be visualized.</p>
  35. <h3>[property:Number range]</h3>
  36. <p>The range of the directional cone.</p>
  37. <h3>[property:Number divisionsInnerAngle]</h3>
  38. <p>The amount of divisions of the inner part of the directional cone.</p>
  39. <h3>[property:Number divisionsOuterAngle]</h3>
  40. <p>The amount of divisions of the outer part of the directional cone.</p>
  41. <h2>Methods</h2>
  42. <p>See the base [page:Object3D] class for common methods.</p>
  43. <h3>[method:null dispose]()</h3>
  44. <p>Disposes of the helper.</p>
  45. <h3>[method:null update]()</h3>
  46. <p>Updates the helper.</p>
  47. <h2>Source</h2>
  48. <p>
  49. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/PositionalAudioHelper.js examples/jsm/helpers/PositionalAudioHelper.js]
  50. </p>
  51. </body>
  52. </html>