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

Added reference to base class props and methods

Lewy Blue 8 years ago
parent
370b1f95da
commit
52465814aa
10 changed files with 49 additions and 43 deletions
Split View Show Diff Stats
  1. 7 15
      docs/api/objects/Bone.html
  2. 2 4
      docs/api/objects/Group.html
  3. 10 8
      docs/api/objects/LOD.html
  4. 2 0
      docs/api/objects/LensFlare.html
  5. 3 1
      docs/api/objects/Line.html
  6. 4 2
      docs/api/objects/LineSegments.html
  7. 2 0
      docs/api/objects/Mesh.html
  8. 2 0
      docs/api/objects/Points.html
  9. 14 12
      docs/api/objects/SkinnedMesh.html
  10. 3 1
      docs/api/objects/Sprite.html

+ 7 - 15
docs/api/objects/Bone.html
View File 

@@ -16,38 +16,30 @@
 
 		A bone which is part of a [page:Skeleton]. The skeleton in turn is used by the [page:SkinnedMesh].
 
 		Bones are almost identical to a blank [page:Object3D].
 
 		</div>
 
-		
+
 
 		<h3>Example</h3>
 
-		
+
 
 		<code>
 
 		var root = new THREE.Bone();
 
 		var child = new THREE.Bone();
 
-		
+
 
 		root.add( child );
 
 		child.position.y = 5;
 
 		</code>
 
 
 		<h2>Constructor</h2>
 
 
-
 
-		<h3>[name]( [page:SkinnedMesh skin] )</h3>
 
+		<h3>[name]( )</h3>
 
 		<div>
 
-		skin — (optional) The [page:SkinnedMesh] to which the bone belongs.
 
+		Creates a new [name].
 
 		</div>
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
-		<h3>[property:SkinnedMesh skin]</h3>
 
-		<div>
 
-		An optional reference to the [page:SkinnedMesh].
 
-		</div>
 
 
 		<h2>Methods</h2>
 
-
 
-		<h3>[method:Bone clone]()</h3>
 
-		<div>
 
-		Returns a clone of this Bone object and its descendants.
 
-		</div>
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 		<h2>Source</h2>

+ 2 - 4
docs/api/objects/Group.html
View File 

@@ -42,15 +42,13 @@
 
 		<h3>[name]( )</h3>
 
 
 		<h2>Properties</h2>
 
-
 
-		Properties are identical to an [page:Object3D]'s properties, with the exception of:
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
 		<h3>[property:String type]</h3>
 
 		<div>A string 'Group'. This should not be changed.</div>
 
 
 		<h2>Methods</h2>
 
-
 
-		Methods are identical to an [page:Object3D]'s methods.
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 		<h2>Source</h2>

+ 10 - 8
docs/api/objects/LOD.html
View File 

@@ -15,23 +15,23 @@
 
 		<div class="desc">Level of Detail - Show meshes with more or less geometry based on distance.</div>
 
 
 		<h2>Example</h2>
 
-		
+
 
 		<div>
 
 		[example:webgl_lod LOD]
 
 		</div>
 
-		
+
 
 		<code>
 
 		var lod = new THREE.LOD();
 
-		
+
 
 		//Create 5 levels of spheres
 
 		for( var i = 0; i < 5; i++ ) {
 
-			
+
 
 			var geometry = new THREE.IcosahedronGeometry( 10, 5 - i )
 
-			
+
 
 			new THREE.Mesh( geometry, material );
 
-			
+
 
 			lod.addLevel( mesh, i * 50 );
 
-			
+
 
 		}
 
 		</code>
 
 
@@ -42,6 +42,7 @@
 
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
 
 
@@ -58,6 +59,7 @@
 
 		</div>
 
 
 		<h2>Methods</h2>
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 
 
@@ -83,7 +85,7 @@
 
 		<div>
 
 		Update the visiblility of the level of detail based on the distance from the camera.
 
 		</div>
 
-		
+
 
 		<h3>[method:LOD clone]()</h3>
 
 		<div>
 
 		Returns a clone of this LOD object and its associated distance specific objects.

+ 2 - 0
docs/api/objects/LensFlare.html
View File 

@@ -35,6 +35,7 @@
 
 		</div>

 

 		<h2>Properties</h2>

+		<div>See the base [page:Object3D] class for common properties.</div>

 

 

 

@@ -54,6 +55,7 @@
 
 		</div>

 

 		<h2>Methods</h2>

+		<div>See the base [page:Object3D] class for common methods.</div>

 

 

 		<h3>[method:null add]( [page:Texture texture], [page:Float size], [page:Float distance], [page:Materials blending], [page:Color color] )</h3>

+ 3 - 1
docs/api/objects/Line.html
View File 

@@ -46,6 +46,7 @@
 
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
 		<h3>[property:Geometry geometry]</h3>
 
 		<div>
 
@@ -59,12 +60,13 @@
 
 
 
 		<h2>Methods</h2>
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 		<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
 
 		<div>
 
 		Get intersections between a casted ray and this Line. [page:Raycaster.intersectObject] will call this method.
 
 		</div>
 
-		
+
 
 		<h3>[method:Line clone]()</h3>
 
 		<div>
 
 		Returns a clone of this Line object and its descendants.

+ 4 - 2
docs/api/objects/LineSegments.html
View File 

@@ -8,7 +8,7 @@
 
 		<link type="text/css" rel="stylesheet" href="page.css" />
 
 	</head>
 
 	<body>
 
-		[page:Line] &rarr;
 
+		[page:Object3D] &rarr; [page:Line] &rarr;
 
 
 		<h1>[name]</h1>
 
 
@@ -28,6 +28,7 @@
 
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Line] class for common properties.</div>
 
 
 		<h3>[property:Geometry geometry]</h3>
 
 		<div>
 
@@ -41,12 +42,13 @@
 
 
 
 		<h2>Methods</h2>
 
+		<div>See the base [page:Line] class for common methods.</div>
 
 
 		<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
 
 		<div>
 
 		Get intersections between a casted ray and this Line. [page:Raycaster.intersectObject] will call this method.
 
 		</div>
 
-		
+
 
 		<h3>[method:LineSegments clone]()</h3>
 
 		<div>
 
 		Returns a clone of this LineSegments object and its descendants.

+ 2 - 0
docs/api/objects/Mesh.html
View File 

@@ -35,6 +35,7 @@
 
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
 		<h3>[property:Geometry geometry]</h3>
 
 
@@ -65,6 +66,7 @@
 
 		</div>
 
 
 		<h2>Methods</h2>
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 		<h3>[method:null updateMorphTargets]()</h3>
 
 		<div>

+ 2 - 0
docs/api/objects/Points.html
View File 

@@ -26,6 +26,7 @@
 
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
 		<h3>[property:Geometry geometry]</h3>
 
 
@@ -37,6 +38,7 @@
 
 
 
 		<h2>Methods</h2>
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 		<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
 
 		<div>

+ 14 - 12
docs/api/objects/SkinnedMesh.html
View File 

@@ -33,38 +33,38 @@
 
 		</script>
 
 
 		<h2>Example</h2>
 
-		
+
 
 		<code>
 
 		var geometry = new THREE.CylinderGeometry( 5, 5, 5, 5, 15, 5, 30 );
 
-		
+
 
 		//Create the skin indices and skin weights
 
 		for ( var i = 0; i < geometry.vertices.length; i ++ ) {
 
-			
+
 
 			// Imaginary functions to calculate the indices and weights
 
 			// This part will need to be changed depending your skeleton and model
 
 			var skinIndex = calculateSkinIndex( geometry.vertices, i );
 
 			var skinWeight = calculateSkinWeight( geometry.vertices, i );
 
-			
+
 
 			// Ease between each bone
 
 			geometry.skinIndices.push( new THREE.Vector4( skinIndex, skinIndex + 1, 0, 0 ) );
 
-			geometry.skinWeights.push( new THREE.Vector4( 1 - skinWeight, skinWeight, 0, 0 ) );		
-			
+			geometry.skinWeights.push( new THREE.Vector4( 1 - skinWeight, skinWeight, 0, 0 ) );
 
+
 
 		}
 
-		
+
 
 		var mesh = THREE.SkinnedMesh( geometry, material );
 
 
 		// See example from THREE.Skeleton for the armSkeleton
 
 		var rootBone = armSkeleton.bones[ 0 ];
 
 		mesh.add( rootBone );
 
-		
+
 
 		// Bind the skeleton to the mesh
 
 		mesh.bind( armSkeleton );
 
-		
+
 
 		// Move the bones and manipulate the model
 
 		armSkeleton.bones[ 0 ].rotation.x = -0.1;
 
 		armSkeleton.bones[ 1 ].rotation.x = 0.2;
 
 		</code>
 
-		
+
 
 		<h2>Constructor</h2>
 
 
 		<h3>[name]( [page:Geometry geometry], [page:Material material], [page:boolean useVertexTexture] )</h3>
 
@@ -75,6 +75,7 @@
 
 		</div>
 
 
 		<h2>Properties</h2>
 
+		<div>See the base [page:Object3D] class for common properties.</div>
 
 
 		<h3>[property:array bones]</h3>
 
 		<div>
 
@@ -101,7 +102,7 @@
 
 		Either "attached" or "detached". "attached" uses the [page:SkinnedMesh.matrixWorld] property for the base transform
 
 		matrix of the bones. "detached" uses the [page:SkinnedMesh.bindMatrix].
 
 		</div>
 
-		
+
 
 		<h3>[property:Matrix4 bindMatrix]</h3>
 
 		<div>
 
 		The base matrix that is used for the bound bone transforms.
 
@@ -113,6 +114,7 @@
 
 		</div>
 
 
 		<h2>Methods</h2>
 
+		<div>See the base [page:Object3D] class for common methods.</div>
 
 
 		<h3>[method:null bind]( [page:Skeleton skeleton], [page:Matrix4 bindMatrix] )</h3>
 
 		<div>
 
@@ -123,7 +125,7 @@
 
 		Bind a skeleton to the skinned mesh. The bindMatrix gets saved to .bindMatrix property and the .bindMatrixInverse
 
 		gets calculated.
 
 		</div>
 
-		
+
 
 		<h3>[method:null normalizeSkinWeights]()</h3>
 
 		<div>
 
 		Normalizes the [page:Geometry.skinWeights] vectors. Does not affect [page:BufferGeometry].

+ 3 - 1
docs/api/objects/Sprite.html
View File 

@@ -13,7 +13,7 @@
 
 		<h1>[name]</h1>

 

 		<div class="desc">A sprite is a plane in an 3d scene which faces always towards the camera.<br /><br />Sprites do not cast shadows, setting <code>castShadow = true</code> will have no effect.</div>

-		

+

                 <h2>Example</h2>

 

                 <code>

@@ -36,6 +36,7 @@
 
 

 

 		<h2>Properties</h2>

+		<div>See the base [page:Object3D] class for common properties.</div>

 

 		<h3>[property:SpriteMaterial material]</h3>

 		<div>

@@ -44,6 +45,7 @@
 
 

 

  		<h2>Methods</h2>

+		<div>See the base [page:Object3D] class for common methods.</div>

 

 		<h3>[method:Sprite clone]()</h3>

 		<div>