Matrix4.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  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">A 4x4 Matrix.</div>
  12. <h2>Example</h2>
  13. <code>// Simple rig for rotating around 3 axes
  14. var m = new THREE.Matrix4();
  15. var m1 = new THREE.Matrix4();
  16. var m2 = new THREE.Matrix4();
  17. var m3 = new THREE.Matrix4();
  18. var alpha = 0;
  19. var beta = Math.PI;
  20. var gamma = Math.PI/2;
  21. m1.makeRotationX( alpha );
  22. m2.makeRotationY( beta );
  23. m3.makeRotationZ( gamma );
  24. m.multiplyMatrices( m1, m2 );
  25. m.multiply( m3 );
  26. </code>
  27. <h2>Constructor</h2>
  28. <h3>[name]( [page:Float n11], [page:Float n12], [page:Float n13], [page:Float n14], [page:Float n21], [page:Float n22], [page:Float n23], [page:Float n24], [page:Float n31], [page:Float n32], [page:Float n33], [page:Float n34], [page:Float n41], [page:Float n42], [page:Float n43], [page:Float n44] )</h3>
  29. <div>Initialises the matrix with the supplied n11..n44 values, or just creates an identity matrix if no values are passed.</div>
  30. <h2>Properties</h2>
  31. <h3>.[page:Float32Array elements]</h3>
  32. <h2>Methods</h2>
  33. <h3>.set( [page:Float n11], [page:Float n12], [page:Float n13], [page:Float n14], [page:Float n21], [page:Float n22], [page:Float n23], [page:Float n24], [page:Float n31], [page:Float n32], [page:Float n33], [page:Float n34], [page:Float n41], [page:Float n42], [page:Float n43], [page:Float n44] ) [page:Matrix4]</h3>
  34. <div>
  35. Sets all fields of this matrix.
  36. </div>
  37. <h3>.identity() [page:Matrix4]</h3>
  38. <div>
  39. Resets this matrix to identity.
  40. </div>
  41. <h3>.copy( [page:Matrix4 m] ) [page:Matrix4]</h3>
  42. <div>
  43. Copies a matrix *m* into this matrix.
  44. </div>
  45. <h3>.copyPosition( [page:Matrix4 m] ) [page:Matrix4]</h3>
  46. <div>
  47. Copies the translation component of the supplied matrix *m* into this matrix translation component.
  48. </div>
  49. <h3>.copyRotation( [page:Matrix4 m] ) [page:Matrix4]</h3>
  50. <div>
  51. Copies the rotation component of the supplied matrix *m* into this matrix rotation component.
  52. </div>
  53. <h3>.lookAt( [page:Vector3 eye], [page:Vector3 center], [page:Vector3 up], ) [page:Matrix4]</h3>
  54. <div>
  55. Constructs a rotation matrix, looking from *eye* towards *center* with defined *up* vector.
  56. </div>
  57. <h3>.multiply( [page:Matrix4 m] ) [page:Matrix4]</h3>
  58. <div>
  59. Multiplies this matrix by *m*.
  60. </div>
  61. <h3>.multiplyMatrices( [page:Matrix4 a], [page:Matrix4 b] ) [page:Matrix4]</h3>
  62. <div>
  63. Sets this matrix to *a x b*.
  64. </div>
  65. <h3>.multiplyToArray( [page:Matrix4 a], [page:Matrix4 b], [page:Array r] ) [page:Matrix4]</h3>
  66. <div>
  67. Sets this matrix to *a x b* and stores the result into the flat array *r*.<br />
  68. *r* can be either a regular Array or a TypedArray.
  69. </div>
  70. <h3>.multiplyScalar( [page:Float s] ) [page:Matrix4]</h3>
  71. <div>
  72. Multiplies this matrix by *s*.
  73. </div>
  74. <h3>.multiplyVector3( [page:Vector3 v] ) [page:Vector3]</h3>
  75. <div>
  76. Applies this matrix to *v*.
  77. </div>
  78. <h3>.multiplyVector4( [page:Vector4 v] ) [page:Vector4]</h3>
  79. <div>
  80. Applies this matrix to *v*.
  81. </div>
  82. <h3>.crossVector( [page:Vector4 a] ) [page:Vector4]</h3>
  83. <div>
  84. Computes the cross product between this matrix and the [page:Vector4] parameter *a*.
  85. </div>
  86. <h3>.determinant() [page:Float]</h3>
  87. <div>
  88. Computes determinant of this matrix.<br />
  89. Based on [link:http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.htm]
  90. </div>
  91. <h3>.transpose() [page:Matrix4]</h3>
  92. <div>
  93. Transposes this matrix.
  94. </div>
  95. <h3>.flatten() [page:Array]</h3>
  96. <div>
  97. Flattens this matrix into internal [page:Matrix4 Matrix4.flat] array.
  98. </div>
  99. <h3>.flattenToArray( [page:Array flat] ) [page:Array]</h3>
  100. <div>
  101. Flattens this matrix into supplied *flat* array.
  102. </div>
  103. <h3>.flattenToArrayOffset( [page:Array flat], [page:Integer offset] ) [page:Array]</h3>
  104. <div>
  105. Flattens this matrix into supplied *flat* array starting from *offset* position in the array.
  106. </div>
  107. <h3>.setPosition( [page:Vector3 v] ) [page:Matrix4]</h3>
  108. <div>
  109. Sets the position component for this matrix from vector *v*.
  110. </div>
  111. <h3>.getPosition() [page:Vector3]</h3>
  112. <div>
  113. Returns position component from this matrix.<br />
  114. Note: this method returns a reference to the internal class vector, make a copy or clone it if you don't use it right away.
  115. </div>
  116. <h3>.getColumnX() [page:Vector3]</h3>
  117. <div>
  118. Returns x column component from this matrix.<br />
  119. Note: this method returns a reference to the internal class vector, make a copy or clone it if you don't use it right away.
  120. </div>
  121. <h3>.getColumnY() [page:Vector3]</h3>
  122. <div>
  123. Returns y column component from this matrix.<br />
  124. Note: this method returns a reference to the internal class vector, make a copy or clone it if you don't use it right away.
  125. </div>
  126. <h3>.getColumnZ() [page:Vector3]</h3>
  127. <div>
  128. Returns z column component from this matrix.<br />
  129. Note: this method returns a reference to the internal class vector, make a copy or clone it if you don't use it right away.
  130. </div>
  131. <h3>.getInverse( [page:Matrix4 m] ) [page:Matrix4]</h3>
  132. <div>
  133. Sets this matrix to the inverse of matrix *m*.<br />
  134. Based on [link:http://www.euclideanspace.com/maths/algebra/matrix/functions/inverse/fourD/index.htm].
  135. </div>
  136. <h3>.makeRotationFromEuler( [page:Vector3 v], [page:String order] ) [page:Matrix4]</h3>
  137. <div>
  138. v — Rotation vector.
  139. order — The order of rotations. Eg. "XYZ".
  140. </div>
  141. <div>
  142. Sets the rotation submatrix of this matrix to the rotation specified by Euler angles, the rest of the matrix is identity.<br />
  143. Default order is *"XYZ"*.
  144. </div>
  145. <h3>.makeRotationFromQuaternion( [page:Quaternion q] ) [page:Matrix4]</h3>
  146. <div>
  147. Sets the rotation submatrix of this matrix to the rotation specified by *q*. The rest of the matrix is identity.
  148. </div>
  149. <h3>.scale( [page:Vector3 v] ) [page:Matrix4]</h3>
  150. <div>
  151. Multiplies the columns of this matrix by vector *v*.
  152. </div>
  153. <h3>.compose( [page:Vector3 translation], [page:Quaternion rotation], [page:Vector3 scale] ) [page:Matrix4]</h3>
  154. <div>
  155. Sets this matrix to the transformation composed of *translation*, *rotation* and *scale*.
  156. </div>
  157. <h3>.decompose( [page:Vector3 translation], [page:Quaternion rotation], [page:Vector3 scale] ) [page:Array]</h3>
  158. <div>
  159. Decomposes this matrix into the *translation*, *rotation* and *scale* components.<br />
  160. If parameters are not passed, new instances will be created.
  161. </div>
  162. <h3>.makeTranslation( [page:Float x], [page:Float y], [page:Float z] ) [page:Matrix4]</h3>
  163. <div>
  164. Sets this matrix as translation transform.
  165. </div>
  166. <h3>.makeRotationX( [page:Float theta] ) [page:Matrix4]</h3>
  167. <div>
  168. theta — Rotation angle in radians.
  169. </div>
  170. <div>
  171. Sets this matrix as rotation transform around x axis by *theta* radians.
  172. </div>
  173. <h3>.makeRotationY( [page:Float theta] ) [page:Matrix4]</h3>
  174. <div>
  175. theta — Rotation angle in radians.
  176. </div>
  177. <div>
  178. Sets this matrix as rotation transform around y axis by *theta* radians.
  179. </div>
  180. <h3>.makeRotationZ( [page:Float theta] ) [page:Matrix4]</h3>
  181. <div>
  182. theta — Rotation angle in radians.
  183. </div>
  184. <div>
  185. Sets this matrix as rotation transform around z axis by *theta* radians.
  186. </div>
  187. <h3>.makeRotationAxis( [page:Vector3 axis], [page:Float theta] ) [page:Matrix4]</h3>
  188. <div>
  189. axis — Rotation axis, should be normalized.
  190. theta — Rotation angle in radians.
  191. </div>
  192. <div>
  193. Sets this matrix as rotation transform around *axis* by *angle* radians.<br />
  194. Based on [link:http://www.gamedev.net/reference/articles/article1199.asp].
  195. </div>
  196. <h3>.makeScale( [page:Float x], [page:Float y], [page:Float z] ) [page:Matrix4]</h3>
  197. <div>
  198. Sets this matrix as scale transform.
  199. </div>
  200. <h3>.makeFrustum( [page:Float left], [page:Float right], [page:Float bottom], [page:Float top], [page:Float near], [page:Float far] ) [page:Matrix4]</h3>
  201. <div>
  202. Creates a [page:Frustum frustum] matrix.
  203. </div>
  204. <h3>.makePerspective( [page:Float fov], [page:Float aspect], [page:Float near], [page:Float far] ) [page:Matrix4]</h3>
  205. <div>
  206. Creates a perspective projection matrix.
  207. </div>
  208. <h3>.makeOrthographic( [page:Float left], [page:Float right], [page:Float bottom], [page:Float top], [page:Float near], [page:Float far] ) [page:Matrix4]</h3>
  209. <div>
  210. Creates an orthographic projection matrix.
  211. </div>
  212. <h3>.clone() [page:Matrix4]</h3>
  213. <div>
  214. Clones this matrix.
  215. </div>
  216. <h2>Source</h2>
  217. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  218. </body>
  219. </html>