Skip to content

Commit

Permalink
Correct object3d and its main derivatives' clone() method documentati…
Browse files Browse the repository at this point in the history
…on. (mrdoob#9030)
  • Loading branch information
aardgoose authored and mrdoob committed May 31, 2016
1 parent 6e4e899 commit a06fd31
Show file tree
Hide file tree
Showing 11 changed files with 35 additions and 59 deletions.
7 changes: 5 additions & 2 deletions docs/api/core/Object3D.html
Original file line number Diff line number Diff line change
Expand Up @@ -250,9 +250,12 @@ <h3>[method:null updateMatrixWorld]( [page:Boolean force] )</h3>
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>


Expand Down
7 changes: 2 additions & 5 deletions docs/api/objects/Bone.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,9 @@ <h3>[property:SkinnedMesh skin]</h3>

<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>
Expand Down
8 changes: 3 additions & 5 deletions docs/api/objects/LOD.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,12 @@ <h3>[method:null update]( [page:Camera camera] )</h3>
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]
Expand Down
8 changes: 3 additions & 5 deletions docs/api/objects/LensFlare.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,12 @@ <h3>[method:null updateLensFlares]()</h3>
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]
Expand Down
8 changes: 3 additions & 5 deletions docs/api/objects/Line.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,12 @@ <h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects]
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]
Expand Down
8 changes: 3 additions & 5 deletions docs/api/objects/LineSegments.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,13 @@ <h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects]
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]
Expand Down
8 changes: 3 additions & 5 deletions docs/api/objects/Mesh.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,13 @@ <h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects]
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]
Expand Down
13 changes: 3 additions & 10 deletions docs/api/objects/Points.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,17 @@ <h3>[property:Material material]</h3>

<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]
Expand Down
3 changes: 2 additions & 1 deletion docs/api/objects/Skeleton.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,9 @@ <h3>[method:null update]()</h3>

<h3>[method:Skeleton clone]()</h3>
<div>
Clone a Skeleton Object.
Returns a clone of this Skeleton object.
</div>


<h2>Source</h2>

Expand Down
8 changes: 3 additions & 5 deletions docs/api/objects/SkinnedMesh.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,11 @@ <h3>[method:Bone addBone]( [page:Bone bone] )</h3>
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>

Expand Down
16 changes: 5 additions & 11 deletions docs/api/objects/Sprite.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,16 @@ <h3>[property:SpriteMaterial material]</h3>
<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]
Expand Down

0 comments on commit a06fd31

Please sign in to comment.