AxesHelper.html 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:Object3D] &rarr; [page:Line] &rarr; [page:LineSegments] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">An axis object to visualize the 3 axes in a simple way. <br />
  13. The X axis is red. The Y axis is green. The Z axis is blue.
  14. </p>
  15. <h2>Code Example</h2>
  16. <code>
  17. const axesHelper = new THREE.AxesHelper( 5 );
  18. scene.add( axesHelper );
  19. </code>
  20. <h2>Examples</h2>
  21. <p>
  22. [example:webgl_buffergeometry_compression WebGL / buffergeometry / compression]<br/>
  23. [example:webgl_geometry_convex WebGL / geometry / convex]<br/>
  24. [example:webgl_loader_nrrd WebGL / loader / nrrd]
  25. </p>
  26. <h2>Constructor</h2>
  27. <h3>[name]( [param:Number size] )</h3>
  28. <p>
  29. [page:Number size] -- (optional) size of the lines representing the axes. Default is `1`.
  30. </p>
  31. <h2>Properties</h2>
  32. <p>See the base [page:LineSegments] class for common properties.</p>
  33. <h2>Methods</h2>
  34. <p>See the base [page:LineSegments] class for common methods.</p>
  35. <h3>[method:this setColors]( [param:Color xAxisColor], [param:Color yAxisColor], [param:Color zAxisColor] )</h3>
  36. <p>
  37. Sets the axes colors to [page:Color xAxisColor], [page:Color yAxisColor], [page:Color zAxisColor].
  38. </p>
  39. <h3>[method:undefined dispose]()</h3>
  40. <p>
  41. Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
  42. </p>
  43. <h2>Source</h2>
  44. <p>
  45. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  46. </p>
  47. </body>
  48. </html>