ArrowHelper.html 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <script src="../../../list.js"></script>
  6. <script src="../../../page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="../../../page.css" />
  8. </head>
  9. <body>
  10. [page:Object3D] &rarr;
  11. <h1>[name]</h1>
  12. <div class="desc">An 3D arrow Object.</div>
  13. <h2>Example</h2>
  14. <code>var dir = new THREE.Vector3( 1, 0, 0 );
  15. var origin = new THREE.Vector3( 0, 0, 0 );
  16. var length = 1;
  17. var hex = 0xffff00;
  18. var arrowHelper = new THREE.ArrowHelper( dir, origin, length, hex );
  19. scene.add( arrowHelper );
  20. </code>
  21. <h2>Constructor</h2>
  22. <h3>[name]([page:Vector3 dir], [page:Vector3 origin], [page:Number length], [page:Number hex], [page:Number headLength], [page:Number headWidth] )</h3>
  23. <div>
  24. dir -- Vector3 -- direction from origin. Must be a unit vector. <br />
  25. origin -- Vector3 <br />
  26. length -- scalar <br />
  27. hex -- hexadecimal value to define color ex:0xffff00<br />
  28. headLength -- The length of the head of the arrow<br />
  29. headWidth -- The length of the width of the arrow
  30. </div>
  31. <div>
  32. This creates an arrow starting in origin in the direction dir for a certain length. It is also possible to change color.
  33. </div>
  34. <h2>Properties</h2>
  35. <h3>[property:Line line]</h3>
  36. <div>
  37. Contains the line part of the arrowHelper.
  38. </div>
  39. <h3>[property:Mesh cone]</h3>
  40. <div>
  41. Contains the cone part of the arrowHelper.
  42. </div>
  43. <h2>Methods</h2>
  44. <h3>[method:null setColor]([page:Number hex])</h3>
  45. <div>
  46. hex -- The hexadicmal value of the color
  47. </div>
  48. <div>
  49. Sets the color of the arrowHelper.
  50. </div>
  51. <h3>[method:null setLength]([page:Number length], [page:Number headLength], [page:Number headWidth])</h3>
  52. <div>
  53. length -- The desired length<br />
  54. headLength -- The length of the head of the arrow<br />
  55. headWidth -- The length of the width of the arrow
  56. </div>
  57. <div>
  58. Sets the length of the arrowhelper.
  59. </div>
  60. <h3>[method:null setDirection]([page:Vector3 dir])</h3>
  61. <div>
  62. dir -- The desired direction in euler format.
  63. </div>
  64. <div>
  65. Sets the direction of the arrowhelper.
  66. </div>
  67. <h2>Source</h2>
  68. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  69. </body>
  70. </html>