VertexTangentsHelper.html 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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:Object3D] &rarr; [page:Line] &rarr; [page:LineSegments] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">
  14. Renders arrows to visualize an object's vertex tangent vectors.
  15. Requires that tangents have been specified in a [page:BufferAttribute custom attribute] or
  16. have been calculated using [page:BufferGeometryUtils.computeTangents computeTangents].<br /><br />
  17. This helper supports [page:BufferGeometry] only.
  18. </p>
  19. <h2>Code Example</h2>
  20. <code>
  21. var geometry = new THREE.BoxBufferGeometry( 10, 10, 10, 2, 2, 2 );
  22. var material = new THREE.MeshNormalMaterial();
  23. var box = new THREE.Mesh( geometry, material );
  24. var helper = new VertexTangentsHelper( box, 1, 0x00ffff, 1 );
  25. scene.add( box );
  26. scene.add( helper );
  27. </code>
  28. <h2>Examples</h2>
  29. <p>
  30. [example:webgl_helpers WebGL / helpers]
  31. </p>
  32. <h2>Constructor</h2>
  33. <h3>[name]( [param:Object3D object], [param:Number size], [param:Hex color], [param:Number linewidth] )</h3>
  34. <p>
  35. [page:Object3D object] -- object for which to render vertex tangents.<br />
  36. [page:Number size] -- (optional) length of the arrows. Default is *1*.<br />
  37. [page:Hex color] -- hex color of the arrows. Default is 0x00ffff.<br />
  38. [page:Number linewidth] -- (optional) width of the arrow lines. Default is *1*. (Setting lineWidth is currently not supported.)
  39. </p>
  40. <h2>Properties</h2>
  41. <p>See the base [page:LineSegments] class for common properties.</p>
  42. <h3>[property:object matrixAutoUpdate]</h3>
  43. <p>
  44. See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
  45. objects's [page:Object3D.matrixWorld matrixWorld].
  46. </p>
  47. <h3>[property:Object3D object]</h3>
  48. <p>The object for which the vertex tangents are being visualized.</p>
  49. <h3>[property:Number size]</h3>
  50. <p>Length of the arrows. Default is *1*.</p>
  51. <h2>Methods</h2>
  52. <p>See the base [page:LineSegments] class for common methods.</p>
  53. <h3>[method:null update]()</h3>
  54. <p>Updates the vertex tangents preview based on the object's world transform.</p>
  55. <h2>Source</h2>
  56. <p>
  57. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/VertexTangentsHelper.js examples/jsm/helpers/VertexTangentsHelper.js]
  58. </p>
  59. </body>
  60. </html>