Prechádzať zdrojové kódy

Docs: Some more core classes.

Mr.doob 13 rokov pred
rodič
commit
1bb8d52d70

+ 12 - 4
docs/api/core/Matrix3.html

@@ -1,6 +1,6 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">A 3x3 matrix.</div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>
@@ -10,14 +10,22 @@
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Array m]</h3>
+<div>
+Array with matrix values.
+</div>
 
 
 
 
 <h2>Methods</h2>
 <h2>Methods</h2>
 
 
-<h3>.todo( [page:Vector3 todo] )</h3>
+<h3>.transpose() [page:Matrix3]</h3>
+<div>
+Transposes this matrix in place.
+</div>
+
+<h3>.transposeIntoArray( [page:Array r] ) [page:Array]</h3>
 <div>
 <div>
-todo — todo<br />
+Transposes this matrix into supplied array.
 </div>
 </div>
 
 
 
 

+ 0 - 38
docs/api/core/Matrix3.rst

@@ -1,38 +0,0 @@
-Matrix3 - A 3x3 matrix
-----------------------
-
-.. ...............................................................................
-.. rubric:: Constructor
-.. ...............................................................................
-
-.. class:: Matrix3()
-
-    A 3x3 matrix
-
-.. ...............................................................................
-.. rubric:: Attributes
-.. ...............................................................................
-
-.. attribute:: Matrix3.m
-
-    Array with matrix values
-
-.. ...............................................................................
-.. rubric:: Methods
-.. ...............................................................................
-
-.. function:: Matrix3.transpose()
-
-    Transposes this matrix in place
-
-    :returns: This matrix
-    :rtype: :class:`Matrix3`
-
-.. function:: Matrix3.transposeIntoArray( r )
-
-    Transposes this matrix into supplied array ``r``
-
-    This matrix is unmodified
-
-    :returns: This matrix
-    :rtype: :class:`Matrix3`

+ 1 - 1
docs/api/core/Projector.html

@@ -1,6 +1,6 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">Projecting points between spaces.</div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>

+ 0 - 14
docs/api/core/Projector.rst

@@ -1,14 +0,0 @@
-Projector - Utilities for projecting primitives between spaces
---------------------------------------------------------------
-
-.. rubric:: Constructor
-
-.. class:: Projector()
-
-    Utilities for projecting primitives between spaces
-    
-.. rubric:: Attributes
-
-.. rubric:: Method
-
-.. rubric:: Example(s)

+ 1 - 1
docs/api/core/Ray.html

@@ -1,6 +1,6 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">Representation of a ray in space.</div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>

+ 0 - 14
docs/api/core/Ray.rst

@@ -1,14 +0,0 @@
-Ray - Representation of a ray in space
---------------------------------------
-
-.. rubric:: Constructor
-
-.. class:: Ray()
-
-    Representation of a ray in space
-    
-.. rubric:: Attributes
-
-.. rubric:: Method
-
-.. rubric:: Example(s)

+ 1 - 1
docs/api/core/Rectangle.html

@@ -1,6 +1,6 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">Represents a 2D rectangle.</div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>

+ 0 - 14
docs/api/core/Rectangle.rst

@@ -1,14 +0,0 @@
-Rectangle - Represents a 2D rectangle
--------------------------------------
-
-.. rubric:: Constructor
-
-.. class:: Rectangle()
-
-    Represents a 2D rectangle
-    
-.. rubric:: Attributes
-
-.. rubric:: Method
-
-.. rubric:: Example(s)

+ 1 - 1
docs/api/core/Spline.html

@@ -1,6 +1,6 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">Represents a spline.</div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>

+ 0 - 14
docs/api/core/Spline.rst

@@ -1,14 +0,0 @@
-Spline - Represents a spline
-----------------------------
-
-.. rubric:: Constructor
-
-.. class:: Spline()
-
-    Represents a spline
-   
-.. rubric:: Attributes
-
-.. rubric:: Method
-
-.. rubric:: Example(s)

+ 24 - 7
docs/api/core/UV.html

@@ -1,24 +1,41 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">A texture coordinate.</div>
+
+<h2>Example</h2>
+
+<code>var uv = new THREE.UV( 0, 1 );</code>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>
 
 
-<h3>[name]()</h3>
+<h3>[name]( [page:Float u], [page:Float v] )</h3>
+<div>
+u — Horizontal coordinate.<br />
+v — Vertical coordinate.<br />
+</div>
 
 
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Float u]</h3>
+<div>
+Horizontal coordinate.<br />
+</div>
+
+<h3>.[page:Float v]</h3>
+<div>
+Vertical coordinate.<br />
+</div>
 
 
 
 
 <h2>Methods</h2>
 <h2>Methods</h2>
 
 
-<h3>.todo( [page:Vector3 todo] )</h3>
-<div>
-todo — todo<br />
-</div>
+<h3>.set( [page:Float u], [page:Float v] )</h3>
+
+<h3>.copy( [page:UV uv] )</h3>
+
+<h3>.clone() [page:UV]</h3>
 
 
 
 
 <h2>Source</h2>
 <h2>Source</h2>

+ 0 - 37
docs/api/core/UV.rst

@@ -1,37 +0,0 @@
-UV - A texture coordinate
-------------------------------------
-
-.. ...............................................................................
-.. rubric:: Constructor
-.. ...............................................................................
-
-.. class:: UV( u, v )
-
-    A texture coordinate
-
-    :param float u: u coordinate
-    :param float v: v coordinate
-
-.. ...............................................................................
-.. rubric:: Attributes
-.. ...............................................................................
-
-.. attribute:: UV.u
-.. attribute:: UV.v
-
-.. ...............................................................................
-.. rubric:: Method
-.. ...............................................................................
-
-.. function:: UV.set( u, v )
-.. function:: UV.copy( uv )
-.. function:: UV.clone( )
-
-
-.. ...............................................................................
-.. rubric:: Example
-.. ...............................................................................
-
-::
-
-    var uv = new THREE.UV( 0, 1 );