2
0

Euler.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. <!DOCTYPE html>
  2. <html lang="en">
  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. A class representing [link:http://en.wikipedia.org/wiki/Euler_angles Euler Angles].<br /><br />
  13. Euler angles describe a rotational transformation by rotating an object on its various
  14. axes in specified amounts per axis, and a specified axis order.
  15. </p>
  16. <p>
  17. Iterating through a [name] instance will yield its components (x, y, z, order) in the corresponding order.
  18. </p>
  19. <h2>Code Example</h2>
  20. <code>const a = new THREE.Euler( 0, 1, 1.57, 'XYZ' );
  21. const b = new THREE.Vector3( 1, 0, 1 );
  22. b.applyEuler(a);
  23. </code>
  24. <h2>Constructor</h2>
  25. <h3>[name]( [param:Float x], [param:Float y], [param:Float z], [param:String order] )</h3>
  26. <p>
  27. [page:Float x] - (optional) the angle of the x axis in radians. Default is `0`.<br />
  28. [page:Float y] - (optional) the angle of the y axis in radians. Default is `0`.<br />
  29. [page:Float z] - (optional) the angle of the z axis in radians. Default is `0`.<br />
  30. [page:String order] - (optional) a string representing the order that the rotations are applied,
  31. defaults to 'XYZ' (must be upper case).<br /><br />
  32. </p>
  33. <h2>Properties</h2>
  34. <h3>[property:Boolean isEuler]</h3>
  35. <p>
  36. Read-only flag to check if a given object is of type [name].
  37. </p>
  38. <h3>[property:String order]</h3>
  39. <p>
  40. The order in which to apply rotations. Default is 'XYZ', which means that the object will first be
  41. rotated around its X axis, then its Y axis and finally its Z axis. Other possibilities are:
  42. 'YZX', 'ZXY', 'XZY', 'YXZ' and 'ZYX'. These must be in upper case.<br /><br />
  43. Three.js uses `intrinsic` Tait-Bryan angles. This means that rotations are performed with respect
  44. to the `local` coordinate system. That is, for order 'XYZ', the rotation is first around the local-X
  45. axis (which is the same as the world-X axis), then around local-Y (which may now be different from the
  46. world Y-axis), then local-Z (which may be different from the world Z-axis).<br /><br />
  47. </p>
  48. <h3>[property:Float x]</h3>
  49. <p>
  50. The current value of the x component.<br /><br />
  51. </p>
  52. <h3>[property:Float y]</h3>
  53. <p>
  54. The current value of the y component.<br /><br />
  55. </p>
  56. <h3>[property:Float z]</h3>
  57. <p>
  58. The current value of the z component.<br /><br />
  59. </p>
  60. <h2>Methods</h2>
  61. <h3>[method:this copy]( [param:Euler euler] )</h3>
  62. <p>Copies value of [page:Euler euler] to this euler.</p>
  63. <h3>[method:Euler clone]()</h3>
  64. <p>Returns a new Euler with the same parameters as this one.</p>
  65. <h3>[method:Boolean equals]( [param:Euler euler] )</h3>
  66. <p>Checks for strict equality of this euler and [page:Euler euler].</p>
  67. <h3>[method:this fromArray]( [param:Array array] )</h3>
  68. <p>
  69. [page:Array array] of length 3 or 4. The optional 4th argument corresponds to the [page:.order order].<br /><br />
  70. Assigns this euler's [page:.x x] angle to `array[0]`. <br />
  71. Assigns this euler's [page:.y y] angle to `array[1]`. <br />
  72. Assigns this euler's [page:.z z] angle to `array[2]`. <br />
  73. Optionally assigns this euler's [page:.order order] to `array[3]`.
  74. </p>
  75. <h3>[method:this reorder]( [param:String newOrder] )</h3>
  76. <p>
  77. Resets the euler angle with a new order by creating a quaternion from this euler angle
  78. and then setting this euler angle with the quaternion and the new order. <br /><br />
  79. <em>*Warning*: this discards revolution information.</em>
  80. </p>
  81. <h3>[method:this set]( [param:Float x], [param:Float y], [param:Float z], [param:String order] )</h3>
  82. <p>
  83. [page:.x x] - the angle of the x axis in radians.<br />
  84. [page:.y y] - the angle of the y axis in radians.<br />
  85. [page:.z z] - the angle of the z axis in radians.<br />
  86. [page:.order order] - (optional) a string representing the order that the rotations are applied.<br /><br />
  87. Sets the angles of this euler transform and optionally the [page:.order order].
  88. </p>
  89. <h3>[method:this setFromRotationMatrix]( [param:Matrix4 m], [param:String order] )</h3>
  90. <p>
  91. [page:Matrix4 m] - a [page:Matrix4] of which the upper 3x3 of matrix is a pure
  92. [link:https://en.wikipedia.org/wiki/Rotation_matrix rotation matrix] (i.e. unscaled).<br />
  93. [page:.order order] - (optional) a string representing the order that the rotations are applied.<br />
  94. Sets the angles of this euler transform from a pure rotation matrix based on the orientation
  95. specified by order.
  96. </p>
  97. <h3>[method:this setFromQuaternion]( [param:Quaternion q], [param:String order] )</h3>
  98. <p>
  99. [page:Quaternion q] - a normalized quaternion.<br />
  100. [page:.order order] - (optional) a string representing the order that the rotations are applied.<br />
  101. Sets the angles of this euler transform from a normalized quaternion based on the orientation
  102. specified by [page:.order order].
  103. </p>
  104. <h3>[method:this setFromVector3]( [param:Vector3 vector], [param:String order] )</h3>
  105. <p>
  106. [page:Vector3 vector] - [page:Vector3].<br />
  107. [page:.order order] - (optional) a string representing the order that the rotations are applied.<br /><br />
  108. Set the [page:.x x], [page:.y y] and [page:.z z], and optionally update the [page:.order order].
  109. </p>
  110. <h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
  111. <p>
  112. [page:Array array] - (optional) array to store the euler in.<br />
  113. [page:Integer offset] (optional) offset in the array.<br />
  114. Returns an array of the form [[page:.x x], [page:.y y], [page:.z z], [page:.order order ]].
  115. </p>
  116. <h2>Source</h2>
  117. <p>
  118. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  119. </p>
  120. </body>
  121. </html>