| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>OctreeHelper - 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>
- <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → <a href="Line.html">Line</a> → <a href="LineSegments.html">LineSegments</a> → </p>
- <h1 translate="no">OctreeHelper</h1>
- <section>
- <header>
- <div class="class-description"><p>A helper for visualizing an Octree.</p></div>
- <h2>Code Example</h2>
- <div translate="no"><pre><code class="language-js">const helper = new OctreeHelper( octree );
- scene.add( helper );
- </code></pre></div>
- </header>
- <article>
- <h2 class="subsection-title">Import</h2>
- <p><span translate="no">OctreeHelper</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 { OctreeHelper } from 'three/addons/helpers/OctreeHelper.js';</code></pre>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="OctreeHelper" translate="no">new <a href="#OctreeHelper">OctreeHelper</a><span class="signature">( octree : <span class="param-type">Octree</span>, color : <span class="param-type">number | Color | string</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new Octree helper.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>octree</code></td>
- <td class="description last"><p>The octree to visualize.</p></td>
- </tr>
- <tr>
- <td class="name"><code>color</code></td>
- <td class="description last"><p>The helper's color.<br/>Default is <code>0xffff00</code>.</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <h3 class="name" id="color" translate="no">.<a href="#color">color</a><span class="type-signature"> : number | <a href="Color.html">Color</a> | string</span> </h3>
- <div class="description">
- <p>The helper's color.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="octree" translate="no">.<a href="#octree">octree</a><span class="type-signature"> : <a href="Octree.html">Octree</a></span> </h3>
- <div class="description">
- <p>The octree to visualize.</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>Frees the GPU-related resources allocated by this instance. Call this
- method whenever this instance is no longer used in your app.</p>
- </div>
- </div>
- <h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">()</span> </h3>
- <div class="method">
- <div class="description">
- <p>Updates the helper. This method must be called whenever the Octree's
- structure is changed.</p>
- </div>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/OctreeHelper.js" target="_blank" rel="noopener" translate="no">examples/jsm/helpers/OctreeHelper.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|
