Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

[docs] Update docs

zz85 12 years ago
parent
f9fa6f9359
commit
caf3de3050
16 changed files with 34 additions and 34 deletions
Split View Show Diff Stats
  1. 11 14
      docs/api/extras/core/Curve.html
  2. 2 2
      docs/api/extras/geometries/ExtrudeGeometry.html
  3. 1 1
      docs/api/extras/geometries/IcosahedronGeometry.html
  4. 1 1
      docs/api/extras/geometries/LatheGeometry.html
  5. 1 1
      docs/api/extras/geometries/OctahedronGeometry.html
  6. 1 1
      docs/api/extras/geometries/PlaneGeometry.html
  7. 1 1
      docs/api/extras/geometries/PolyhedronGeometry.html
  8. 1 1
      docs/api/extras/geometries/TetrahedronGeometry.html
  9. 1 1
      docs/api/extras/geometries/TextGeometry.html
  10. 1 1
      docs/api/extras/geometries/TorusGeometry.html
  11. 1 1
      docs/api/extras/geometries/TorusKnotGeometry.html
  12. 5 4
      docs/api/extras/modifiers/SubdivisionModifier.html
  13. 1 1
      docs/api/extras/objects/LensFlare.html
  14. 4 2
      docs/api/materials/ShaderMaterial.html
  15. 1 1
      docs/api/textures/DataTexture.html
  16. 1 1
      docs/api/textures/Texture.html

+ 11 - 14
docs/api/extras/core/Curve.html
View File 

@@ -9,7 +9,7 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">An extensible curve object which contains methods for interpolation</div>
 
 
 
 		<h2>Constructor</h2>
 
@@ -25,37 +25,34 @@
 
 		<h2>Methods</h2>
 
 
 		<h3>.getPoint ( t )</h3>
 
-		<div>todo</div>
 
+		<div>Returns a vector for point t of the curve where t is between 0 and 1</div>
 
 
 		<h3>.getPointAt ( u )</h3>
 
-		<div>todo</div>
 
+		<div>Returns a vector for point at relative position in curve according to arc length</div>
 
 
 		<h3>.getPoints ( divisions )</h3>
 
-		<div>todo</div>
 
+		<div>Get sequence of points using getPoint( t ) </div>
 
 
 		<h3>.getSpacedPoints ( divisions )</h3>
 
-		<div>todo</div>
 
+		<div>Get sequence of equi-spaced points using getPointAt( u )</div>
 
 
 		<h3>.getLength ()</h3>
 
-		<div>todo</div>
 
+		<div>Get total curve arc length</div>
 
 
 		<h3>.getLengths ( divisions )</h3>
 
-		<div>todo</div>
 
+		<div>Get list of cumulative segment lengths</div>
 
 
 		<h3>.updateArcLengths ()</h3>
 
-		<div>todo</div>
 
+		<div>Update the cumlative segment distance cache</div>
 
 
 		<h3>.getUtoTmapping ( u, distance )</h3>
 
-		<div>todo</div>
 
-
 
-		<h3>.getNormalVector ( t )</h3>
 
-		<div>todo</div>
 
+		<div>Given u ( 0 .. 1 ), get a t to find p. This gives you points which are equi distance</div>
 
 
 		<h3>.getTangent ( t )</h3>
 
-		<div>todo</div>
 
+		<div>Returns a unit vector tangent at t. If the subclassed curve do not implement its tangent derivation, 2 points a small delta apart will be used to find its gradient which seems to give a reasonable approximation</div>
 
 
 		<h3>.getTangentAt ( u )</h3>
 
-		<div>todo</div>
 
+		<div>Returns tangent at equidistance point u on the curve</div>
 
 
 
 		<h2>Source</h2>

+ 2 - 2
docs/api/extras/geometries/ExtrudeGeometry.html
View File 

@@ -9,12 +9,12 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">Creates extruded geometry from a path shape</div>
 
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( shapes, options )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/IcosahedronGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( radius, detail )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/LatheGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( points, steps, angle )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/OctahedronGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( radius, detail )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/PlaneGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( width, height, widthSegments, heightSegments )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/PolyhedronGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( vertices, faces, radius, detail )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/TetrahedronGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( radius, detail )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/TextGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( text, parameters )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/TorusGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( radius, tube, radialSegments, tubularSegments, arc )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/extras/geometries/TorusKnotGeometry.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( radius, tube, radialSegments, tubularSegments, arc )</h3>
 
 
 
 		<h2>Properties</h2>

+ 5 - 4
docs/api/extras/modifiers/SubdivisionModifier.html
View File 

@@ -9,17 +9,18 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">Applies Catmull-Clark Subdivision Surfaces for creating smooth geometry meshes</div>
 
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( subdivisions )</h3>
 
 
 
 		<h2>Properties</h2>
 
 
 		<h3>.subdivisions</h3>
 
+		<div>Number of time subdivision will be applied</div>
 
 
 		<h3>.useOldVertexColors</h3>
 
 
@@ -30,10 +31,10 @@
 
 		<h2>Methods</h2>
 
 
 		<h3>.modify ( geometry )</h3>
 
-		<div>todo</div>
 
+		<div>Modifies the geometry by running subdivision surfaces. This calls .smooth() internally</div>
 
 
 		<h3>.smooth ( oldGeometry )</h3>
 
-		<div>todo</div>
 
+		<div>Performs an iteration of Catmull-Clark Subdivision</div>

+ 1 - 1
docs/api/extras/objects/LensFlare.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( texture, size, distance, blending, color )</h3>
 
 
 
 		<h2>Properties</h2>

+ 4 - 2
docs/api/materials/ShaderMaterial.html
View File 

@@ -11,12 +11,14 @@
 
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">Material rendered with custom shaders</div>
 
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( parameters )
 
+
 
+</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/textures/DataTexture.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( data, width, height, format, type, mapping, wrapS, wrapT, magFilter, minFilter, anisotropy )</h3>
 
 
 
 		<h2>Properties</h2>

+ 1 - 1
docs/api/textures/Texture.html
View File 

@@ -14,7 +14,7 @@
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( image, mapping, wrapS, wrapT, magFilter, minFilter, format, type, anisotropy )</h3>
 
 
 
 		<h2>Properties</h2>