Browse Source

SkeletonHelper: Improve docs and TS file.

Mugen87 5 years ago
parent
commit
800000b11f

+ 7 - 8
docs/api/en/helpers/SkeletonHelper.html

@@ -20,13 +20,14 @@
 
 		<h2>Example</h2>
 
+		<p>
 		[example:webgl_animation_skinning_blending animation / skinning / blending]<br />
 		[example:webgl_animation_skinning_morph animation / skinning / morph]<br />
 		[example:webgl_loader_bvh loader / bvh ]
+		</p>
 
 		<code>
-var helper = new THREE.SkeletonHelper( mesh );
-helper.material.linewidth = 3;
+var helper = new THREE.SkeletonHelper( skinnedMesh );
 scene.add( helper );
 		</code>
 
@@ -35,13 +36,12 @@ scene.add( helper );
 		<h2>Constructor</h2>
 
 
-		<h3>[name]( object )</h3>
+		<h3>[name]( [param:Object3D object] )</h3>
 		<p>
-		object -- can be any object that has an array of [page:Bone Bone]s as a sub object. <br />
-		For example, a [page:Skeleton Skeleton] or a [page:SkinnedMesh SkinnedMesh].
+		object -- Usually an instance of [page:SkinnedMesh]. However, any instance of [page:Object3D] can be used if it represents
+		a hierarchy of [page:Bone Bone]s (via [page:Object3D.children]).
 		</p>
 
-
 		<h2>Properties</h2>
 
 		<h3>[property:Array bones]</h3>
@@ -49,12 +49,11 @@ scene.add( helper );
 		The list of bones that the helper renders as [page:Line Lines].
 		</p>
 
-		<h3>[property:Object root]</h3>
+		<h3>[property:Object3D root]</h3>
 		<p>
 		The object passed in the constructor.
 		</p>
 
-
 		<h2>Source</h2>
 
 		<p>

+ 7 - 6
docs/api/zh/helpers/SkeletonHelper.html

@@ -20,13 +20,14 @@
 
 		<h2>例子</h2>
 
+		<p>
 		[example:webgl_animation_skinning_blending animation / skinning / blending]<br />
 		[example:webgl_animation_skinning_morph animation / skinning / morph]<br />
 		[example:webgl_loader_bvh loader / bvh ]
+		</p>
 
 		<code>
-var helper = new THREE.SkeletonHelper( mesh );
-helper.material.linewidth = 3;
+var helper = new THREE.SkeletonHelper( skinnedMesh );
 scene.add( helper );
 		</code>
 
@@ -35,10 +36,10 @@ scene.add( helper );
 		<h2>构造函数</h2>
 
 
-		<h3>[name]( object )</h3>
+		<h3>[name]( [param:Object3D object] )</h3>
 		<p>
-		object -- 可以是任何拥有一组骨 [page:Bone Bone] 作为子对象的对象. <br />
-		比如, 一个骨骼 [page:Skeleton Skeleton] 或 一个蒙皮网格 [page:SkinnedMesh SkinnedMesh].
+		object -- Usually an instance of [page:SkinnedMesh]. However, any instance of [page:Object3D] can be used if it represents
+		a hierarchy of [page:Bone Bone]s (via [page:Object3D.children]).
 		</p>
 
 
@@ -49,7 +50,7 @@ scene.add( helper );
 		辅助对象使用 [page:Line Lines] 渲染的骨数组.
 		</p>
 
-		<h3>[property:Object root]</h3>
+		<h3>[property:Object3D root]</h3>
 		<p>
 		构造函数传入的对象.
 		</p>

+ 1 - 1
src/helpers/SkeletonHelper.d.ts

@@ -4,7 +4,7 @@ import { LineSegments } from './../objects/LineSegments';
 
 export class SkeletonHelper extends LineSegments {
 
-	constructor( bone: Object3D );
+	constructor( object: Object3D );
 
 	bones: Bone[];
 	root: Object3D;