Vector4.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. <!DOCTYPE html>
  2. <html lang="zh">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  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. <p class="desc">该类表示的是一个三维向量(4D [link:https://en.wikipedia.org/wiki/Vector_space vector])。
  12. 一个四维向量表示的是一个有顺序的、四个为一组的数字组合(标记为x、y和z),
  13. 可被用来表示很多事物,例如:
  14. </p>
  15. <ul>
  16. <li>
  17. 一个位于四维空间中的点。
  18. </li>
  19. <li>
  20. 一个在四维空间中的方向与长度的定义。在three.js中,长度总是从(0, 0, 0, 0)到(x, y, z, w)的
  21. [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean distance](欧几里德距离,即直线距离),
  22. 方向也是从(0, 0, 0, 0)到(x, y, z, w)的方向。
  23. </li>
  24. <li>
  25. 任意的、有顺序的、四个为一组的数字组合。
  26. </li>
  27. </ul>
  28. <p>
  29. 其他的一些事物也可以使用四维向量进行表示,但以上这些是它在three.js中的常用用途。
  30. </p>
  31. <h2>代码示例</h2>
  32. <code>
  33. const a = new THREE.Vector4( 0, 1, 0, 0 );
  34. //no arguments; will be initialised to (0, 0, 0, 1)
  35. const b = new THREE.Vector4( );
  36. const d = a.dot( b );
  37. </code>
  38. <p>
  39. Iterating through a Vector4 instance will yield its components (x, y, z, w) in the corresponding order.
  40. </p>
  41. <h2>构造函数</h2>
  42. <h3>[name]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
  43. <p>
  44. [page:Float x] - 向量的x值,默认为*0*。<br />
  45. [page:Float y] - 向量的y值,默认为*0*。<br />
  46. [page:Float z] - 向量的z值,默认为*0*。<br />
  47. [page:Float w] - 向量的w值,默认为*1*。<br /><br />
  48. 创建一个新的[name]。
  49. </p>
  50. <h2>属性</h2>
  51. <h3>[property:Float x]</h3>
  52. <h3>[property:Float y]</h3>
  53. <h3>[property:Float z]</h3>
  54. <h3>[property:Float w]</h3>
  55. <h3>[property:Float width]</h3>
  56. <p>[page:.z z]的别名。</p>
  57. <h3>[property:Float height]</h3>
  58. <p>[page:.w w]的别名。</p>
  59. <h2>方法</h2>
  60. <h3>[method:this add]( [param:Vector4 v] )</h3>
  61. <p>将传入的向量[page:Vector4 v]和这个向量相加。</p>
  62. <h3>[method:this addScalar]( [param:Float s] )</h3>
  63. <p>将传入的标量s和这个向量的[page:.x x]值、[page:.y y]值、[page:.z z]值以及[page:.w w]值相加。</p>
  64. <h3>[method:this addScaledVector]( [param:Vector4 v], [param:Float s] )</h3>
  65. <p>将所传入的[page:Vector4 v]与[page:Float s]相乘所得的乘积和这个向量相加。</p>
  66. <h3>[method:this addVectors]( [param:Vector4 a], [param:Vector4 b] )</h3>
  67. <p>将该向量设置为[page:Vector4 a] + [page:Vector4 b].</p>
  68. <h3>[method:this applyMatrix4]( [param:Matrix4 m] )</h3>
  69. <p>
  70. 将该向量乘以四阶矩阵[page:Matrix4 m]。
  71. </p>
  72. <h3>[method:this ceil]()</h3>
  73. <p>
  74. 将该向量[page:.x x]分量、 [page:.y y]分量[page:.z z]分量以及[page:.w w]分量向上取整为最接近的整数。
  75. </p>
  76. <h3>[method:this clamp]( [param:Vector4 min], [param:Vector4 max] )</h3>
  77. <p>
  78. [page:Vector4 min] - 在限制范围内,[page:.x x]值、[page:.y y]值、[page:.z z]值以及[page:.w w]值的最小值<br />
  79. [page:Vector4 max] - 在限制范围内,[page:.x x]值、[page:.y y]值、[page:.z z]值以及[page:.w w]值的最大值<br /><br />
  80. 如果该向量的x值、y值、z值或w值大于限制范围内最大x值、y值、z值或w值,则该值将会被所对应的值取代。<br /><br />
  81. 如果该向量的x值、y值、z值或w值小于限制范围内最小x值、y值、z值或w值,则该值将会被所对应的值取代。
  82. </p>
  83. <h3>[method:this clampLength]( [param:Float min], [param:Float max] )</h3>
  84. <p>
  85. [page:Float min] - 长度将被限制为的最小值 <br />
  86. [page:Float max] - 长度将被限制为的最大值<br /><br />
  87. 如果向量长度大于最大值,则它将会被最大值所取代。<br /><br />
  88. 如果向量长度小于最小值,则它将会被最小值所取代。
  89. </p>
  90. <h3>[method:this clampScalar]( [param:Float min], [param:Float max] )</h3>
  91. <p>
  92. [page:Float min] - 分量将被限制为的最小值<br />
  93. [page:Float max] - 分量将被限制为的最大值<br /><br />
  94. 如果该向量的x值、y值、z值或w值大于最大值,则它们将被最大值所取代。<br /><br />
  95. 如果该向量的x值、y值、z值或w值小于最小值,则它们将被最小值所取代。
  96. </p>
  97. <h3>[method:Vector4 clone]()</h3>
  98. <p>
  99. 返回一个新的Vector4,其具有和当前这个向量相同的[page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]。
  100. </p>
  101. <h3>[method:this copy]( [param:Vector4 v] )</h3>
  102. <p>
  103. 将所传入Vector4的[page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]属性复制给这一Vector4。
  104. </p>
  105. <h3>[method:this divideScalar]( [param:Float s] )</h3>
  106. <p>
  107. 将该向量除以标量[page:Float s]。<br />
  108. 如果传入的[page:Float s] = 0,则向量将被设置为*( 0, 0, 0, 0 )*。
  109. </p>
  110. <h3>[method:Float dot]( [param:Vector4 v] )</h3>
  111. <p>
  112. 计算该vector和所传入[page:Vector4 v]
  113. 的点积([link:https://en.wikipedia.org/wiki/Dot_product dot product])。
  114. </p>
  115. <h3>[method:Boolean equals]( [param:Vector4 v] )</h3>
  116. <p>检查该向量和[page:Vector4 v]的严格相等性。</p>
  117. <h3>[method:this floor]()</h3>
  118. <p>向量的分量向下取整为最接近的整数值。</p>
  119. <h3>[method:this fromArray]( [param:Array array], [param:Integer offset] )</h3>
  120. <p>
  121. [page:Array array] - 来源矩阵。<br />
  122. [page:Integer offset] - (可选)在数组中的元素偏移量,默认值为0。<br /><br />
  123. 设置向量中的[page:.x x]值为array[ offset + 0 ],[page:.y y]值为array[ offset + 1 ],
  124. [page:.z z]值为array[ offset + 2 ],[page:.w w ]值为array[ offset + 3 ]。
  125. </p>
  126. <h3>[method:this fromBufferAttribute]( [param:BufferAttribute attribute], [param:Integer index] )</h3>
  127. <p>
  128. [page:BufferAttribute attribute] - 来源的attribute。<br />
  129. [page:Integer index] - 在attribute中的索引。<br /><br />
  130. 从[page:BufferAttribute attribute]中设置向量的[page:.x x]值、[page:.y y]值、[page:.z z]值和[page:.w w]值。
  131. </p>
  132. <h3>[method:Float getComponent]( [param:Integer index] )</h3>
  133. <p>
  134. [page:Integer index] - 0, 1, 2 or 3.<br /><br />
  135. 如果index值为0返回[page:.x x]值。 <br />
  136. 如果index值为1返回[page:.y y]值。 <br />
  137. 如果index值为2返回[page:.z z]值。<br />
  138. 如果index值为3返回[page:.w w]值。
  139. </p>
  140. <h3>[method:Float length]()</h3>
  141. <p>
  142. 计算从(0, 0, 0, 0) 到 (x, y, z, w)的欧几里得长度
  143. ([link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length],即直线长度)。</p>
  144. <h3>[method:Float manhattanLength]()</h3>
  145. <p>
  146. 计算该向量的曼哈顿长度([link:http://en.wikipedia.org/wiki/Taxicab_geometry Manhattan length])。
  147. </p>
  148. <h3>[method:Float lengthSq]()</h3>
  149. <p>
  150. 计算从(0, 0, 0, 0)到(x, y, z, w)的欧几里得长度
  151. ([link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length],即直线长度)的平方。
  152. 如果你正在比较向量的长度,应当比较的是长度的平方,因为它的计算效率更高一些。
  153. </p>
  154. <h3>[method:this lerp]( [param:Vector4 v], [param:Float alpha] )</h3>
  155. <p>
  156. [page:Vector4 v] - 朝着进行插值的[page:Vector4]。<br />
  157. [page:Float alpha] - 插值因数,其范围通常在[0, 1]闭区间。<br /><br />
  158. 在该向量与传入的向量[page:Vector4 v]之间的线性插值,alpha是沿着线的长度的百分比
  159. —— alpha = 0 时表示的是当前向量,alpha = 1 时表示的是所传入的向量[page:Vector4 v]。
  160. </p>
  161. <h3>[method:this lerpVectors]( [param:Vector4 v1], [param:Vector4 v2], [param:Float alpha] )</h3>
  162. <p>
  163. [page:Vector4 v1] - 起始的[page:Vector4]。<br />
  164. [page:Vector4 v2] - 朝着进行插值的[page:Vector4]。<br />
  165. [page:Float alpha] - 插值因数,其范围在[0, 1]闭区间。<br /><br />
  166. 将此向量设置为在[page:Vector4 v1]和[page:Vector4 v2]之间进行线性插值的向量,
  167. 其中alpha为两个向量之间连线的长度的百分比
  168. —— alpha = 0 时表示的是[page:Vector4 v1],alpha = 1 时表示的是[page:Vector4 v2]。
  169. </p>
  170. <h3>[method:this negate]()</h3>
  171. <p>向量取反,即: x = -x, y = -y, z = -z , w = -w。</p>
  172. <h3>[method:this normalize]()</h3>
  173. <p>
  174. 将该向量转换为单位向量([link:https://en.wikipedia.org/wiki/Unit_vector unit vector]),
  175. 也就是说,将该向量的方向设置为和原向量相同,但是其长度([page:.length length])为1。
  176. </p>
  177. <h3>[method:this max]( [param:Vector4 v] )</h3>
  178. <p>
  179. 如果该向量的x值、y值、z值或w值小于所传入[page:Vector4 v]的x值、y值、z值或w值,
  180. 则将该值替换为对应的最大值。
  181. </p>
  182. <h3>[method:this min]( [param:Vector4 v] )</h3>
  183. <p>
  184. 如果该向量的x值、y值、z值或w值大于所传入[page:Vector4 v]的x值、y值、z值或w值,
  185. 则将该值替换为对应的最小值。
  186. </p>
  187. <h3>[method:this multiply]( [param:Vector4 v] )</h3>
  188. <p>将该向量与所传入的向量[page:Vector4 v]进行相乘。</p>
  189. <h3>[method:this multiplyScalar]( [param:Float s] )</h3>
  190. <p>将该向量与所传入的标量[page:Float s]进行相乘。</p>
  191. <h3>[method:this round]()</h3>
  192. <p>向量中的分量四舍五入取整为最接近的整数值。</p>
  193. <h3>[method:this roundToZero]()</h3>
  194. <p>
  195. 向量中的分量朝向0取整数(若分量为负数则向上取整,若为正数则向下取整)
  196. </p>
  197. <h3>[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
  198. <p>设置该向量的[page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]分量。</p>
  199. <h3>[method:this setAxisAngleFromQuaternion]( [param:Quaterion q] )</h3>
  200. <p>
  201. [page:Quaterion q] - 归一化的[page:Quaterion](四元数)<br /><br />
  202. 将该向量的[page:.x x]、[page:.y y]和[page:.z z]分量设置为四元数的轴,
  203. [page:.w w]分量设置为四元数的角度。
  204. </p>
  205. <h3>[method:this setAxisAngleFromRotationMatrix]( [param:Matrix4 m] )</h3>
  206. <p>
  207. [page:Matrix4 m] - 一个[page:Matrix4](四阶矩阵),其左上角3x3的元素表示的是一个纯旋转矩。<br /><br />
  208. 将该向量的[page:.x x]、[page:.y y]和[page:.z z]设置为旋转轴,[page:.w w]为角度。
  209. </p>
  210. <h3>[method:this setComponent]( [param:Integer index], [param:Float value] )</h3>
  211. <p>
  212. [page:Integer index] - 0、1、2 或 3。<br />
  213. [page:Float value] - [page:Float]<br /><br />
  214. 若index为 0 则设置 [page:.x x] 值为 [page:Float value]。<br />
  215. 若index为 1 则设置 [page:.y y] 值为 [page:Float value]。<br />
  216. 若index为 2 则设置 [page:.z z] 值为 [page:Float value]。<br />
  217. 若index为 3 则设置 [page:.w w] 值为 [page:Float value]。
  218. </p>
  219. <h3>[method:this setLength]( [param:Float l] )</h3>
  220. <p>
  221. 将该向量的方向设置为和原向量相同,但是长度([page:.length length])为[page:Float l]。
  222. </p>
  223. <h3>[method:this setScalar]( [param:Float scalar] )</h3>
  224. <p>
  225. 将该向量的[page:.x x]、[page:.y y]、[page:.z z]值和[page:.w w]同时设置为等于传入的[page:Float scalar]。
  226. </p>
  227. <h3>[method:this setX]( [param:Float x] )</h3>
  228. <p>将向量中的[page:.x x]值替换为[page:Float x]。</p>
  229. <h3>[method:this setY]( [param:Float y] )</h3>
  230. <p>将向量中的[page:.y y]值替换为[page:Float y]。</p>
  231. <h3>[method:this setZ]( [param:Float z] )</h3>
  232. <p>将向量中的[page:.z z]值替换为[page:Float z]。</p>
  233. <h3>[method:this setW]( [param:Float w] )</h3>
  234. <p>将向量中的[page:.w w]值替换为[page:Float w]。</p>
  235. <h3>[method:this sub]( [param:Vector4 v] )</h3>
  236. <p>从该向量减去向量[page:Vector4 v]。</p>
  237. <h3>[method:this subScalar]( [param:Float s] )</h3>
  238. <p>从该向量的[page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]分量中减去标量[page:Float s]。</p>
  239. <h3>[method:this subVectors]( [param:Vector4 a], [param:Vector4 b] )</h3>
  240. <p>将该向量设置为[page:Vector4 a] - [page:Vector4 b]。</p>
  241. <h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
  242. <p>
  243. [page:Array array] - (可选)被用于存储向量的数组。如果这个值没有传入,则将创建一个新的数组。<br />
  244. [page:Integer offset] - (可选) 数组中元素的偏移量。<br /><br />
  245. 返回一个数组[x, y, z, w],或者将x、y、z和w复制到所传入的[page:Array array]中。
  246. </p>
  247. <h3>[method:this random]()</h3>
  248. <p>
  249. 将该向量的每个分量(x、y、z、w)设置为介于 0 和 1 之间的伪随机数,不包括 1。
  250. </p>
  251. <h2>源代码</h2>
  252. <p>
  253. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  254. </p>
  255. </body>
  256. </html>