Browse Source

Document SphereGeometry.

sole 13 years ago
parent
commit
705063d132
1 changed files with 13 additions and 11 deletions
  1. 13 11
      docs/api/extras/geometries/SphereGeometry.html

+ 13 - 11
docs/api/extras/geometries/SphereGeometry.html

@@ -9,24 +9,26 @@
 	<body>
 	<body>
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">A class for generating sphere geometries</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
+		<h3>[name]( [page:Number radius], [page:Number segmentsWidth], [page:Number segmentsHeight], [page:Number phiStart], [page:Number phiLength], [page:Number thetaStart], [page:Number thetaLength] )</h3>
 
 
 
 
-		<h2>Properties</h2>
-
-		<h3>.[page:Vector3 todo]</h3>
-
-
-		<h2>Methods</h2>
-
-		<h3>.todo( [page:Vector3 todo] )</h3>
 		<div>
 		<div>
-		todo — todo<br />
+		radius — sphere radius. Default is 50.<br />
+		segmentsWidth — number of horizontal segments. Minimum value is 3, and the default is 8.<br />
+		segmentsHeight — number of vertical segments. Minimum value is 2, and the default is 6.<br />
+		phiStart — specify horizontal starting angle. Default is 0.<br />
+		phiLength — specify horizontal sweep angle size. Default is Math.PI * 2.<br />
+		thetaStart — specify vertical starting angle. Default is 0.<br />
+		thetaLength — specify vertical sweep angle size. Default is Math.PI.<br />
+		</div>
+		
+		<div>
+		The geometry is created by sweeping and calculating vertexes around the Y axis (horizontal sweep) and the Z axis (vertical sweep). Thus, incomplete spheres (akin to <em>'sphere slices'</em>) can be created through the use of different values of phiStart, phiLength, thetaStart and thetaLength, in order to define the points in which we start (or end) calculating those vertices.
 		</div>
 		</div>