Browse Source

Minor improvements to CameraHelper doc

looeee 8 years ago
parent
commit
b0407f4da5
1 changed files with 37 additions and 15 deletions
  1. 37 15
      docs/api/extras/helpers/CameraHelper.html

+ 37 - 15
docs/api/extras/helpers/CameraHelper.html

@@ -8,48 +8,70 @@
 		<link type="text/css" rel="stylesheet" href="page.css" />
 		<link type="text/css" rel="stylesheet" href="page.css" />
 	</head>
 	</head>
 	<body>
 	<body>
-		[page:Line] &rarr;
+		[page:LineSegments] &rarr;
 
 
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
 		<div class="desc">
 		<div class="desc">
-		The camera Helper is an Object3D which helps visualizing what a camera contains in its frustum.<br />
-		It visualizes the frustum with an line Geometry.
+		This helps with visualizing what a camera contains in its frustum.<br />
+		It visualizes the frustum of a camera using a [page:LineSegments].
 		</div>
 		</div>
 
 
+		<h2>Example</h2>
+
+		<div>[example:webgl_camera WebGL / camera]</div>
+		<div>[example:webgl_geometry_extrude_splines WebGL / extrude / splines]</div>
+
+		<code>
+var camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 0.1, 1000 );
+
+var helper = new THREE.CameraHelper( cameraPerspective );
+scene.add( helper );
+		</code>
+
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
 
 
-		<h3>[name]([page:Camera camera])</h3>
-		<div>
-		camera -- The camera to visualize.
-		</div>
+		<h3>[name]( [page:Camera camera] )</h3>
 		<div>
 		<div>
+		[page:Camera camera] -- The camera to visualize.<br /><br />
+
 		This create a new [Name] for the specified camera.
 		This create a new [Name] for the specified camera.
 		</div>
 		</div>
 
 
 
 
+
 		<h2>Properties</h2>
 		<h2>Properties</h2>
+		<div>See the base [page:LineSegments] class for common properties.</div>
 
 
 
 
-		<h3>[property:object pointMap]</h3>
-		<div>
-		This contains the points to viualize the cameraHelper
-		</div>
 
 
 		<h3>[property:Camera camera]</h3>
 		<h3>[property:Camera camera]</h3>
+		<div>The camera to visualize.</div>
+
+		<h3>[property:object pointMap]</h3>
+		<div>This contains the points to visualize the cameraHelper.</div>
+
+		<h3>[property:object matrix]</h3>
+		<div>Reference to the [page:Object3D.matrixWorld camera.matrixWorld].</div>
+
+		<h3>[property:object matrixAutoUpdate]</h3>
 		<div>
 		<div>
-		The camera to visualize.
+			See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
+			camera's [page:Object3D.matrixWorld matrixWorld].
 		</div>
 		</div>
 
 
+
+
+
+
 		<h2>Methods</h2>
 		<h2>Methods</h2>
+		<div>See the base [page:LineSegments] class for common methods.</div>
 
 
 
 
 		<h3>[method:null update]()</h3>
 		<h3>[method:null update]()</h3>
-		<div>
-		Updates the helper based on the projectionMatrix of the camera.
-		</div>
+		<div>Updates the helper based on the projectionMatrix of the camera.</div>
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>