Browse Source

Added missing info to PerspectiveCameraDoc

looeee 8 years ago
parent
commit
34c3232862
1 changed files with 57 additions and 56 deletions
  1. 57 56
      docs/api/cameras/PerspectiveCamera.html

+ 57 - 56
docs/api/cameras/PerspectiveCamera.html

@@ -12,7 +12,12 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">Camera with perspective projection.</div>
+		<div class="desc">
+			Camera that uses [link:https://en.wikipedia.org/wiki/Perspective_(graphical) perspective projection].<br /><br />
+
+			This projection mode is designed to mimic the way the human eye sees. It is the most
+			common projection mode used for rendering a 3D scene.
+		</div>
 
 
 		<h2>Example</h2>
@@ -31,37 +36,51 @@ scene.add( camera );</code>
 
 		<h2>Constructor</h2>
 
-		<h3>[name]( [page:Float fov], [page:Float aspect], [page:Float near], [page:Float far] )</h3>
+		<h3>[name]( [page:Number fov], [page:Number aspect], [page:Number near], [page:Number far] )</h3>
 		<div>
 		fov — Camera frustum vertical field of view.<br />
 		aspect — Camera frustum aspect ratio.<br />
 		near — Camera frustum near plane.<br />
-		far — Camera frustum far plane.
+		far — Camera frustum far plane.<br /><br />
+
+			Together these define the camera's [link:https://en.wikipedia.org/wiki/Viewing_frustum viewing frustum].
 		</div>
 
 
 		<h2>Properties</h2>
+		<div>See the base [page:Camera] class for common properties.</div>
 
-		<h3>[property:Float fov]</h3>
-		<div>Camera frustum vertical field of view, from bottom to top of view, in degrees. Default is *50*.</div>
-
-		<h3>[property:number zoom]</h3>
-		<div>Gets or sets the zoom factor of the camera. Default is *1*.</div>
-
-		<h3>[property:Float near]</h3>
-		<div>Camera frustum near plane. Default is *0.1*.</div>
+		<h3>[property:Float aspect]</h3>
+		<div>Camera frustum aspect ratio, usually the canvas width / canvas height. Default is *1* (square canvas).</div>
 
 		<h3>[property:Float far]</h3>
 		<div>Camera frustum far plane. Default is *2000*.</div>
 
+		<h3>[property:Float filmGauge]</h3>
+		<div>Film size used for the larger axis. Default is 35 (millimeters). This parameter does not influence the projection matrix unless .filmOffset is set to a nonzero value.</div>
+
+		<h3>[property:Float filmOffset]</h3>
+		<div>Horizontal off-center offset in the same unit as .filmGauge. Default is *0*.</div>
+
 		<h3>[property:Float focus]</h3>
 		<div>Object distance used for stereoscopy and depth-of-field effects.
-			This parameter does not influence the projection matrix unless a StereoCamera is being used.
+			This parameter does not influence the projection matrix unless a [page:StereoCamera] is being used.
 			Default is *10*.
 		</div>
 
-		<h3>[property:Float aspect]</h3>
-		<div>Camera frustum aspect ratio, usually the canvas width / canvas height. Default is *1* (square canvas).</div>
+		<h3>[property:Float fov]</h3>
+		<div>Camera frustum vertical field of view, from bottom to top of view, in degrees. Default is *50*.</div>
+
+		<h3>[property:Boolean isPerspectiveCamera]</h3>
+		<div>
+			Used to test whether this or derived classes are PerspectiveCameras. Default is *true*.<br /><br />
+
+			This should not be changed as it is used internally by the renderer for optimisation.
+		</div>
+
+
+		<h3>[property:Float near]</h3>
+		<div>Camera frustum near plane. Default is *0.1*.</div>
 
 		<h3>[property:Object view]</h3>
 		<div>
@@ -70,51 +89,42 @@ scene.add( camera );</code>
 			and cleared using [page:PerspectiveCamera.clearViewOffset .clearViewOffset].
 		</div>
 
-		<h3>[property:Float filmGauge]</h3>
-		<div>Film size used for the larger axis. Default is 35 (millimeters). This parameter does not influence the projection matrix unless .filmOffset is set to a nonzero value.</div>
+		<h3>[property:number zoom]</h3>
+		<div>Gets or sets the zoom factor of the camera. Default is *1*.</div>
+
+
+
 
-		<h3>[property:Float filmOffset]</h3>
-		<div>Horizontal off-center offset in the same unit as .filmGauge. Default is *0*.</div>
 
 		<h2>Methods</h2>
+		<div>See the base [page:Camera] class for common methods.</div>
+
+		<h3>[method:null clearViewOffset]()</h3>
+		<div>Removes any offset set by the [page:PerspectiveCamera.setViewOffset .setViewOffset] method.</div>
 
 		<h3>[method:Float getEffectiveFOV]()</h3>
-		<div>
-		Returns the current vertical field of view angle in degrees considering .zoom.
-		</div>
+		<div>Returns the current vertical field of view angle in degrees considering .zoom.</div>
 
-		<h3>[method:Float getFocalLength]()</h3>
+		<h3>[method:Float getFilmHeight]()</h3>
 		<div>
-		Returns the focal length of the current .fov in respect to .filmGauge.
+		Returns the height of the image on the film. If .aspect is less than or equal to one
+		(portrait format), the result equals .filmGauge.
 		</div>
 
 		<h3>[method:Float getFilmWidth]()</h3>
 		<div>
-		Returns the width of the image on the film. If .aspect is greater than or equal to one (landscape format), the result equals .filmGauge.
+		Returns the width of the image on the film. If .aspect is greater than or equal to one
+		(landscape format), the result equals .filmGauge.
 		</div>
 
-		<h3>[method:Float getFilmHeight]()</h3>
-		<div>
-		Returns the height of the image on the film. If .aspect is less than or equal to one (portrait format), the result equals .filmGauge.
-		</div>
+		<h3>[method:Float getFocalLength]()</h3>
+		<div>Returns the focal length of the current .fov in respect to .filmGauge.</div>
 
 		<h3>[method:null setFocalLength]( [page:Float focalLength] )</h3>
 		<div>
-		Sets the FOV by focal length in respect to the current .filmGauge.
-		</div>
-		<div>
-		By default, the focal length is specified for a 35mm (full frame) camera.
-		</div>
+		Sets the FOV by focal length in respect to the current [page:PerspectiveCamera.filmGauge .filmGauge].<br /><br />
 
-		<h3>[method:null setLens]( [page:Float focalLength], [page:Float filmGauge] )</h3>
-		<div>
-		focalLength — focal length<br />
-		frameGauge — film gauge
-		</div>
-
-		<div>
-		Sets .fov by focal length. Optionally also sets .filmGauge.
-		This method is deprecated, please use .setFocalLength instead.
+		By default, the focal length is specified for a 35mm (full frame) camera.
 		</div>
 
 		<h3>[method:null setViewOffset]( [page:Float fullWidth], [page:Float fullHeight], [page:Float x], [page:Float y], [page:Float width], [page:Float height] )</h3>
@@ -134,11 +144,13 @@ scene.add( camera );</code>
 		<div>
 		For example, if you have 3x2 monitors and each monitor is 1920x1080 and the monitors are in grid like this:<br />
 
-		<pre>+---+---+---+
+		<pre>
++---+---+---+
 | A | B | C |
 +---+---+---+
 | D | E | F |
-+---+---+---+</pre>
++---+---+---+
+		</pre>
 
 		then for each monitor you would call it like this:<br />
 
@@ -164,20 +176,9 @@ camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
 		Note there is no reason monitors have to be the same size or in a grid.
 		</div>
 
-		<h3>[method:null clearViewOffset]()</h3>
-		<div>
-		Removes any offset set by the .setViewOffset method.
-		</div>
-
 		<h3>[method:null updateProjectionMatrix]()</h3>
 		<div>
-		Updates the camera projection matrix. Must be called after change of parameters.
-		</div>
-
-		<h3>[method:PerspectiveCamera clone]()</h3>
-		<div>
-		<br />
-		It returns a clone of PerspectiveCamera.
+		Updates the camera projection matrix. Must be called after any change of parameters.
 		</div>
 
 		<h3>[method:JSON toJSON]()</h3>