2
0

Quaternion.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  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">
  12. 该类实现了 [link:http://en.wikipedia.org/wiki/Quaternion quaternion] 。<br/>
  13. 四元数在three.js中用于表示 [link:https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation rotation] (旋转)。
  14. </p>
  15. <h2>代码示例</h2>
  16. <code>
  17. const quaternion = new THREE.Quaternion();
  18. quaternion.setFromAxisAngle( new THREE.Vector3( 0, 1, 0 ), Math.PI / 2 );
  19. const vector = new THREE.Vector3( 1, 0, 0 );
  20. vector.applyQuaternion( quaternion );
  21. </code>
  22. <h2>构造函数</h2>
  23. <h3>[name]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
  24. <p>
  25. [page:Float x] - x 坐标<br />
  26. [page:Float y] - y 坐标<br />
  27. [page:Float z] - z 坐标<br />
  28. [page:Float w] - w 坐标
  29. </p>
  30. <h2>属性</h2>
  31. <h3>[property:Float x]</h3>
  32. <h3>[property:Float y]</h3>
  33. <h3>[property:Float z]</h3>
  34. <h3>[property:Float w]</h3>
  35. <h2>方法</h2>
  36. <h3>[method:Float angleTo]( [param:Quaternion q] )</h3>
  37. <p>
  38. 以弧度返回该四元数与四元数 [page:Quaternion q] 之间的夹角。
  39. </p>
  40. <h3>[method:Quaternion clone]()</h3>
  41. <p>
  42. 创建一个与该四元数具有相同[page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]
  43. 属性的四元数。
  44. </p>
  45. <h3>[method:this conjugate]()</h3>
  46. <p>
  47. 返回该四元数的旋转共轭。
  48. 四元数的共轭表示的是,围绕旋转轴在相反方向上的相同旋转。
  49. </p>
  50. <h3>[method:this copy]( [param:Quaternion q] )</h3>
  51. <p>
  52. 复制四元数 [page:Quaternion q] 的 [page:.x x]、[page:.y y]、[page:.z z] 和 [page:.w w]
  53. 属性到该四元数中。
  54. </p>
  55. <h3>[method:Boolean equals]( [param:Quaternion v] )</h3>
  56. <p>
  57. [page:Quaternion v] - 用于进行比较的四元数。<br /><br />
  58. 将四元数 [page:Quaternion v] 的 [page:.x x]、 [page:.y y]、 [page:.z z] 和 [page:.w w] 的属性
  59. 与当前四元数的对应属性相比较,以确定它们是否表示相同的旋转。
  60. </p>
  61. <h3>[method:Float dot]( [param:Quaternion v] )</h3>
  62. <p>
  63. 计算四元数 [page:Quaternion v] 与当前四元数的[link:https://en.wikipedia.org/wiki/Dot_product dot product](点积)。
  64. </p>
  65. <h3>[method:this fromArray]( [param:Array array], [param:Integer offset] )</h3>
  66. <p>
  67. [page:Array array] - 用于构造四元数的形如(x, y, z, w)的数组。<br />
  68. [page:Integer offset] - (可选)数组的偏移量。(译者注:使用数组中从第offset元素算起的四个元素)<br /><br />
  69. 从一个数组来设置四元数的 [page:.x x]、 [page:.y y]、[page:.z z] 和 [page:.w w] 的属性。
  70. </p>
  71. <h3>[method:this identity]()</h3>
  72. <p>
  73. 设置该四元数为 identity 四元数,即表示“不旋转”的四元数。
  74. </p>
  75. <h3>[method:this invert]()</h3>
  76. <p>
  77. 翻转该四元数 —— 计算 [page:.conjugate conjugate] 。假定该四元数具有单位长度。
  78. </p>
  79. <h3>[method:Float length]()</h3>
  80. <p>计算四元数的 [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length]
  81. (欧几里得长度,直线长度),视为一个四维向量。</p>
  82. <h3>[method:Float lengthSq]()</h3>
  83. <p>
  84. 计算四元数 [link:https://en.wikipedia.org/wiki/Euclidean_distance Euclidean length]
  85. (欧几里得长度,直线长度)的平方,视为一个四维向量。
  86. 如果要比较两个四元数的长度,这可能会十分有用,
  87. 因为这比 [page:.length length]() 的效率稍高一些。
  88. </p>
  89. <h3>[method:this normalize]()</h3>
  90. <p>
  91. [link:https://en.wikipedia.org/wiki/Normalized_vector Normalizes](归一化)四元数 ——
  92. 即计算与该四元数具有相同旋转、但长度为*1*的四元数。
  93. </p>
  94. <h3>[method:this multiply]( [param:Quaternion q] )</h3>
  95. <p>将该四元数与[page:Quaternion q]相乘。</p>
  96. <h3>[method:this multiplyQuaternions]( [param:Quaternion a], [param:Quaternion b] )</h3>
  97. <p>
  98. 将该四元数设为 [page:Quaternion a] x [page:Quaternion b] 。<br />
  99. 改编自 [link:http://www.euclideanspace.com/maths/algebra/realNormedAlgebra/quaternions/code/index.htm here] 所概述的方法。
  100. </p>
  101. <h3>[method:this premultiply]( [param:Quaternion q] )</h3>
  102. <p>使用 [page:Quaternion q] 乘以该四元数。</p>
  103. <h3>[method:this rotateTowards]( [param:Quaternion q], [param:Float step] )</h3>
  104. <p>
  105. [page:Quaternion q] - 目标四元数<br />
  106. [page:Float step] - 以弧度为单位的角度步长<br /><br />
  107. 将该四元数按照步长 step 向目标 *q* 进行旋转。该方法确保最终的四元数不会超过 *q*。
  108. </p>
  109. <h3>[method:this slerp]( [param:Quaternion qb], [param:Float t] )</h3>
  110. <p>
  111. [page:Quaternion qb] - 另一个四元数旋转<br />
  112. [page:Float t] - 闭区间 [0, 1] 中的插值因子<br /><br />
  113. 处理四元数之间的球面线性插值。[page:Float t] 表示该四元数(其中 [page:Float t] 为 0) 和 [page:Quaternion qb] (其中 [page:Float t] 为1) 之间的旋转量。
  114. 该四元数会被设置为上述计算的结果。另请参阅下面 *slerp* 的静态版本。
  115. <code>
  116. // rotate a mesh towards a target quaternion
  117. mesh.quaternion.slerp( endQuaternion, 0.01 );
  118. </code>
  119. </p>
  120. <h3>[method:this slerpQuaternions]( [param:Quaternion qa], [param:Quaternion qb], [param:Float t] )</h3>
  121. <p>在给定的四元数之间执行球面线性插值,并将结果存储在这个四元数中</p>
  122. <h3>[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:Float w] )</h3>
  123. <p>设置该四元数的 [page:.x x]、[page:.y y]、[page:.z z]和[page:.w w]属性。</p>
  124. <h3>[method:this setFromAxisAngle]( [param:Vector3 axis], [param:Float angle] )</h3>
  125. <p>
  126. 从由 [page:Vector3 axis](轴) 和 [page:Float angle](角度)所给定的旋转来设置该四元数。<br />
  127. 改编自 [link:http://www.euclideanspace.com/maths/geometry/rotations/conversions/angleToQuaternion/index.htm here] 所述的方法。<br />
  128. 假定*Axis*已被归一化,*angle*以弧度来表示。
  129. </p>
  130. <h3>[method:this setFromEuler]( [param:Euler euler] )</h3>
  131. <p>从由 [page:Euler] 角所给定的旋转来设置该四元数。</p>
  132. <h3>[method:this setFromRotationMatrix]( [param:Matrix4 m] )</h3>
  133. <p>
  134. 从[page:Matrix4 m]的旋转分量中来设置该四元数。<br />
  135. 改编自 [link:http://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/index.htm here] 所概述的方法。
  136. </p>
  137. <h3>[method:this setFromUnitVectors]( [param:Vector3 vFrom], [param:Vector3 vTo] )</h3>
  138. <p>
  139. 将该四元数设置为从方向向量 [page:Vector3 vFrom] 旋转到方向向量 [page:Vector3 vTo] 所需的旋转。<br />
  140. 改编自方法 [link:http://lolengine.net/blog/2013/09/18/beautiful-maths-quaternion-from-vectors here]。<br />
  141. 假设 [page:Vector3 vFrom] 和 [page:Vector3 vTo] 都已归一化。
  142. </p>
  143. <h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
  144. <p>
  145. [page:Array array] - (可选)存储该四元数的数组。若未指定该参数,则将创建一个新数组。<br/>
  146. [page:Integer offset] - (可选)若指定了该值,结果将会被拷贝到该
  147. [page:Array]。<br /><br />
  148. 在形如[x, y, z, w]的数组中,返回四元数中的数字元素。
  149. </p>
  150. <h3>[method:this fromBufferAttribute]( [param:BufferAttribute attribute], [param:Integer index] )</h3>
  151. <p>
  152. [page:BufferAttribute attribute] - 源 attribute。<br />
  153. [page:Integer index] - attribute 中的索引。<br /><br />
  154. 从 [page:BufferAttribute attribute] 中设置该四元数的[page:.x x]、 [page:.y y]、 [page:.z z]、 [page:.w w]属性。
  155. </p>
  156. <h2>静态方法</h2>
  157. <h3>[method:undefined slerpFlat]( [param:Array dst], [param:Integer dstOffset], [param:Array src0], [param:Integer srcOffset0], [param:Array src1], [param:Integer srcOffset1], [param:Float t] )</h3>
  158. <p>
  159. [page:Array dst] - 输出数组<br />
  160. [page:Integer dstOffset] - 输出数组的偏移量<br />
  161. [page:Array src0] - 起始四元数的源数组<br />
  162. [page:Integer srcOffset0] - 数组 *src0* 的偏移量<br />
  163. [page:Array src1] - 目标四元数的源数组<br />
  164. [page:Integer srcOffset1] - 数组 *src1* 的偏移量<br />
  165. [page:Float t] - 归一化插值因子(介于 0 和 1 之间)<br /><br />
  166. </p>
  167. <p>
  168. 类似于上面的 *slerp* 方法,但直接对平面数组进行操作。
  169. </p>
  170. <!-- Note: Do not add non-static methods to the bottom of this page. Put them above the <h2>Static Methods</h2> -->
  171. <h2>源码</h2>
  172. <p>
  173. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  174. </p>
  175. </body>
  176. </html>