1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8" />
- <base href="../../../" />
- <script src="page.js"></script>
- <link type="text/css" rel="stylesheet" href="page.css" />
- </head>
- <body>
- [page:Object3D] → [page:Line] →
- <h1>[name]</h1>
- <p class="desc">This helper displays the directional cone of a [page:PositionalAudio].</p>
- <h2>Import</h2>
- <p>
- [name] is an add-on, and must be imported explicitly.
- See [link:#manual/introduction/Installation Installation / Addons].
- </p>
- <code>
- import { PositionalAudioHelper } from 'three/addons/helpers/PositionalAudioHelper.js';
- </code>
- <h2>Code Example</h2>
- <code>
- const positionalAudio = new THREE.PositionalAudio( listener );
- positionalAudio.setDirectionalCone( 180, 230, 0.1 );
- const helper = new PositionalAudioHelper( positionalAudio );
- positionalAudio.add( helper );
- </code>
- <h2>Examples</h2>
- <div>[example:webaudio_orientation webaudio / orientation ]</div>
- <h2>Constructor</h2>
- <h3>[name]( [param:PositionalAudio audio], [param:Number range] )</h3>
- <p>
- [page:PositionalAudio audio] -- The [page:PositionalAudio] to be visualized. <br /><br/>
- [page:Number range] -- (optional) The range of the directional cone. <br /><br/>
- [page:Number divisionsInnerAngle] -- (optional) The amount of divisions of the inner part of the directional cone. <br /><br/>
- [page:Number divisionsOuterAngle] -- (optional) The amount of divisions of the outer part of the directional cone. <br /><br/>
- </p>
- <h2>Properties</h2>
- <p>See the base [page:Object3D] class for common properties.</p>
- <h3>[property:PositionalAudio audio]</h3>
- <p>[page:PositionalAudio] to be visualized.</p>
- <h3>[property:Number range]</h3>
- <p>The range of the directional cone.</p>
- <h3>[property:Number divisionsInnerAngle]</h3>
- <p>The amount of divisions of the inner part of the directional cone.</p>
- <h3>[property:Number divisionsOuterAngle]</h3>
- <p>The amount of divisions of the outer part of the directional cone.</p>
- <h2>Methods</h2>
- <p>See the base [page:Line] class for common methods.</p>
- <h3>[method:undefined update]()</h3>
- <p>Updates the helper.</p>
- <h3>[method:undefined dispose]()</h3>
- <p>
- Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
- </p>
- <h2>Source</h2>
- <p>
- [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/PositionalAudioHelper.js examples/jsm/helpers/PositionalAudioHelper.js]
- </p>
- </body>
- </html>
|