Euler.html 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  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">Euler Angles.</div>
  12. <h2>Example</h2>
  13. <code>var a = new THREE.Euler( 0, 1, 1.57, 'XYZ' );
  14. var b = new THREE.Vector3( 1, 0, 1 );
  15. b.applyEuler(a);
  16. </code>
  17. <h2>Constructor</h2>
  18. <h3>[name]( [page:Float x], [page:Float y], [page:Float z], [page:String Order] )</h3>
  19. <div>
  20. x -- [page:Float] the angle of the x axis<br />
  21. y -- [page:Float] the angle of the y axis<br />
  22. z -- [page:Float] the angle of the z axis<br />
  23. order -- [page:String] A string representing the order that the rotations are applied, defaults to 'XYZ' (must be upper case).
  24. </div>
  25. <div>
  26. A euler angle for transforming
  27. </div>
  28. <h2>Properties</h2>
  29. <h3>.[page:Float x]</h3>
  30. <h3>.[page:Float y]</h3>
  31. <h3>.[page:Float z]</h3>
  32. <h3>.[page:String order]</h3>
  33. <h2>Methods</h2>
  34. <h3>.set( [page:Float x], [page:Float y], [page:Float z], [page:String order] ) [page:this]</h3>
  35. <div>
  36. x -- [page:Float] Angle in x axis<br />
  37. x -- [page:Float] Angle in x axis<br />
  38. x -- [page:Float] Angle in x axis<br />
  39. order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
  40. </div>
  41. <div>
  42. Sets the angles of this euler transform.
  43. </div>
  44. <h3>.copy( [page:Euler euler] ) [page:this]</h3>
  45. <div>
  46. Copies value of *euler* to this euler.
  47. </div>
  48. <h3>.setFromRotationMatrix( [page:Matrix4 m], [page:String order] ) [page:this]</h3>
  49. <div>
  50. m -- [page:Matrix4] assumes upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled)<br />
  51. order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
  52. </div>
  53. <div>
  54. Sets the angles of this euler transform from a pure rotation matrix based on the orientation specified by order.
  55. </div>
  56. <h3>.setFromQuaternion( [page:Quaternion q], [page:String order] ) [page:this]</h3>
  57. <div>
  58. q -- [page:Quaternion] quaternion must be normalized<br />
  59. order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
  60. </div>
  61. <div>
  62. Sets the angles of this euler transform from a normalized quaternion based on the orientation specified by order.
  63. </div>
  64. <h3>.reorder( [page:String newOrder] ) [page:this]</h3>
  65. <div>
  66. Resets the euler angle with a new order by creating a quaternion from this euler angle and then setting this euler angle with the quaternion and the new order. <br />
  67. WARNING: this discards revolution information.
  68. </div>
  69. <h3>.fromArray([page:Array array]) [page:this]</h3>
  70. <div>
  71. array -- [page:Array] of length 3 or 4. array[3] is an optional order argument.
  72. </div>
  73. <div>
  74. Assigns this euler's x angle to array[0]. <br />
  75. Assigns this euler's y angle to array[1]. <br />
  76. Assigns this euler's z angle to array[2]. <br />
  77. Optionally assigns this euler's order to array[3].
  78. </div>
  79. <h3>.toArray() [page:Array]</h3>
  80. <div>
  81. Returns an array [x, y, z, order].
  82. </div>
  83. <h3>.equals( [page:Euler euler] ) [page:Boolean]</h3>
  84. <div>
  85. Checks for strict equality of this euler and *euler*.
  86. </div>
  87. <h3>.clone() [page:Euler]</h3>
  88. <div>
  89. Returns a new euler created from this euler.
  90. </div>
  91. <h2>Source</h2>
  92. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  93. </body>
  94. </html>