| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>AxesHelper - 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">AxesHelper</h1>
- <section>
- <header>
- <div class="class-description"><p>An axis object to visualize the 3 axes in a simple way.
- The X axis is red. The Y axis is green. The Z axis is blue.</p></div>
- <h2>Code Example</h2>
- <div translate="no"><pre><code class="language-js">const axesHelper = new THREE.AxesHelper( 5 );
- scene.add( axesHelper );
- </code></pre></div>
- </header>
- <article>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="AxesHelper" translate="no">new <a href="#AxesHelper">AxesHelper</a><span class="signature">( size : <span class="param-type">number</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new axes helper.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>size</code></td>
- <td class="description last"><p>Size of the lines representing the axes.<br/>Default is <code>1</code>.</p></td>
- </tr>
- </tbody>
- </table>
- </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="setColors" translate="no">.<a href="#setColors">setColors</a><span class="signature">( xAxisColor : <span class="param-type">number | Color | string</span>, yAxisColor : <span class="param-type">number | Color | string</span>, zAxisColor : <span class="param-type">number | Color | string</span> )</span><span class="type-signature"> : <a href="AxesHelper.html">AxesHelper</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Defines the colors of the axes helper.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>xAxisColor</code></td>
- <td class="description last"><p>The color for the x axis.</p></td>
- </tr>
- <tr>
- <td class="name"><code>yAxisColor</code></td>
- <td class="description last"><p>The color for the y axis.</p></td>
- </tr>
- <tr>
- <td class="name"><code>zAxisColor</code></td>
- <td class="description last"><p>The color for the z axis.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A reference to this axes helper.</dt>
- </dl>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/src/helpers/AxesHelper.js" target="_blank" rel="noopener" translate="no">src/helpers/AxesHelper.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|
