浏览代码

Docs: Face3, Face4, Frustum.

Mr.doob 13 年之前
父节点
当前提交
3abd17c06c
共有 5 个文件被更改,包括 118 次插入191 次删除
  1. 41 3
      docs/api/core/Face3.html
  2. 0 86
      docs/api/core/Face3.rst
  3. 68 7
      docs/api/core/Face4.html
  4. 0 90
      docs/api/core/Face4.rst
  5. 9 5
      docs/api/core/Frustum.html

+ 41 - 3
docs/api/core/Face3.html

@@ -13,29 +13,67 @@ Triangle face.
 <h2>Constructor</h2>
 <h2>Constructor</h2>
 
 
 <h3>[name]( [page:Integer a], [page:Integer b], [page:Integer c], [page:Vector3 normal], [page:Color color], [page:Integer materialIndex] )</h3>
 <h3>[name]( [page:Integer a], [page:Integer b], [page:Integer c], [page:Vector3 normal], [page:Color color], [page:Integer materialIndex] )</h3>
-
+<div>
+a — Vertex A index.<br />
+b — Vertex B index.<br />
+c — Vertex C index.<br />
+normal — Face normal or array of vertex normals.<br />
+color — Face color or array of vertex colors.<br />
+materialIndex — Material index.
+</div>
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
 <h3>.[page:Integer a]</h3>
 <h3>.[page:Integer a]</h3>
+<div>
+Vertex A index.
+</div>
 
 
 <h3>.[page:Integer b]</h3>
 <h3>.[page:Integer b]</h3>
+<div>
+Vertex B index.
+</div>
 
 
 <h3>.[page:Integer c]</h3>
 <h3>.[page:Integer c]</h3>
+<div>
+Vertex C index.
+</div>
 
 
 <h3>.[page:Vector3 normal]</h3>
 <h3>.[page:Vector3 normal]</h3>
-
-<h3>.[page:Array vertexNormals]</h3>
+<div>
+Face normal.
+</div>
 
 
 <h3>.[page:Color color]</h3>
 <h3>.[page:Color color]</h3>
+<div>
+Face color.
+</div>
+
+<h3>.[page:Array vertexNormals]</h3>
+<div>
+Array of 3 vertex normals.
+</div>
 
 
 <h3>.[page:Array vertexColors]</h3>
 <h3>.[page:Array vertexColors]</h3>
+<div>
+Array of 3 vertex colors.
+</div>
 
 
 <h3>.[page:Array vertexTangets]</h3>
 <h3>.[page:Array vertexTangets]</h3>
+<div>
+Array of 3 vertex tangets.
+</div>
+
 
 
 <h3>.[page:Integer materialIndex]</h3>
 <h3>.[page:Integer materialIndex]</h3>
+<div>
+Material index (points to [page:Geometry Geometry.materials]).
+</div>
 
 
 <h3>.[page:Vector3 centroid]</h3>
 <h3>.[page:Vector3 centroid]</h3>
+<div>
+Face centroid.
+</div>
 
 
 
 
 <h2>Source</h2>
 <h2>Source</h2>

+ 0 - 86
docs/api/core/Face3.rst

@@ -1,86 +0,0 @@
-Face3 - Triangle face
-------------------------
-
-.. ...............................................................................
-.. rubric:: Constructor
-.. ...............................................................................
-
-.. class:: Face3( a, b, c, normal, color, materialIndex )
-
-    Triangle face
-
-    (indices start from zero)
-
-    :param integer a: vertex A index
-    :param integer b: vertex B index
-    :param integer c: vertex C index
-    :param varying normal: face normal or array of vertex normals
-    :param varying color: face color or array of vertex colors
-    :param integer materialIndex: material index
-
-
-.. ...............................................................................
-.. rubric:: Attributes
-.. ...............................................................................
-
-.. attribute:: Face3.a
-
-    Vertex A index
-
-.. attribute:: Face3.b
-
-    Vertex B index
-
-.. attribute:: Face3.c
-
-    Vertex C index
-
-.. attribute:: Face3.normal
-
-    Face normal
-
-    :class:`Vector3` - default ``( 0, 0, 0 )``
-
-.. attribute:: Face3.color
-
-    Face color
-
-    :class:`Color` - default ``white``
-
-.. attribute:: Face3.centroid
-
-    Face centroid
-
-    :class:`Vector3` - default ``( 0, 0, 0 )``
-
-.. attribute:: Face3.vertexNormals
-
-    Array of 3 vertex normals
-
-    default ``[]``
-
-.. attribute:: Face3.vertexColors
-
-    Array of 3 vertex colors
-
-    default ``[]``
-
-.. attribute:: Face3.vertexTangents
-
-    Array of 3 vertex tangents
-
-    default ``[]``
-
-.. attribute:: Face3.materialIndex
-
-    Material index (points to :attr:`Geometry.materials` array)
-
-    default ``0``
-
-.. ...............................................................................
-.. rubric:: Example
-.. ...............................................................................
-
-::
-
-    var face = new THREE.Face3( 0, 1, 2, new THREE.Vector3( 0, 1, 0 ), new THREE.Color( 0xffaa00 ), 0 );

+ 68 - 7
docs/api/core/Face4.html

@@ -1,23 +1,84 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">
+Quad face.
+</div>
 
 
 
 
-<h2>Constructor</h2>
+<h2>Example</h2>
 
 
-<h3>[name]()</h3>
+<code>var face = new THREE.Face4( 0, 1, 2, 3, new THREE.Vector3( 0, 1, 0 ), new THREE.Color( 0xffaa00 ), 0 );</code>
 
 
 
 
+<h2>Constructor</h2>
+
+<h3>[name]( [page:Integer a], [page:Integer b], [page:Integer c], [page:Integer d], [page:Vector3 normal], [page:Color color], [page:Integer materialIndex] )</h3>
+<div>
+a — Vertex A index.<br />
+b — Vertex B index.<br />
+c — Vertex C index.<br />
+d — Vertex D index.<br />
+normal — Face normal or array of vertex normals.<br />
+color — Face color or array of vertex colors.<br />
+materialIndex — Material index.
+</div>
+
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Integer a]</h3>
+<div>
+Vertex A index.
+</div>
+
+<h3>.[page:Integer b]</h3>
+<div>
+Vertex B index.
+</div>
 
 
+<h3>.[page:Integer c]</h3>
+<div>
+Vertex C index.
+</div>
 
 
-<h2>Methods</h2>
+<h3>.[page:Integer d]</h3>
+<div>
+Vertex D index.
+</div>
+
+<h3>.[page:Vector3 normal]</h3>
+<div>
+Face normal.
+</div>
+
+<h3>.[page:Color color]</h3>
+<div>
+Face color.
+</div>
+
+<h3>.[page:Array vertexNormals]</h3>
+<div>
+Array of 4 vertex normals.
+</div>
+
+<h3>.[page:Array vertexColors]</h3>
+<div>
+Array of 4 vertex colors.
+</div>
+
+<h3>.[page:Array vertexTangets]</h3>
+<div>
+Array of 4 vertex tangets.
+</div>
+
+
+<h3>.[page:Integer materialIndex]</h3>
+<div>
+Material index (points to [page:Geometry Geometry.materials]).
+</div>
 
 
-<h3>.todo( [page:Vector3 todo] )</h3>
+<h3>.[page:Vector3 centroid]</h3>
 <div>
 <div>
-todo — todo<br />
+Face centroid.
 </div>
 </div>
 
 
 
 

+ 0 - 90
docs/api/core/Face4.rst

@@ -1,90 +0,0 @@
-Face4 - Quad face
-------------------------
-
-.. ...............................................................................
-.. rubric:: Constructor
-.. ...............................................................................
-
-.. class:: Face4( a, b, c, d, normal, color, materialIndex )
-
-    Quad face
-
-    (indices start from zero)
-
-    :param integer a: vertex index
-    :param integer b: vertex index
-    :param integer c: vertex index
-    :param integer d: vertex index
-    :param varying normal: face normal or array of vertex normals
-    :param varying color: face color or array of vertex colors
-    :param integer materialIndex: material index
-
-
-.. ...............................................................................
-.. rubric:: Attributes
-.. ...............................................................................
-
-.. attribute:: Face4.a
-
-    Vertex A index
-
-.. attribute:: Face4.b
-
-    Vertex B index
-
-.. attribute:: Face4.c
-
-    Vertex C index
-
-.. attribute:: Face4.d
-
-    Vertex D index
-
-.. attribute:: Face4.normal
-
-    Face normal
-
-    :class:`Vector3` - default ``(0,0,0)``
-
-.. attribute:: Face4.color
-
-    Face color
-
-    :class:`Color` - default ``white``
-
-.. attribute:: Face4.centroid
-
-    :class:`Vector3` - default ``(0,0,0)``
-
-.. attribute:: Face4.vertexNormals
-
-    Array of 4 vertex normals
-
-    default ``[]``
-
-.. attribute:: Face4.vertexColors
-
-    Array of 4 vertex colors
-
-    default ``[]``
-
-.. attribute:: Face4.vertexTangents
-
-    Array of 4 vertex tangents
-
-    default ``[]``
-
-.. attribute:: Face4.materialIndex
-
-    Material index (points to :attr:`Geometry.materials` array)
-
-    default ``0``
-
-
-.. ...............................................................................
-.. rubric:: Example
-.. ...............................................................................
-
-::
-
-    var face = new THREE.Face4( 0, 1, 2, 3, new THREE.Vector3( 0, 1, 0 ), new THREE.Color( 0xffaa00 ), 0 );

+ 9 - 5
docs/api/core/Frustum.html

@@ -1,6 +1,6 @@
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc"></div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>
@@ -10,17 +10,21 @@
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Array planes]</h3>
+<div>
+Array of 6 [page:Vector4 vectors].
+</div>
 
 
 
 
 <h2>Methods</h2>
 <h2>Methods</h2>
 
 
-<h3>.todo( [page:Vector3 todo] )</h3>
+<h3>.setFromMatrix( [page:Matrix4 matrix] )</h3>
+
+<h3>.contains( [page:Object3D object] ) [page:Boolean]</h3>
 <div>
 <div>
-todo — todo<br />
+Checks whether the object is inside the Frustum.
 </div>
 </div>
 
 
-
 <h2>Source</h2>
 <h2>Source</h2>
 
 
 <a href="https://github.com/mrdoob/three.js/blob/master/src/[path].js" target="_blank">src/[path].js</a>
 <a href="https://github.com/mrdoob/three.js/blob/master/src/[path].js" target="_blank">src/[path].js</a>