浏览代码

More documentation love.

Mr.doob 13 年之前
父节点
当前提交
dd04457ad4
共有 4 个文件被更改,包括 56 次插入10 次删除
  1. 4 7
      docs/api/cameras/Camera.html
  2. 50 0
      docs/api/cameras/PerspectiveCamera.html
  3. 1 1
      docs/index.html
  4. 1 2
      docs/styles.css

+ 4 - 7
docs/api/cameras/Camera.html

@@ -6,7 +6,6 @@
 		<link rel="stylesheet" type="text/css" href="../../styles.css" />
 	</head>
 	<body>
-
 		<h1>Camera &larr; <a href="../core/Object3D.js">Object3D</a></h1>
 
 		<div>Abstract base class for cameras.</div>
@@ -14,28 +13,26 @@
 
 		<h2>Constructor</h2>
 
-		<code>
-			Camera()
-		</code>
+		<h3>Camera()</h3>
 
 
 		<h2>Properties</h2>
 
 		<h3>matrixWorldInverse <a href="../core/Matrix4.js">Matrix4</a></h3>
+
 		<h3>projectionMatrix <a href="../core/Matrix4.js">Matrix4</a></h3>
+
 		<h3>projectionMatrixInverse <a href="../core/Matrix4.js">Matrix4</a></h3>
 
 
 		<h2>Methods</h2>
 
 		<h3>lookAt( vector <a href="../core/Vector3.js">Vector3</a> )</h3>
-
 		<div>Orient camera to look at Vector3()</div>
 
 
 		<h2>Source</h2>
 
-		<div><a href="https://github.com/mrdoob/three.js/blob/master/src/cameras/Camera.js">src/cameras/Camera.js</a></div>
-
+		<div><a href="https://github.com/mrdoob/three.js/blob/master/src/cameras/Camera.js" target="_blank">src/cameras/Camera.js</a></div>
 	</body>
 </html>

+ 50 - 0
docs/api/cameras/PerspectiveCamera.html

@@ -0,0 +1,50 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8">
+		<title>PerspectiveCamera</title>
+		<link rel="stylesheet" type="text/css" href="../../styles.css" />
+	</head>
+	<body>
+		<h1>PerspectiveCamera &larr; <a href="../cameras/Camera.html">Camera</a> &larr; <a href="../core/Object3D.html">Object3D</a></h1>
+
+		<div>Camera with perspective projection.</div>
+
+
+		<h2>Constructor</h2>
+
+		<h3>PerspectiveCamera( fov <a href="../core/Number.html">Number</a>, aspect <a href="../core/Number.html">Number</a>, near <a href="../core/Number.html">Number</a>, far <a href="../core/Number.html">Number</a> )</h3>
+
+
+		<h2>Properties</h2>
+
+		<h3>fov <a href="../core/Number.html">Number</a></h3>
+		<div>Camera frustum vertical field of view.</div>
+
+		<h3>aspect <a href="../core/Number.html">Number</a></h3>
+		<div>Camera frustum aspect ratio.</div>
+
+		<h3>near <a href="../core/Number.html">Number</a></h3>
+		<div>Camera frustum near plane.</div>
+
+		<h3>far <a href="../core/Number.html">Number</a></h3>
+		<div>Camera frustum far plane.</div>
+
+
+		<h2>Methods</h2>
+
+		<h3>updateProjectionMatrix()</h3>
+		<div>Updates camera's projection matrix. Must be called after change of parameters.</div>
+
+		<h3>setLens( focalLength <a href="../core/Number.html">Number</a>, frameSize <a href="../core/Number.html">Number</a> )</h3>
+		<div>
+			Uses focal length (in mm) to estimate and set FOV 35mm (fullframe) camera is used if frame size is not specified.<br />
+			Formula based on <a href="http://www.bobatkins.com/photography/technical/field_of_view.html" target="_blank">http://www.bobatkins.com/photography/technical/field_of_view.html</a>
+		</div>
+		
+
+		<h2>Source</h2>
+
+		<div><a href="https://github.com/mrdoob/three.js/blob/master/src/cameras/PerspectiveCamera.js" target="_blank">src/cameras/PerspectiveCamera.js</a></div>
+	</body>
+</html>

+ 1 - 1
docs/index.html

@@ -9,6 +9,7 @@
 				padding: 0;
 				color: #555;
 				font-family: Arial, sans-serif;
+				overflow: hidden;
 			}
 
 			h1 {
@@ -79,7 +80,6 @@
 			<h1>Cameras</h1>
 
 			<ul>
-				<li><a href="api/cameras/Camera.html" target="page">Camera</a></li>
 				<li><a href="api/cameras/PerspectiveCamera.html" target="page">PerspectiveCamera</a></li>
 				<li><a href="api/cameras/OrtographicCamera.html" target="page">OrtographicCamera</a></li>
 			</ul>

+ 1 - 2
docs/styles.css

@@ -1,6 +1,5 @@
 body {
-	margin: 0;
-	padding: 20;
+	margin: 20;
 	color: #555;
 	font-family: Arial, sans-serif;
 	font-size: 15px;