Procházet zdrojové kódy

Example of new cross-referencing in BufferGeometry docs

Casey Grun před 10 roky
rodič
revize
4eed67621a
1 změnil soubory, kde provedl 25 přidání a 25 odebrání
  1. 25 25
      docs/api/core/BufferGeometry.html

+ 25 - 25
docs/api/core/BufferGeometry.html

@@ -62,7 +62,7 @@
 		up this information into typed array buffers and sending this data to the shader. With 
 		up this information into typed array buffers and sending this data to the shader. With 
 		BufferGeometry, all of this data is stored in buffers associated with an individual attributes.
 		BufferGeometry, all of this data is stored in buffers associated with an individual attributes.
 		This means that to get the position data associated with a vertex (for instance), you must call
 		This means that to get the position data associated with a vertex (for instance), you must call
-		[member:.getAttribute] to access the 'position' [page:BufferAttribute attribute], then access the individual 
+		[page:.getAttribute] to access the 'position' [page:BufferAttribute attribute], then access the individual 
 		x, y, and z coordinates of the position.  
 		x, y, and z coordinates of the position.  
 		</p>
 		</p>
 		<p>
 		<p>
@@ -70,24 +70,24 @@
 		</p>
 		</p>
 		<h4>[page:BufferAttribute position] (itemSize: 3)</h4>
 		<h4>[page:BufferAttribute position] (itemSize: 3)</h4>
 		<div>
 		<div>
-		Stores the x, y, and z coordinates of each vertex in this geometry. Set by [member:.fromGeometry]().
+		Stores the x, y, and z coordinates of each vertex in this geometry. Set by [page:.fromGeometry]().
 		</div>
 		</div>
 
 
 		<h4>[page:BufferAttribute normal] (itemSize: 3)</h4>
 		<h4>[page:BufferAttribute normal] (itemSize: 3)</h4>
 		<div>
 		<div>
 		Stores the x, y, and z components of the face or vertex normal vector of each vertex in this geometry.
 		Stores the x, y, and z components of the face or vertex normal vector of each vertex in this geometry.
-		Set by [member:.fromGeometry]().
+		Set by [page:.fromGeometry]().
 		</div>
 		</div>
 
 
 		<h4>[page:BufferAttribute color] (itemSize: 3)</h4>
 		<h4>[page:BufferAttribute color] (itemSize: 3)</h4>
 		<div>
 		<div>
 		Stores the red, green, and blue channels of vertex color of each vertex in this geometry.
 		Stores the red, green, and blue channels of vertex color of each vertex in this geometry.
-		Set by [member:.fromGeometry]().
+		Set by [page:.fromGeometry]().
 		</div>
 		</div>
 
 
 		<h4>[page:BufferAttribute tangent] (itemSize: 3)</h4>
 		<h4>[page:BufferAttribute tangent] (itemSize: 3)</h4>
 		<div>
 		<div>
-		Stores the x, y, and z components of the tangent vector of each vertex in this geometry. Set by [member:.computeTangents]().
+		Stores the x, y, and z components of the tangent vector of each vertex in this geometry. Set by [page:.computeTangents]().
 		</div>
 		</div>
 
 
 		<h4>[page:BufferAttribute index] (itemSize: 3)</h4>
 		<h4>[page:BufferAttribute index] (itemSize: 3)</h4>
@@ -111,24 +111,24 @@
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>.[page:Integer id]</h3>
+		<h3>[property:Integer id]</h3>
 		<div>
 		<div>
 		Unique number for this buffergeometry instance.
 		Unique number for this buffergeometry instance.
 		</div>
 		</div>
 		
 		
-		<h3>.[page:Hashmap attributes]</h3>
+		<h3>[property:Hashmap attributes]</h3>
 		<div>
 		<div>
 		This hashmap has as id the name of the attribute to be set and as value the [page:BufferAttribute buffer] to set it to.
 		This hashmap has as id the name of the attribute to be set and as value the [page:BufferAttribute buffer] to set it to.
 		Rather than accessing this property directly, use addAttribute and getAttribute to access attributes of this geometry.
 		Rather than accessing this property directly, use addAttribute and getAttribute to access attributes of this geometry.
 		</div>
 		</div>
 		
 		
 		<!--
 		<!--
- 		<h3>.[page:Boolean dynamic]</h3>
+ 		<h3>[property:Boolean dynamic]</h3>
 		<div>
 		<div>
 		When set, it holds certain buffers in memory to have faster updates for this object. When unset, it deletes those buffers and   saves memory.
 		When set, it holds certain buffers in memory to have faster updates for this object. When unset, it deletes those buffers and   saves memory.
 		</div> -->
 		</div> -->
 		
 		
-		<h3>.[page:Array drawCalls] (previously .[page:Array offsets])</h3>
+		<h3>[property:Array drawCalls] (previously [property:Array offsets])</h3>
 		<div>
 		<div>
 		For geometries that use indexed triangles, this Array can be used to split the object into multiple WebGL draw calls. Each draw call will draw some subset of the vertices in this geometry using the configured [page:Material shader]. This may be necessary if, for instance, you have more than 65535 vertices in your object. 
 		For geometries that use indexed triangles, this Array can be used to split the object into multiple WebGL draw calls. Each draw call will draw some subset of the vertices in this geometry using the configured [page:Material shader]. This may be necessary if, for instance, you have more than 65535 vertices in your object. 
 		Each element is an object of the form:
 		Each element is an object of the form:
@@ -138,93 +138,93 @@
 		Use addDrawCall to add draw calls, rather than modifying this array directly.
 		Use addDrawCall to add draw calls, rather than modifying this array directly.
 		</div>
 		</div>
 
 
-		<h3>.[page:Box3 boundingBox]</h3>
+		<h3>[property:Box3 boundingBox]</h3>
 		<div>
 		<div>
 		Bounding box.
 		Bounding box.
 		<code>{ min: new THREE.Vector3(), max: new THREE.Vector3() }</code>
 		<code>{ min: new THREE.Vector3(), max: new THREE.Vector3() }</code>
 		</div>
 		</div>
 
 
-		<h3>.[page:Sphere boundingSphere]</h3>
+		<h3>[property:Sphere boundingSphere]</h3>
 		<div>
 		<div>
 		Bounding sphere.
 		Bounding sphere.
 		<code>{ radius: float }</code>
 		<code>{ radius: float }</code>
 		</div>
 		</div>
 		
 		
-		<h3>.[page:Array morphTargets]</h3>
+		<h3>[property:Array morphTargets]</h3>
 		<div>
 		<div>
 		Array of morph targets. Each morph target is a Javascript object:
 		Array of morph targets. Each morph target is a Javascript object:
 		<code>{ name: "targetName", vertices: [ new THREE.Vertex(), ... ] }</code>
 		<code>{ name: "targetName", vertices: [ new THREE.Vertex(), ... ] }</code>
 		Morph vertices match number and order of primary vertices.
 		Morph vertices match number and order of primary vertices.
 		</div>
 		</div>
 
 
-		<h3>.[page:boolean hasTangents]</h3>
+		<h3>[property:boolean hasTangents]</h3>
 		<div>
 		<div>
-		True if BufferGeometry has tangents. Set in [member:.computeTangents].
+		True if BufferGeometry has tangents. Set in [page:.computeTangents].
 		</div> 
 		</div> 
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 
 
 		<h3>[page:EventDispatcher EventDispatcher] methods are available on this class.</h3>
 		<h3>[page:EventDispatcher EventDispatcher] methods are available on this class.</h3>
 		
 		
-		<h3>.[page:null addAttribute]( [page:String name], [page:BufferAttribute attribute] )</h3>
+		<h3>[property:null addAttribute]( [page:String name], [page:BufferAttribute attribute] )</h3>
 		<div>
 		<div>
 		Adds an attribute to this geometry. Use this rather than the attributes property, 
 		Adds an attribute to this geometry. Use this rather than the attributes property, 
 		because an internal array of attributes is maintained to speed up iterating over
 		because an internal array of attributes is maintained to speed up iterating over
 		attributes.
 		attributes.
 		</div>
 		</div>
 
 
-		<h3>.[page:null addDrawCall]( [page:Integer start], [page:Integer count], [page:Integer indexOffset] )</h3>
+		<h3>[method:null addDrawCall]( [page:Integer start], [page:Integer count], [page:Integer indexOffset] )</h3>
 		<div>
 		<div>
 		Adds a draw call to this geometry; see the drawcalls property for details.
 		Adds a draw call to this geometry; see the drawcalls property for details.
 		</div>
 		</div>
 
 
 
 
-		<h3>.[page:null applyMatrix]( [page:Matrix4 matrix] )</h3>
+		<h3>[method:null applyMatrix]( [page:Matrix4 matrix] )</h3>
 		<div>
 		<div>
 		Bakes matrix transform directly into vertex coordinates.
 		Bakes matrix transform directly into vertex coordinates.
 		</div>
 		</div>
 
 
-		<h3>.[page:null computeVertexNormals]()</h3>
+		<h3>[method:null computeVertexNormals]()</h3>
 		<div>
 		<div>
 		Computes vertex normals by averaging face normals.<br />
 		Computes vertex normals by averaging face normals.<br />
 		</div>
 		</div>
 
 
-		<h3>.[page:null computeTangents]()</h3>
+		<h3>[method:null computeTangents]()</h3>
 		<div>
 		<div>
 		Computes vertex tangents.<br />
 		Computes vertex tangents.<br />
 		Based on [link:http://www.terathon.com/code/tangent.html]<br />
 		Based on [link:http://www.terathon.com/code/tangent.html]<br />
 		Geometry must have vertex [page:UV UVs] (layer 0 will be used).
 		Geometry must have vertex [page:UV UVs] (layer 0 will be used).
 		</div>
 		</div>
 
 
-		<h3>.[page:null computeBoundingBox]()</h3>
+		<h3>[method:null computeBoundingBox]()</h3>
 		<div>
 		<div>
 		Computes bounding box of the geometry, updating [page:Geometry Geometry.boundingBox] attribute.<br />
 		Computes bounding box of the geometry, updating [page:Geometry Geometry.boundingBox] attribute.<br />
 		Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are *null*.
 		Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are *null*.
 		</div>
 		</div>
 
 
-		<h3>.[page:null computeBoundingSphere]()</h3>
+		<h3>[method:null computeBoundingSphere]()</h3>
 		<div>
 		<div>
 		Computes bounding sphere of the geometry, updating [page:Geometry Geometry.boundingSphere] attribute.<br />
 		Computes bounding sphere of the geometry, updating [page:Geometry Geometry.boundingSphere] attribute.<br />
 		Bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are *null*.
 		Bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are *null*.
 		</div>
 		</div>
 		
 		
-		<h3>.[page:null dispose]()</h3>
+		<h3>[method:null dispose]()</h3>
 		<div>
 		<div>
 		Disposes the object from memory. <br />
 		Disposes the object from memory. <br />
 		You need to call this when you want the bufferGeometry removed while the application is running.
 		You need to call this when you want the bufferGeometry removed while the application is running.
 		</div>
 		</div>
 
 
-		<h3>.[page:null fromGeometry]( [page:Geometry] )</h3>
+		<h3>[method:null fromGeometry]( [page:Geometry] )</h3>
 		<div>
 		<div>
 		Populates this BufferGeometry with data from a [page:Geometry] object.
 		Populates this BufferGeometry with data from a [page:Geometry] object.
 		</div>
 		</div>
 
 
-		<h3>.[page:BufferAttribute getAttribute]( [page:String name] )</h3>
+		<h3>[method:BufferAttribute getAttribute]( [page:String name] )</h3>
 		<div>
 		<div>
 		Returns the [page:BufferAttribute attribute] with the specified name.
 		Returns the [page:BufferAttribute attribute] with the specified name.
 		</div>
 		</div>
 
 
-		<h3>.[page:null normalizeNormals]()</h3>
+		<h3>[method:null normalizeNormals]()</h3>
 		<div>
 		<div>
 		Every normal vector in a geometry will have a magnitude of 1.
 		Every normal vector in a geometry will have a magnitude of 1.
 		This will correct lighting on the geometry surfaces.
 		This will correct lighting on the geometry surfaces.