Vector2.html 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  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. <h1>[name]</h1>
  11. <div class="desc">2D vector.</div>
  12. <h2>Example</h2>
  13. <code>var a = new THREE.Vector2( 0, 1 );
  14. var b = new THREE.Vector2( 1, 0 );
  15. var d = a.distanceTo( b );
  16. </code>
  17. <h2>Constructor</h2>
  18. <h3>[name]( [page:Float x], [page:Float y] )</h3>
  19. <div>
  20. x -- todo <br />
  21. y -- todo
  22. </div>
  23. <div>
  24. todo
  25. </div>
  26. <h2>Properties</h2>
  27. <h3>.[page:Float x]</h3>
  28. <h3>.[page:Float y]</h3>
  29. <h2>Methods</h2>
  30. <h3>.set( [page:Float x], [page:Float y] ) [page:Vector2]</h3>
  31. <div>
  32. Sets value of this vector.
  33. </div>
  34. <h3>.copy( [page:Vector2 v] ) [page:Vector2]</h3>
  35. <div>
  36. Copies value of *v* to this vector.
  37. </div>
  38. <h3>.add( [page:Vector2 v] ) [page:Vector2]</h3>
  39. <div>
  40. Adds *v* to this vector.
  41. </div>
  42. <h3>.addVectors( [page:Vector2 a], [page:Vector2 b] ) [page:Vector2]</h3>
  43. <div>
  44. Sets this vector to *a + b*.
  45. </div>
  46. <h3>.sub( [page:Vector2 v] ) [page:Vector2]</h3>
  47. <div>
  48. Subtracts *v* from this vector.
  49. </div>
  50. <h3>.subVectors( [page:Vector2 a], [page:Vector2 b] ) [page:Vector2]</h3>
  51. <div>
  52. Sets this vector to *a - b*.
  53. </div>
  54. <h3>.multiplyScalar( [page:Float s] ) [page:Vector2]</h3>
  55. <div>
  56. Multiplies this vector by scalar *s*.
  57. </div>
  58. <h3>.divideScalar( [page:Float s] ) [page:Vector2]</h3>
  59. <div>
  60. Divides this vector by scalar *s*.<br />
  61. Set vector to *( 0, 0 )* if *s == 0*.
  62. </div>
  63. <h3>.negate() [page:Vector2]</h3>
  64. <div>
  65. Inverts this vector.
  66. </div>
  67. <h3>.dot( [page:Vector2 v] ) [page:Float]</h3>
  68. <div>
  69. Computes dot product of this vector and *v*.
  70. </div>
  71. <h3>.lengthSq() [page:Float]</h3>
  72. <div>
  73. Computes squared length of this vector.
  74. </div>
  75. <h3>.length() [page:Float]</h3>
  76. <div>
  77. Computes length of this vector.
  78. </div>
  79. <h3>.normalize() [page:Vector2]</h3>
  80. <div>
  81. Normalizes this vector.
  82. </div>
  83. <h3>.distanceTo( [page:Vector2 v] ) [page:Float]</h3>
  84. <div>
  85. Computes distance of this vector to *v*.
  86. </div>
  87. <h3>.distanceToSquared( [page:Vector2 v] ) [page:Float]</h3>
  88. <div>
  89. Computes squared distance of this vector to *v*.
  90. </div>
  91. <h3>.setLength( [page:Float l] ) [page:Vector2]</h3>
  92. <div>
  93. Normalizes this vector and multiplies it by *l*.
  94. </div>
  95. <h3>.equals( [page:Vector2 v] ) [page:Vector2]</h3>
  96. <div>
  97. Checks for strict equality of this vector and *v*.
  98. </div>
  99. <h3>.clone() [page:Vector2]</h3>
  100. <div>
  101. Clones this vector.
  102. </div>
  103. <h3>.clamp([page:todo min], [page:todo max]) [page:todo]</h3>
  104. <div>
  105. min -- todo <br />
  106. max -- todo
  107. </div>
  108. <div>
  109. todo
  110. </div>
  111. <h3>.toArray() [page:todo]</h3>
  112. <div>
  113. todo
  114. </div>
  115. <h3>.lerp([page:todo v], [page:todo alpha]) [page:todo]</h3>
  116. <div>
  117. v -- todo <br />
  118. alpha -- todo
  119. </div>
  120. <div>
  121. todo
  122. </div>
  123. <h3>.setComponent([page:todo index], [page:todo value]) [page:todo]</h3>
  124. <div>
  125. index -- todo <br />
  126. value -- todo
  127. </div>
  128. <div>
  129. todo
  130. </div>
  131. <h3>.min([page:todo v]) [page:todo]</h3>
  132. <div>
  133. v -- todo
  134. </div>
  135. <div>
  136. todo
  137. </div>
  138. <h3>.addScalar([page:todo s]) [page:todo]</h3>
  139. <div>
  140. s -- todo
  141. </div>
  142. <div>
  143. todo
  144. </div>
  145. <h3>.getComponent([page:todo index]) [page:todo]</h3>
  146. <div>
  147. index -- todo
  148. </div>
  149. <div>
  150. todo
  151. </div>
  152. <h3>.fromArray([page:todo array]) [page:todo]</h3>
  153. <div>
  154. array -- todo
  155. </div>
  156. <div>
  157. todo
  158. </div>
  159. <h3>.max([page:todo v]) [page:todo]</h3>
  160. <div>
  161. v -- todo
  162. </div>
  163. <div>
  164. todo
  165. </div>
  166. <h3>.setX([page:todo x]) [page:todo]</h3>
  167. <div>
  168. x -- todo
  169. </div>
  170. <div>
  171. todo
  172. </div>
  173. <h3>.setY([page:todo y]) [page:todo]</h3>
  174. <div>
  175. y -- todo
  176. </div>
  177. <div>
  178. todo
  179. </div>
  180. <h2>Source</h2>
  181. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  182. </body>
  183. </html>