| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>SelectionHelper - Three.js Docs</title>
- <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
- <script src="../scripts/highlight.min.js"></script>
- <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
- <link type="text/css" rel="stylesheet" href="../styles/page.css">
- </head>
- <body>
- <h1 translate="no">SelectionHelper</h1>
- <section>
- <header>
- <div class="class-description"><p>A helper for <a href="SelectionBox.html">SelectionBox</a>.</p>
- <p>It visualizes the current selection box with a <code>div</code> container element.</p></div>
- </header>
- <article>
- <h2 class="subsection-title">Import</h2>
- <p><span translate="no">SelectionHelper</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
- <pre><code class="language-js">import { SelectionHelper } from 'three/addons/interactive/SelectionHelper.js';</code></pre>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="SelectionHelper" translate="no">new <a href="#SelectionHelper">SelectionHelper</a><span class="signature">( renderer : <span class="param-type">WebGPURenderer | WebGLRenderer</span>, cssClassName : <span class="param-type">string</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new selection helper.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>renderer</code></td>
- <td class="description last"><p>The renderer.</p></td>
- </tr>
- <tr>
- <td class="name"><code>cssClassName</code></td>
- <td class="description last"><p>The CSS class name of the <code>div</code>.</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <h3 class="name" id="element" translate="no">.<a href="#element">element</a><span class="type-signature"> : HTMLDivElement</span> </h3>
- <div class="description">
- <p>The visualization of the selection box.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="enabled" translate="no">.<a href="#enabled">enabled</a><span class="type-signature"> : boolean</span> </h3>
- <div class="description">
- <p>Whether helper is enabled or not.<br/>Default is <code>true</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="isDown" translate="no">.<a href="#isDown">isDown</a><span class="type-signature"> : boolean</span> </h3>
- <div class="description">
- <p>Whether the mouse or pointer is pressed down.<br/>Default is <code>false</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="renderer" translate="no">.<a href="#renderer">renderer</a><span class="type-signature"> : <a href="WebGPURenderer.html">WebGPURenderer</a> | <a href="WebGLRenderer.html">WebGLRenderer</a></span> </h3>
- <div class="description">
- <p>A reference to the renderer.</p>
- </div>
- </div>
- <h2 class="subsection-title">Methods</h2>
- <h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
- <div class="method">
- <div class="description">
- <p>Call this method if you no longer want use to the controls. It frees all internal
- resources and removes all event listeners.</p>
- </div>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/interactive/SelectionHelper.js" target="_blank" rel="noopener" translate="no">examples/jsm/interactive/SelectionHelper.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|
