Vector3.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402
  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">3D vector.</div>
  12. <h2>Example</h2>
  13. <code>var a = new THREE.Vector3( 1, 0, 0 );
  14. var b = new THREE.Vector3( 0, 1, 0 );
  15. var c = new THREE.Vector3();
  16. c.crossVectors( a, b );
  17. </code>
  18. <h2>Constructor</h2>
  19. <h3>[name]( [page:Float x], [page:Float y], [page:Float z] )</h3>
  20. <div>
  21. x -- todo <br />
  22. y -- todo <br />
  23. z -- todo
  24. </div>
  25. <div>
  26. todo
  27. </div>
  28. <h2>Properties</h2>
  29. <h3>.[page:Float x]</h3>
  30. <h3>.[page:Float y]</h3>
  31. <h3>.[page:Float z]</h3>
  32. <h2>Methods</h2>
  33. <h3>.set( [page:Float x], [page:Float y], [page:Float z] ) [page:Vector3]</h3>
  34. <div>
  35. Sets value of this vector.
  36. </div>
  37. <h3>.setX( [page:Float x] ) [page:Vector3]</h3>
  38. <div>
  39. Sets x value of this vector.
  40. </div>
  41. <h3>.setY( [page:Float y] ) [page:Vector3]</h3>
  42. <div>
  43. Sets y value of this vector.
  44. </div>
  45. <h3>.setZ( [page:Float z] ) [page:Vector3]</h3>
  46. <div>
  47. Sets z value of this vector.
  48. </div>
  49. <h3>.copy( [page:Vector3 v] ) [page:Vector3]</h3>
  50. <div>
  51. Copies value of *v* to this vector.
  52. </div>
  53. <h3>.add( [page:Vector3 v] ) [page:Vector3]</h3>
  54. <div>
  55. Adds *v* to this vector.
  56. </div>
  57. <h3>.addVectors( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3]</h3>
  58. <div>
  59. Sets this vector to *a + b*.
  60. </div>
  61. <h3>.sub( [page:Vector3 v] ) [page:Vector3]</h3>
  62. <div>
  63. Subtracts *v* from this vector.
  64. </div>
  65. <h3>.subVectors( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3]</h3>
  66. <div>
  67. Sets this vector to *a - b*.
  68. </div>
  69. <h3>.multiplyScalar( [page:Float s] ) [page:Vector3]</h3>
  70. <div>
  71. Multiplies this vector by scalar *s*.
  72. </div>
  73. <h3>.divideScalar( [page:Float s] ) [page:Vector3]</h3>
  74. <div>
  75. Divides this vector by scalar *s*.<br />
  76. Set vector to *( 0, 0, 0 )* if *s == 0*.
  77. </div>
  78. <h3>.negate() [page:Vector3]</h3>
  79. <div>
  80. Inverts this vector.
  81. </div>
  82. <h3>.dot( [page:Vector3 v] ) [page:Float]</h3>
  83. <div>
  84. Computes dot product of this vector and *v*.
  85. </div>
  86. <h3>.lengthSq() [page:Float]</h3>
  87. <div>
  88. Computes squared length of this vector.
  89. </div>
  90. <h3>.length() [page:Float]</h3>
  91. <div>
  92. Computes length of this vector.
  93. </div>
  94. <h3>.lengthManhattan() [page:Float]</h3>
  95. <div>
  96. Computes Manhattan length of this vector.<br />
  97. [link:http://en.wikipedia.org/wiki/Taxicab_geometry]
  98. </div>
  99. <h3>.normalize() [page:Vector3]</h3>
  100. <div>
  101. Normalizes this vector.
  102. </div>
  103. <h3>.distanceTo( [page:Vector3 v] ) [page:Float]</h3>
  104. <div>
  105. Computes distance of this vector to *v*.
  106. </div>
  107. <h3>.distanceToSquared( [page:Vector3 v] ) [page:Float]</h3>
  108. <div>
  109. Computes squared distance of this vector to *v*.
  110. </div>
  111. <h3>.setLength( [page:Float l] ) [page:Vector3]</h3>
  112. <div>
  113. Normalizes this vector and multiplies it by *l*.
  114. </div>
  115. <h3>.cross( [page:Vector3 v] ) [page:Vector3]</h3>
  116. <div>
  117. Sets this vector to cross product of itself and *v*.
  118. </div>
  119. <h3>.crossVectors( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3]</h3>
  120. <div>
  121. Sets this vector to cross product of *a* and *b*.
  122. </div>
  123. <h3>.getPositionFromMatrix( [page:Matrix4 m] ) [page:Vector3]</h3>
  124. <div>
  125. Sets this vector extracting position from matrix transform.
  126. </div>
  127. <h3>.getScaleFromMatrix( [page:Matrix4 m] ) [page:Vector3]</h3>
  128. <div>
  129. Sets this vector extracting scale from matrix transform.
  130. </div>
  131. <h3>.equals( [page:Vector3 v] ) [page:Vector3]</h3>
  132. <div>
  133. Checks for strict equality of this vector and *v*.
  134. </div>
  135. <h3>.clone() [page:Vector3]</h3>
  136. <div>
  137. Clones this vector.
  138. </div>
  139. <h3>.clamp([page:todo min], [page:todo max]) [page:todo]</h3>
  140. <div>
  141. min -- todo <br />
  142. max -- todo
  143. </div>
  144. <div>
  145. todo
  146. </div>
  147. <h3>.applyMatrix3([page:todo m]) [page:todo]</h3>
  148. <div>
  149. m -- todo
  150. </div>
  151. <div>
  152. todo
  153. </div>
  154. <h3>.applyMatrix4([page:todo m]) [page:todo]</h3>
  155. <div>
  156. m -- todo
  157. </div>
  158. <div>
  159. todo
  160. </div>
  161. <h3>.projectOnPlane([page:todo planeNormal]) [page:todo]</h3>
  162. <div>
  163. planeNormal -- todo
  164. </div>
  165. <div>
  166. todo
  167. </div>
  168. <h3>.projectOnVector([page:todo vector]) [page:todo]</h3>
  169. <div>
  170. vector -- todo
  171. </div>
  172. <div>
  173. todo
  174. </div>
  175. <h3>.addScalar([page:todo s]) [page:todo]</h3>
  176. <div>
  177. s -- todo
  178. </div>
  179. <div>
  180. todo
  181. </div>
  182. <h3>.divide([page:todo v]) [page:todo]</h3>
  183. <div>
  184. v -- todo
  185. </div>
  186. <div>
  187. todo
  188. </div>
  189. <h3>.min([page:todo v]) [page:todo]</h3>
  190. <div>
  191. v -- todo
  192. </div>
  193. <div>
  194. todo
  195. </div>
  196. <h3>.setComponent([page:todo index], [page:todo value]) [page:todo]</h3>
  197. <div>
  198. index -- todo <br />
  199. value -- todo
  200. </div>
  201. <div>
  202. todo
  203. </div>
  204. <h3>.transformDirection([page:todo m]) [page:todo]</h3>
  205. <div>
  206. m -- todo
  207. </div>
  208. <div>
  209. todo
  210. </div>
  211. <h3>.multiplyVectors([page:todo a], [page:todo b]) [page:todo]</h3>
  212. <div>
  213. a -- todo <br />
  214. b -- todo
  215. </div>
  216. <div>
  217. todo
  218. </div>
  219. <h3>.getComponent([page:todo index]) [page:todo]</h3>
  220. <div>
  221. index -- todo
  222. </div>
  223. <div>
  224. todo
  225. </div>
  226. <h3>.applyAxisAngle([page:todo axis], [page:todo angle]) [page:todo]</h3>
  227. <div>
  228. axis -- todo <br />
  229. angle -- todo
  230. </div>
  231. <div>
  232. todo
  233. </div>
  234. <h3>.lerp([page:todo v], [page:todo alpha]) [page:todo]</h3>
  235. <div>
  236. v -- todo <br />
  237. alpha -- todo
  238. </div>
  239. <div>
  240. todo
  241. </div>
  242. <h3>.max([page:todo v]) [page:todo]</h3>
  243. <div>
  244. v -- todo
  245. </div>
  246. <div>
  247. todo
  248. </div>
  249. <h3>.angleTo([page:todo v]) [page:todo]</h3>
  250. <div>
  251. v -- todo
  252. </div>
  253. <div>
  254. todo
  255. </div>
  256. <h3>.getColumnFromMatrix([page:todo index], [page:todo matrix]) [page:todo]</h3>
  257. <div>
  258. index -- todo <br />
  259. matrix -- todo
  260. </div>
  261. <div>
  262. todo
  263. </div>
  264. <h3>.reflect([page:todo vector]) [page:todo]</h3>
  265. <div>
  266. vector -- todo
  267. </div>
  268. <div>
  269. todo
  270. </div>
  271. <h3>.fromArray([page:todo array]) [page:todo]</h3>
  272. <div>
  273. array -- todo
  274. </div>
  275. <div>
  276. todo
  277. </div>
  278. <h3>.multiply([page:todo v], [page:todo w]) [page:todo]</h3>
  279. <div>
  280. v -- todo <br />
  281. w -- todo
  282. </div>
  283. <div>
  284. todo
  285. </div>
  286. <h3>.applyProjection([page:todo m]) [page:todo]</h3>
  287. <div>
  288. m -- todo
  289. </div>
  290. <div>
  291. todo
  292. </div>
  293. <h3>.setEulerFromRotationMatrix([page:todo m], [page:todo order]) [page:todo]</h3>
  294. <div>
  295. m -- todo <br />
  296. order -- todo
  297. </div>
  298. <div>
  299. todo
  300. </div>
  301. <h3>.toArray() [page:todo]</h3>
  302. <div>
  303. todo
  304. </div>
  305. <h3>.applyEuler([page:todo v], [page:todo eulerOrder]) [page:todo]</h3>
  306. <div>
  307. v -- todo <br />
  308. eulerOrder -- todo
  309. </div>
  310. <div>
  311. todo
  312. </div>
  313. <h3>.applyQuaternion([page:todo q]) [page:todo]</h3>
  314. <div>
  315. q -- todo
  316. </div>
  317. <div>
  318. todo
  319. </div>
  320. <h3>.setEulerFromQuaternion([page:todo q], [page:todo order]) [page:todo]</h3>
  321. <div>
  322. q -- todo <br />
  323. order -- todo
  324. </div>
  325. <div>
  326. todo
  327. </div>
  328. <h2>Source</h2>
  329. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  330. </body>
  331. </html>