Browse Source

Merge branch 'patch-10' of https://github.com/gero3/three.js into dev

Mr.doob 11 years ago
parent
commit
a8aabd3edd
1 changed files with 15 additions and 17 deletions
  1. 15 17
      docs/api/objects/SkinnedMesh.html

+ 15 - 17
docs/api/objects/SkinnedMesh.html

@@ -11,20 +11,20 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
+		<div class="desc">An 3d object that has bones data. These Bones can then be used to animate the vertices of the object.</div>
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:todo geometry], [page:todo material], [page:todo useVertexTexture])</h3>
+		<h3>[name]([page:Geometry geometry], [page:Material material], [page:boolean useVertexTexture])</h3>
 		<div>
-		geometry -- todo <br />
-		material -- todo <br />
-		useVertexTexture -- todo
+                geometry — An instance of [page:Geometry].<br />
+                material — An instance of [page:Material] (optional).<br />
+		useVertexTexture -- Defines wether a vertex texture can be used (optional).
 		</div>
 		<div>
-		todo
+		This Creates a new instance of skinnedMesh. 
 		</div>
 
 
@@ -34,39 +34,37 @@
 
 		<h3>.[page:array bones]</h3>
 		<div>
-		todo
+		This contains the array of bones for this mesh. These should be set in the constructor.
 		</div> 
 
 		<h3>.[page:Matrix4 identityMatrix]</h3>
 		<div>
-		todo
+		This is an identityMatrix to calculate the bones matrices from.
 		</div> 
 
 		<h3>.[page:boolean useVertexTexture]</h3>
 		<div>
-		todo
+		The boolean defines whether a vertex texture is used to calculate the bones. This boolean shouldn't be changed after constructor.
 		</div> 
 
 		<h3>.[page:array boneMatrices]</h3>
 		<div>
-		todo
+		This array of matrices contains the matrices of the bones. These get calculated in the constructor.
 		</div> 
 
 		<h2>Methods</h2>
 
-
-
-		<h3>.pose() [page:todo]</h3>
+		<h3>.pose()</h3>
 		<div>
-		todo
+		This method sets the skinnedmesh in the rest pose.
 		</div>
 
-		<h3>.addBone([page:todo bone]) [page:todo]</h3>
+		<h3>.addBone([page:Bone bone]) [page:Bone]</h3>
 		<div>
-		bone -- todo
+		bone -- This is the bone that needs to be added. (optional)
 		</div>
 		<div>
-		todo
+		This method adds the bone to the skinnedmesh when it is provided. It creates a new bone and adds that when no bone is given.
 		</div>
 
 		<h2>Source</h2>