Selaa lähdekoodia

Docs: Update constructor parameters for LatheGeometry and ExtrudeGeometry

Joshua Koo 11 vuotta sitten
vanhempi
commit
25d04586a0

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

@@ -245,7 +245,7 @@
 		Don't forget to call this method when you remove an geometry because it can cuase meomory leaks. 
 		Don't forget to call this method when you remove an geometry because it can cuase meomory leaks. 
 		</div>
 		</div>
 
 
-		<h3>.computeLineDistances() [page:todo]</h3>
+		<h3>.computeLineDistances()</h3>
 		<div>
 		<div>
 		Compute distances between vertices for Line geometries.
 		Compute distances between vertices for Line geometries.
 		</div>
 		</div>

+ 18 - 2
docs/api/extras/geometries/ExtrudeGeometry.html

@@ -19,8 +19,24 @@
 
 
 		<h3>[name]([page:todo shapes], [page:Object options])</h3>
 		<h3>[name]([page:todo shapes], [page:Object options])</h3>
 		<div>
 		<div>
-		shapes — todo <br />
-		options — todo
+		shapes — Shape or an array of shapes. <br />
+		options — Object that can contain the following parameters.
+
+	<ul>
+<li>curveSegments —  int. number of points on the curves</li>
+<li>steps —  int. number of points used for subdividing segements of extrude spline</li>
+<li>amount —  int. Depth to extrude the shape</li>
+<li>bevelEnabled —  bool. turn on bevel</li>
+<li>bevelThickness —  float. how deep into the original shape bevel goes</li>
+<li>bevelSize —  float. how far from shape outline is bevel</li>
+<li>bevelSegments —  int. number of bevel layers</li>
+<li>extrudePath —  THREE.CurvePath. 3d spline path to extrude shape along. (creates Frames if (frames aren't defined)</li>
+<li>frames —  THREE.TubeGeometry.FrenetFrames.  containing arrays of tangents, normals, binormals</li>
+<li>material —  int. material index for front and back faces</li>
+<li>extrudeMaterial —  int. material index for extrusion and beveled faces</li>
+<li>uvGenerator —  Object. object that provides UV generator functions</li>
+	</ul>
+
 		</div>
 		</div>
 		<div>
 		<div>
 		todo
 		todo

+ 5 - 5
docs/api/extras/geometries/LatheGeometry.html

@@ -11,7 +11,7 @@
 		
 		
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">Class for generating meshes with axial symmetry. Possible uses include donuts, pipes, vases etc. The lathe rotate around the Z axis.</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
@@ -19,10 +19,10 @@
 
 
 		<h3>[name]([page:Array points], [page:Integer segments], [page:Float phiStart], [page:Float phiLength])</h3>
 		<h3>[name]([page:Array points], [page:Integer segments], [page:Float phiStart], [page:Float phiLength])</h3>
 		<div>
 		<div>
-		points — todo <br />
-		segments — todo <br />
-		phiStart — todo <br />
-		phiLength — todo
+		points — Array of Vector3s. Since this rotates around Z axis, the y-values can be set to 0<br />
+		segments — the number of circumference segments to generate. Default is 12.<br />
+		phiStart — the starting angle in radians. Default is 0.<br />
+		phiLength — the radian (0 to 2*PI) range of the lathed section 2*PI is a closed lathe, less than 2PI is a portion. Default is 2*PI
 		</div>
 		</div>
 		<div>
 		<div>
 		todo
 		todo