VertexNormalsHelper.html 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:Line] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">
  14. Renders [page:ArrowHelper arrows] to visualize an object's vertex normal vectors.
  15. Requires that normals have been specified in a [page:BufferAttribute custom attribute] or
  16. have been calculated using [page:Geometry.computeVertexNormals computeVertexNormals].<br /><br />
  17. Unlike [page:FaceNormalsHelper], this works with [page:BufferGeometry].
  18. </p>
  19. <h2>Example</h2>
  20. [example:webgl_helpers WebGL / helpers]
  21. <code>
  22. var geometry = new THREE.BoxGeometry( 10, 10, 10, 2, 2, 2 );
  23. var material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
  24. var box = new THREE.Mesh( geometry, material );
  25. var helper = new THREE.VertexNormalsHelper( box, 2, 0x00ff00, 1 );
  26. scene.add( box );
  27. scene.add( helper );
  28. </code>
  29. <h2>Constructor</h2>
  30. <h3>[name]( [param:Object3D object], [param:Number size], [param:Hex color], [param:Number linewidth] )</h3>
  31. <p>
  32. [page:Object3D object] -- object for which to render vertex normals.<br />
  33. [page:Number size] -- (optional) length of the arrows. Default is 1.<br />
  34. [page:Hex color] -- hex color of the arrows. Default is 0xff0000.<br />
  35. [page:Number linewidth] -- (optional) width of the arrow lines. Default is 1.
  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. objects'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:null update]()</h3>
  51. <p>Updates the vertex normal preview based on movement of the object.</p>
  52. <h2>Source</h2>
  53. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  54. </body>
  55. </html>