Vector4.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  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. <h1>[name]</h1>
  12. <div class="desc">4D vector.</div>
  13. <h2>Constructor</h2>
  14. <h3>[name]( [page:Float x], [page:Float y], [page:Float z], [page:Float w] )</h3>
  15. <div>
  16. x -- [page:Float] <br />
  17. y -- [page:Float] <br />
  18. z -- [page:Float] <br />
  19. w -- [page:Float]
  20. </div>
  21. <h2>Properties</h2>
  22. <h3>[property:Float x]</h3>
  23. <h3>[property:Float y]</h3>
  24. <h3>[property:Float z]</h3>
  25. <h3>[property:Float w]</h3>
  26. <h2>Methods</h2>
  27. <h3>[method:Vector4 set]( [page:Float x], [page:Float y], [page:Float z], [page:Float w] ) [page:Vector4 this]</h3>
  28. <div>
  29. Sets value of this vector.
  30. </div>
  31. <h3>[method:Vector4 setX]( [page:Float x] ) [page:Vector4 this]</h3>
  32. <div>
  33. x -- [page:Float]
  34. </div>
  35. <div>
  36. Sets the x component of the vector.
  37. </div>
  38. <h3>[method:Vector4 setY]( [page:Float y] ) [page:Vector4 this]</h3>
  39. <div>
  40. y -- [page:Float]
  41. </div>
  42. <div>
  43. Sets the y component of the vector.
  44. </div>
  45. <h3>[method:Vector4 setZ]( [page:Float z] ) [page:Vector4 this]</h3>
  46. <div>
  47. z -- [page:Float]
  48. </div>
  49. <div>
  50. Sets the z component of the vector.
  51. </div>
  52. <h3>[method:Vector4 setW]( [page:Float w] ) [page:Vector4 this]</h3>
  53. <div>
  54. w -- [page:Float]
  55. </div>
  56. <div>
  57. Sets the w component of the vector.
  58. </div>
  59. <h3>[method:Vector4 setScalar]( [page:Float scalar] ) [page:Vector4 this]</h3>
  60. <div>
  61. scalar -- [page:Float]
  62. </div>
  63. <div>
  64. set all component values of this vector to *scalar*.
  65. </div>
  66. <h3>[method:Vector4 copy]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  67. <div>
  68. Copies value of *v* to this vector.
  69. </div>
  70. <h3>[method:Vector4 fromArray]( [page:Array array] ) [page:Vector4 this]</h3>
  71. <div>
  72. array -- The source array in the form [x, y, z, w]. <br />
  73. offset -- An optional offset into the array.
  74. </div>
  75. <div>
  76. Sets the vector's components based on an array formatted like [x, y, z, w]
  77. </div>
  78. <h3>[method:Vector4 add]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  79. <div>
  80. Adds *v* to this vector.
  81. </div>
  82. <h3>[method:Vector4 addVectors]( [page:Vector4 a], [page:Vector4 b] ) [page:Vector4 this]</h3>
  83. <div>
  84. Sets this vector to *a + b*.
  85. </div>
  86. <h3>[method:Vector4 addScaledVector]( [page:Vector4 v], [page:Float s] ) [page:Vector4 this]</h3>
  87. <div>
  88. Adds the multiple of v and s to this vector.
  89. </div>
  90. <h3>[method:Vector4 sub]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  91. <div>
  92. Subtracts *v* from this vector.
  93. </div>
  94. <h3>[method:Vector4 subVectors]( [page:Vector4 a], [page:Vector4 b] ) [page:Vector4 this]</h3>
  95. <div>
  96. Sets this vector to *a - b*.
  97. </div>
  98. <h3>[method:Vector4 multiplyScalar]( [page:Float s] ) [page:Vector4 this]</h3>
  99. <div>
  100. Multiplies this vector by scalar *s*.
  101. </div>
  102. <h3>[method:Vector4 divideScalar]( [page:Float s] ) [page:Vector4 this]</h3>
  103. <div>
  104. Divides this vector by scalar *s*.<br />
  105. Set vector to *( 0, 0, 0 )* if *s == 0*.
  106. </div>
  107. <h3>[method:Vector4 negate]() [page:Vector4 this]</h3>
  108. <div>
  109. Inverts this vector.
  110. </div>
  111. <h3>[method:Float dot]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  112. <div>
  113. Computes dot product of this vector and *v*.
  114. </div>
  115. <h3>[method:Float lengthSq]() [page:Vector4 this]</h3>
  116. <div>
  117. Computes the squared length of this vector.
  118. </div>
  119. <h3>[method:Float length]() [page:Vector4 this]</h3>
  120. <div>
  121. Computes the length of this vector.
  122. </div>
  123. <h3>[method:Float lengthManhattan]() [page:Vector4 this]</h3>
  124. <div>
  125. Computes the Manhattan length of this vector.<br />
  126. [link:http://en.wikipedia.org/wiki/Taxicab_geometry]
  127. </div>
  128. <h3>[method:Vector4 normalize]() [page:Vector4 this]</h3>
  129. <div>
  130. Normalizes this vector.
  131. </div>
  132. <h3>[method:Vector4 setLength]( [page:Float l] ) [page:Vector4 this]</h3>
  133. <div>
  134. Normalizes this vector and multiplies it by *l*.
  135. </div>
  136. <h3>[method:Vector4 lerp]( [page:Vector4 v], [page:Float alpha] ) [page:Vector4 this]</h3>
  137. <div>
  138. Linearly interpolate between this vector and *v* with *alpha* factor.
  139. </div>
  140. <h3>[method:Vector4 lerpVectors]( [page:Vector4 v1], [page:Vector4 v2], [page:Float alpha] ) [page:Vector4 this]</h3>
  141. <div>
  142. Sets this vector to be the vector linearly interpolated between *v1* and *v2* with *alpha* factor.
  143. </div>
  144. <h3>[method:Vector4 clamp]( [page:Vector4 min], [page:Vector4 max] ) [page:Vector4 this]</h3>
  145. <div>
  146. min -- [page:Vector4] <br />
  147. max -- [page:Vector4]
  148. </div>
  149. <div>
  150. If this vector's x, y, z, or w value is greater than the max vector's x, y, z, or w value, it is replaced by the corresponding value.<br/><br/>
  151. If this vector's x, y, z, or w value is less than the min vector's x, y, z, or w value, it is replaced by the corresponding value.
  152. </div>
  153. <h3>[method:Vector4 clampScalar]( [page:Float min], [page:Float max] ) [page:Vector4 this]</h3>
  154. <div>
  155. min -- [page:Float] the minimum value the components will be clamped to <br />
  156. max -- [page:Float] the maximum value the components will be clamped to
  157. </div>
  158. <div>
  159. If this vector's x, y, z or w values are greater than the max value, they are replaced by the max value. <br /><br />
  160. If this vector's x, y, z or w values are less than the min value, they are replaced by the min value.
  161. </div>
  162. <h3>[method:Vector4 floor]() [page:Vector4 this]</h3>
  163. <div>
  164. The components of the vector are rounded downwards (towards negative infinity) to an integer value.
  165. </div>
  166. <h3>[method:Vector4 ceil]() [page:Vector4 this]</h3>
  167. <div>
  168. The components of the vector are rounded upwards (towards positive infinity) to an integer value.
  169. </div>
  170. <h3>[method:Vector4 round]() [page:Vector4 this]</h3>
  171. <div>
  172. The components of the vector are rounded towards the nearest integer value.
  173. </div>
  174. <h3>[method:Vector4 roundToZero]() [page:Vector4 this]</h3>
  175. <div>
  176. The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.
  177. </div>
  178. <h3>[method:Vector4 applyMatrix4]( [page:Matrix4 m] ) [page:Vector4 this]</h3>
  179. <div>
  180. m -- [page:Matrix4]
  181. </div>
  182. <div>
  183. Transforms the vector by the matrix.
  184. </div>
  185. <h3>[method:Vector4 min]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  186. <div>
  187. v -- [page:Vector4]
  188. </div>
  189. <div>
  190. If this vector's x, y, z, or w value is greater than vector v's x, y, z, or w value, that value is replaced by the corresponding vector v value.
  191. </div>
  192. <h3>[method:Vector4 max]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  193. <div>
  194. v -- [page:Vector4]
  195. </div>
  196. <div>
  197. If this vector's x, y, z, or w value is less than vector v's x, y, z, or w value, that value is replaced by the corresponding vector v value.
  198. </div>
  199. <h3>[method:Vector4 addScalar]( [page:Float s] ) [page:Vector4 this]</h3>
  200. <div>
  201. s -- [page:Float]
  202. </div>
  203. <div>
  204. Adds a scalar value to all of the vector's components.
  205. </div>
  206. <h3>[method:Boolean equals]( [page:Vector4 v] ) [page:Vector4 this]</h3>
  207. <div>
  208. v -- [page:Vector4]
  209. </div>
  210. <div>
  211. Checks to see if this vector matches vector v.
  212. </div>
  213. <h3>[method:Vector4 setAxisAngleFromRotationMatrix]( [page:Matrix4 m] ) [page:Vector4 this]</h3>
  214. <div>
  215. m -- [page:Matrix4]
  216. </div>
  217. <div>
  218. Sets this Vector4 to the computed <a href='http://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation' target='_blank'>axis-angle representation</a> of the rotation defined by Matrix4 m. Assumes the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).<br/><br/>
  219. The axis is stored in components (x, y, z) of the vector, and the rotation in radians is stored in component w
  220. </div>
  221. <h3>[method:Vector4 setAxisAngleFromQuaternion]( [page:Quaternion q] ) [page:Vector4 this]</h3>
  222. <div>
  223. q -- [page:Quaternion]
  224. </div>
  225. <div>
  226. Sets this Vector4 to the computed <a href='http://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation' target='_blank'>axis-angle representation</a> of the rotation defined by Quaternion q.<br/><br/>
  227. The axis is stored in components (x, y, z) of the vector, and the rotation in radians is stored in component w
  228. </div>
  229. <h3>[method:Float getComponent]( [page:Integer index] ) [page:Vector4 this]</h3>
  230. <div>
  231. index -- [page:Integer] 0, 1, 2, or 3
  232. </div>
  233. <div>
  234. Returns the value of the vector component x, y, or z by an index.<br/><br/>
  235. Index 0: x<br/>
  236. Index 1: y<br/>
  237. Index 2: z<br/>
  238. Index 3: w<br/>
  239. </div>
  240. <h3>[method:null setComponent]( [page:Integer index], [page:Float value] ) [page:Vector4 this]</h3>
  241. <div>
  242. index -- [page:Integer] 0 - 3 <br />
  243. value -- [page:Float]
  244. </div>
  245. <div>
  246. Sets the value of the vector component x, y, or z by an index.<br/><br/>
  247. Index 0: x<br/>
  248. Index 1: y<br/>
  249. Index 2: z<br/>
  250. Index 3: w<br/>
  251. </div>
  252. <h3>[method:Vector4 clone]() [page:Vector4 this]</h3>
  253. <div>
  254. Clones this vector.
  255. </div>
  256. <h3>[method:Array toArray]( [page:Array array], [page:Integer offset] ) [page:Vector4 this]</h3>
  257. <div>
  258. array -- An optional array to store the vector.
  259. offset -- An optional offset into the array.
  260. </div>
  261. <div>
  262. Returns an array in the format [x, y, z, w]
  263. </div>
  264. <h2>Source</h2>
  265. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  266. </body>
  267. </html>