Quellcode durchsuchen

created euler angle docs, updated vector 3 equals to specify that it returned a boolean and not a vector 2

Walker Flynn vor 12 Jahren
Ursprung
Commit
fae93f63eb
2 geänderte Dateien mit 125 neuen und 1 gelöschten Zeilen
  1. 124 0
      docs/api/math/Euler.html
  2. 1 1
      docs/api/math/Vector2.html

+ 124 - 0
docs/api/math/Euler.html

@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <script src="../../list.js"></script>
+    <script src="../../page.js"></script>
+    <link type="text/css" rel="stylesheet" href="../../page.css" />
+  </head>
+  <body>
+    <h1>[name]</h1>
+
+    <div class="desc">Euler Angles.</div>
+
+    <h2>Example</h2>
+
+    <code>var a = new THREE.Euler( 0, 1, 1.57, 'XYZ' );
+    var b = new THREE.Vector3( 1, 0, 1 );
+    b.applyEuler(a);
+    </code>
+
+
+    <h2>Constructor</h2>
+
+
+    <h3>[name]( [page:Float x], [page:Float y], [page:Float z], [page:String Order] )</h3>
+    <div>
+    x -- [page:Float] the angle of the x axis<br />
+    y -- [page:Float] the angle of the y axis<br />
+    z -- [page:Float] the angle of the z axis<br />
+    order -- [page:String] A string representing the order that the rotations are applied, defaults to 'XYZ' (must be upper case).
+    </div>
+    <div>
+    A euler angle for transforming
+    </div>
+
+
+    <h2>Properties</h2>
+
+    <h3>.[page:Float x]</h3>
+
+    <h3>.[page:Float y]</h3>
+
+    <h3>.[page:Float z]</h3>
+
+    <h3>.[page:String order]</h3>
+
+
+
+    <h2>Methods</h2>
+
+    <h3>.set( [page:Float x], [page:Float y], [page:Float z], [page:String order] ) [page:this]</h3>
+    <div>
+    x -- [page:Float] Angle in x axis<br />
+    x -- [page:Float] Angle in x axis<br />
+    x -- [page:Float] Angle in x axis<br />
+    order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
+    </div>
+    <div>
+    Sets the angles of this euler transform.
+    </div>
+
+    <h3>.copy( [page:Euler euler] ) [page:this]</h3>
+    <div>
+    Copies value of *euler* to this euler.
+    </div>
+
+    <h3>.setFromRotationMatrix( [page:Matrix4 m], [page:String order] ) [page:this]</h3>
+    <div>
+    m -- [page:Matrix4] assumes upper 3x3 of matrix is a pure rotation matrix (i.e. unscaled)<br />
+    order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
+    </div>
+    <div>
+    Sets the angles of this euler transform from a pure rotation matrix based on the orientation specified by order.
+    </div>
+
+    <h3>.setFromQuaternion( [page:Quaternion q], [page:String order] ) [page:this]</h3>
+    <div>
+    q -- [page:Quaternion] quaternion must be normalized<br />
+    order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
+    </div>
+    <div>
+    Sets the angles of this euler transform from a normalized quaternion based on the orientation specified by order.
+    </div>
+
+    <h3>.reorder( [page:String newOrder] ) [page:this]</h3>
+    <div>
+    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 />
+    WARNING: this discards revolution information.
+    </div>
+
+    <h3>.fromArray([page:Array array]) [page:this]</h3>
+    <div>
+    array -- [page:Array] of length 3 or 4. array[3] is an optional order argument.
+    </div>
+    <div>
+    Assigns this euler's x angle to array[0]. <br />
+    Assigns this euler's y angle to array[1]. <br />
+    Assigns this euler's z angle to array[2]. <br />
+    Optionally assigns this euler's order to array[3].
+    </div>
+
+    <h3>.toArray() [page:Array]</h3>
+    <div>
+    Returns an array [x, y, z, order].
+    </div>
+
+    <h3>.equals( [page:Euler euler] ) [page:Boolean]</h3>
+    <div>
+    Checks for strict equality of this euler and *euler*.
+    </div>
+
+    <h3>.clone() [page:Euler]</h3>
+    <div>
+    Returns a new euler created from this euler.
+    </div>
+
+
+
+
+    <h2>Source</h2>
+
+    [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+  </body>
+</html>

+ 1 - 1
docs/api/math/Vector2.html

@@ -123,7 +123,7 @@
 		Normalizes this vector and multiplies it by *l*.
 		</div>
 
-		<h3>.equals( [page:Vector2 v] ) [page:Vector2]</h3>
+		<h3>.equals( [page:Vector2 v] ) [page:Boolean]</h3>
 		<div>
 		Checks for strict equality of this vector and *v*.
 		</div>