Euler.html 5.8 KB

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