Explorar o código

Improved DirectGeometry doc

looeee %!s(int64=8) %!d(string=hai) anos
pai
achega
886fa16a61
Modificáronse 1 ficheiros con 37 adicións e 70 borrados
  1. 37 70
      docs/api/core/DirectGeometry.html

+ 37 - 70
docs/api/core/DirectGeometry.html

@@ -10,7 +10,9 @@
 	<body>
 		<h1>[name]</h1>
 
-		<div class="desc">This class is mainly used internally to convert from [page:Geometry] to [page:BufferGeometry].</div>
+		<div class="desc">
+			This class is used internally to convert from [page:Geometry] to [page:BufferGeometry].
+		</div>
 
 
 
@@ -18,117 +20,79 @@
 
 
 		<h3>[name]()</h3>
-		<div>
-		This creates a new [name].
-		</div>
+		<div>This creates a new [name].</div>
 
 
 		<h2>Properties</h2>
 
 		<h3>[property:Integer id]</h3>
-		<div>
-		Unique number for this [name] instance.
-		</div>
+		<div>Unique number for this [name] instance.</div>
 
 		<h3>[property:String name]</h3>
-		<div>
-		Optional name. Default is the empty string.
-		</div>
+		<div>Optional name. Default is the empty string.</div>
 
 		<h3>[property:Array type]</h3>
-		<div>
-		String 'DirectGeometry'.
-		</div>
+		<div>String 'DirectGeometry'.</div>
 
 		<h3>[property:Array indices]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array vertices]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array normals]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array colors]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array uvs]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array uvs2]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array groups]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array morphTargets]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array skinWeights]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
 		<h3>[property:Array skinIndices]</h3>
-		<div>
-			Default is empty array.
-		</div>
+		<div>Initialiased as an empty array, this is populated by [page:.fromGeometry]().</div>
 
-		<h3>[property:Box boundingBox]</h3>
+		<h3>[property:Box3 boundingBox]</h3>
 		<div>
-			Default is null.
+			Bounding box for the bufferGeometry, which can be calculated with
+			[page:.computeBoundingBox](). Default is *null*.
 		</div>
 
-		<h3>[property:Box boundingSphere]</h3>
+		<h3>[property:Sphere boundingSphere]</h3>
 		<div>
-			Default is null.
+			Bounding sphere for the bufferGeometry, which can be calculated with
+			[page:.computeBoundingSphere](). Default is *null*.
 		</div>
 
 		<h3>[property:Boolean verticesNeedUpdate]</h3>
-		<div>
-			Default is false.
-		</div>
+		<div>Default is false.</div>
 
 		<h3>[property:Boolean normalsNeedUpdate]</h3>
-		<div>
-			Default is false.
-		</div>
+		<div>Default is false.</div>
 
 		<h3>[property:Boolean verticesNeedUpdate]</h3>
-		<div>
-			Default is false.
-		</div>
+		<div>Default is false.</div>
 
 		<h3>[property:Boolean colorsNeedUpdate]</h3>
-		<div>
-			Default is false.
-		</div>
+		<div>Default is false.</div>
 
 		<h3>[property:Boolean uvsNeedUpdate]</h3>
-		<div>
-			Default is false.
-		</div>
+		<div>Default is false.</div>
 
 		<h3>[property:Boolean groupsNeedUpdate]</h3>
-		<div>
-			Default is false.
-		</div>
+		<div>Default is false.</div>
 
 
 		<h2>Methods</h2>
@@ -145,17 +109,20 @@
 		 See [page:Geometry.computeBoundingSphere].
 		</div>
 
-		<h3>[property:null computeGroups]( page:Geometry geometry] )</h3>
+		<h3>[property:null computeGroups]( [page:Geometry geometry] )</h3>
 		<div>
+			Compute the parts of the geometry that have different materialIndex.
+			See [page:BufferGeometry.groups].
 		</div>
 
-		<h3>[property:null fromGeometry]( page:Geometry geometry] )</h3>
+		<h3>[method:null dispose]()</h3>
 		<div>
+		Disposes the object from memory. <br />
+		You need to call this when you want the directGeometry removed while the application is running.
 		</div>
 
-		<h3>[property:null dispose]( )</h3>
-		<div>
-		</div>
+		<h3>[property:null fromGeometry]( [page:Geometry geometry] )</h3>
+		<div>Pass in a [page:Geometry] instance for conversion.</div>
 
 
 		<h2>Source</h2>