Documentation: lod property renamed (mrdoob#8628)

aardgoose · mrdoob · commit 828e93600e5f · 2016-04-17T16:44:29.000+01:00
* Fix levels property name

* correct type of levels array contents

* correct spacing of method parameters

* Move legacy code to Three.Legacy.js
diff --git a/docs/api/objects/LOD.html b/docs/api/objects/LOD.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html lang="en">
 	<head>
-		<meta charset="utf-8" />
+		<meta charset="utf-8" />
 		<base href="../../" />
 		<script src="list.js"></script>
 		<script src="page.js"></script>
@@ -45,16 +45,23 @@ <h2>Properties</h2>
 
 
 
-		<h3>[property:array objects]</h3>
+		<h3>[property:array levels]</h3>
 		<div>
-		An array of [page:Object3D Object3Ds]
+		An array of [page:object level] objects
+		</div>
+		<div>
+		level is an object with two properties.
+		</div>
+		<div>
+		distance -- The distance at which to display this level of detail<br />
+		object -- The Object3D which will be displayed
 		</div>
 
 		<h2>Methods</h2>
 
 
 
-		<h3>[method:null addLevel]([page:Object3D mesh], [page:Float distance])</h3>
+		<h3>[method:null addLevel]( [page:Object3D mesh], [page:Float distance] )</h3>
 		<div>
 		mesh -- The Object3D to display <br />
 		distance -- The distance at which to display this level of detail
@@ -64,20 +71,20 @@ <h3>[method:null addLevel]([page:Object3D mesh], [page:Float distance])</h3>
 		the lower the detail on the mesh.
 		</div>
 
-		<h3>[method:Object3D getObjectForDistance]([page:Float distance])</h3>
+		<h3>[method:Object3D getObjectForDistance]( [page:Float distance] )</h3>
 		<div>
 		Get a reference to the first [page:Object3D] (mesh) that is greater than supplied distance.
 		</div>
 
-		<h3>[method:null update]([page:Camera camera])</h3>
+		<h3>[method:null update]( [page:Camera camera] )</h3>
 		<div>
 		camera -- The current camera
 		</div>
 		<div>
 		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:Object3D clone]( [page:Object3D object] )</h3>
 		<div>
 		object -- (optional) Object3D which needs to be cloned. If undefined, clone method will create a new cloned LOD Object.
 		</div>
diff --git a/src/Three.Legacy.js b/src/Three.Legacy.js
@@ -827,3 +827,16 @@ THREE.CanvasRenderer = function () {
 //
 
 THREE.MeshFaceMaterial = THREE.MultiMaterial;
+
+//
+
+Object.defineProperties( THREE.LOD.prototype, {
+	objects: {
+		get: function () {
+
+			console.warn( 'THREE.LOD: .objects has been renamed to .levels.' );
+			return this.levels;
+
+		}
+	}
+} );
diff --git a/src/objects/LOD.js b/src/objects/LOD.js
@@ -14,14 +14,6 @@ THREE.LOD = function () {
 		levels: {
 			enumerable: true,
 			value: []
-		},
-		objects: {
-			get: function () {
-
-				console.warn( 'THREE.LOD: .objects has been renamed to .levels.' );
-				return this.levels;
-
-			}
 		}
 	} );
 
