Euler.html 4.4 KB

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