VertexNormalsHelper.html 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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">
  13. Visualizes an object's vertex normals.
  14. Requires that normals have been specified in a [page:BufferAttribute custom attribute] or
  15. have been calculated using [page:BufferGeometry.computeVertexNormals computeVertexNormals].<br /><br />
  16. </p>
  17. <h2>Code Example</h2>
  18. <code>
  19. const geometry = new THREE.BoxGeometry( 10, 10, 10, 2, 2, 2 );
  20. const material = new THREE.MeshStandardMaterial();
  21. const mesh = new THREE.Mesh( geometry, material );
  22. const helper = new VertexNormalsHelper( mesh, 1, 0xff0000 );
  23. scene.add( mesh );
  24. scene.add( helper );
  25. </code>
  26. <h2>Examples</h2>
  27. <p>
  28. [example:webgl_helpers WebGL / helpers]
  29. </p>
  30. <h2>Constructor</h2>
  31. <h3>[name]( [param:Object3D object], [param:Number size], [param:Hex color] )</h3>
  32. <p>
  33. [page:Object3D object] -- object for which to render vertex normals.<br />
  34. [page:Number size] -- (optional) length of the arrows. Default is *1*.<br />
  35. [page:Hex color] -- (optional) hex color of the arrows. Default is *0xff0000*.
  36. </p>
  37. <h2>Properties</h2>
  38. <p>See the base [page:LineSegments] class for common properties.</p>
  39. <h3>[property:Object matrixAutoUpdate]</h3>
  40. <p>
  41. See [page:Object3D.matrixAutoUpdate]. Set to `false` here as the helper is using the
  42. object's [page:Object3D.matrixWorld matrixWorld].
  43. </p>
  44. <h3>[property:Object3D object]</h3>
  45. <p>The object for which the vertex normals are being visualized.</p>
  46. <h3>[property:Number size]</h3>
  47. <p>Length of the arrows. Default is *1*.</p>
  48. <h2>Methods</h2>
  49. <p>See the base [page:LineSegments] class for common methods.</p>
  50. <h3>[method:undefined update]()</h3>
  51. <p>Updates the vertex tangents preview based on the object's world transform.</p>
  52. <h3>[method:undefined dispose]()</h3>
  53. <p>
  54. Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
  55. </p>
  56. <h2>Source</h2>
  57. <p>
  58. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/VertexNormalsHelper.js examples/jsm/helpers/VertexNormalsHelper.js]
  59. </p>
  60. </body>
  61. </html>