Ver código fonte

Correct object3d and its main derivatives' clone() method documentation. (#9030)

aardgoose 9 anos atrás
pai
commit
a06fd31ebe

+ 5 - 2
docs/api/core/Object3D.html

@@ -250,9 +250,12 @@
 		Updates global transform of the object and its children.
 		</div>
 
-		<h3>[method:Object3D clone]()</h3>
+		<h3>[method:Object3D clone]( [page:Boolean recursive] )</h3>
 		<div>
-		Creates a new clone of this object and all descendants.
+		recursive -- if true, descendants of the object are also cloned. Default is true.
+		</div>
+		<div>
+		Returns a clone of this object and optionaly all descendants.
 		</div>
 
 

+ 2 - 5
docs/api/objects/Bone.html

@@ -44,12 +44,9 @@
 
 		<h2>Methods</h2>
 
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:Bone clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Bone Object.
-		</div>
-		<div>
-		Clone a Bone Object.
+		Returns a clone of this Bone object and its descendants.
 		</div>
 
 		<h2>Source</h2>

+ 3 - 5
docs/api/objects/LOD.html

@@ -84,14 +84,12 @@
 		Update the visiblility of the level of detail based on the distance from the camera.
 		</div>
 		
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:LOD clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned LOD Object.
-		</div>
-		<div>
-		Clone a LOD Object.
+		Returns a clone of this LOD object and its associated distance specific objects.
 		</div>
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 3 - 5
docs/api/objects/LensFlare.html

@@ -67,14 +67,12 @@
 		Updates the lens flare based on the [page:LensFlare.positionScreen positionScreen] property.
 		</div>
 
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:Lens Flare clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned LensFlare Object.
-		</div>
-		<div>
-		Clone a LensFlare Object.
+		Returns a clone of this LensFlare object and its descendants.
 		</div>
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 3 - 5
docs/api/objects/Line.html

@@ -65,14 +65,12 @@
 		Get intersections between a casted ray and this Line. [page:Raycaster.intersectObject] will call this method.
 		</div>
 		
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:Line clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Line Object.
-		</div>
-		<div>
-		Clone a Line Object.
+		Returns a clone of this Line object and its descendants.
 		</div>
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 3 - 5
docs/api/objects/LineSegments.html

@@ -47,15 +47,13 @@
 		Get intersections between a casted ray and this Line. [page:Raycaster.intersectObject] will call this method.
 		</div>
 		
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:LineSegments clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned LineSegments Object.
-		</div>
-		<div>
-		Clone a LineSegments Object.
+		Returns a clone of this LineSegments object and its descendants.
 		</div>
 
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 3 - 5
docs/api/objects/Mesh.html

@@ -91,15 +91,13 @@
 		Get intersections between a casted ray and this mesh. [page:Raycaster.intersectObject] will call this method.
 		</div>
 
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:Mesh clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Mesh Object.
-		</div>
-		<div>
-		Clone a Mesh Object.
+		Returns a clone of this Mesh object and its descendants.
 		</div>
 
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 3 - 10
docs/api/objects/Points.html

@@ -38,24 +38,17 @@
 
 		<h2>Methods</h2>
 
-		<h3>[method:Points clone]()</h3>
-		<div>
-		This creates a clone of the particle system.
-		</div>
-
 		<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
 		<div>
 		Get intersections between a casted ray and this Points. [page:Raycaster.intersectObject] will call this method.
 		</div>
 
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
-		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Points Object.
-		</div>
+		<h3>[method:Points clone]()</h3>
 		<div>
-		Clone a Points Object.
+		Returns a clone of this Points object and its descendants.
 		</div>
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]

+ 2 - 1
docs/api/objects/Skeleton.html

@@ -123,8 +123,9 @@
 		
 		<h3>[method:Skeleton clone]()</h3>
 		<div>
-		Clone a Skeleton Object.
+		Returns a clone of this Skeleton object.
 		</div>
+
 		
 		<h2>Source</h2>
 

+ 3 - 5
docs/api/objects/SkinnedMesh.html

@@ -130,13 +130,11 @@
 		This method adds the bone to the skinned mesh when it is provided. It creates a new bone and adds that when no bone is given.
 		</div>
 
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
+		<h3>[method:SkinnedMesh clone]()</h3>
 		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned SkinnedMesh Object.
-		</div>
-		<div>
-		Clone a SkinnedMesh Object.
+		Returns a clone of this SkinnedMesh object and its descendants.
 		</div>
+
 		
 		<h2>Source</h2>
 

+ 5 - 11
docs/api/objects/Sprite.html

@@ -41,22 +41,16 @@
 		<div>
 		An instance of [page:Material], defining the object's appearance. Default is a [page:SpriteMaterial] which is a white plane.
 		</div>
--
-           	<h2>Methods</h2>
 
-                <h3>[method:Sprite clone]()</h3>
-                <div>
-                This creates a new clone of the sprite.
-                </div>
 
-		<h3>[method:Object3D clone]( [page:Object3D object] )</h3>
-		<div>
-		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned Sprite Object.
-		</div>
+ 		<h2>Methods</h2>
+
+		<h3>[method:Sprite clone]()</h3>
 		<div>
-		Clone a Sprite Object.
+		Returns a clone of this Sprite object and its descendants.
 		</div>
 
+
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]