|
|
@@ -9,24 +9,27 @@
|
|
|
<body>
|
|
|
<h1>[name]</h1>
|
|
|
|
|
|
- <div class="desc">todo</div>
|
|
|
+ <div class="desc">A general perpose camera, for setting FOV, Lens Focal Length,
|
|
|
+ and switching between perspective and orthographic views easily.
|
|
|
+ Use this only if you do not wish to manage
|
|
|
+ both a Orthographic and Perspective Camera</div>
|
|
|
|
|
|
|
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
|
|
|
- <h3>[name]([page:todo width], [page:todo height], [page:todo fov], [page:todo near], [page:todo far], [page:todo orthoNear], [page:todo orthoFar])</h3>
|
|
|
+ <h3>[name]([page:Number width], [page:Number height], [page:Number fov], [page:Number near], [page:Number far], [page:Number orthoNear], [page:Number orthoFar])</h3>
|
|
|
<div>
|
|
|
- width -- todo <br />
|
|
|
- height -- todo <br />
|
|
|
- fov -- todo <br />
|
|
|
- near -- todo <br />
|
|
|
- far -- todo <br />
|
|
|
- orthoNear -- todo <br />
|
|
|
- orthoFar -- todo
|
|
|
+ width -- Camera frustum width.<br />
|
|
|
+ height -- Camera frustum height.<br />
|
|
|
+ fov — Camera frustum vertical field of view in perspective view.<br />
|
|
|
+ near — Camera frustum near plane in perspective view.<br />
|
|
|
+ far — Camera frustum far plane in perspective view.<br />
|
|
|
+ orthoNear — Camera frustum near plane in orthographic view.<br />
|
|
|
+ orthoFar — Camera frustum far plane in orthographic view.
|
|
|
</div>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Creates a [name]. This initializes 2 cameras, an OrthographicCamera and a PerspectiveCamera. The default is the perspective Camera.
|
|
|
</div>
|
|
|
|
|
|
|
|
|
@@ -34,147 +37,145 @@
|
|
|
|
|
|
|
|
|
|
|
|
- <h3>.[page:todo fov]</h3>
|
|
|
+ <h3>.[page:Number fov]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the camera frustum vertical field of view in perspective view.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:number right]</h3>
|
|
|
+ <h3>.[page:number left]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the camera frustum left plane in orthographic view.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:number bottom]</h3>
|
|
|
+ <h3>.[page:Number right]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the camera frustum right plane in orthographic view.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:PerspectiveCamera cameraP]</h3>
|
|
|
+ <h3>.[page:number top]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the camera frustum top plane in orthographic view.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:number top]</h3>
|
|
|
+ <h3>.[page:Number bottom]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the camera frustum bottom plane in orthographic view.
|
|
|
</div>
|
|
|
|
|
|
<h3>.[page:number zoom]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the zoom factor of the camera.
|
|
|
</div>
|
|
|
|
|
|
<h3>.[page:number far]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets camera frustum far plane.
|
|
|
</div>
|
|
|
|
|
|
<h3>.[page:number near]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets camera frustum near plane.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:boolean inPerspectiveMode]</h3>
|
|
|
+ <h3>.[page:OrthographicCamera cameraO]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the internal OrthographicCamera used as camera.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:OrthographicCamera cameraO]</h3>
|
|
|
+ <h3>.[page:PerspectiveCamera cameraP]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets or sets the internal PerspectiveCamera used as camera.
|
|
|
</div>
|
|
|
|
|
|
<h3>.[page:boolean inOrthographicMode]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets whether the combinedCamera is in Orthographic Mode.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.[page:number left]</h3>
|
|
|
+ <h3>.[page:boolean inPerspectiveMode]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Gets whether the combinedCamera is in Perspective Mode.
|
|
|
</div>
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
|
|
|
-
|
|
|
-
|
|
|
- <h3>.toBottomView() [page:todo]</h3>
|
|
|
+ <h3>.setFov([page:Number fov])</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ fov -- Camera frustum vertical field of view in perspective view.
|
|
|
</div>
|
|
|
-
|
|
|
- <h3>.setFov([page:todo fov]) [page:todo]</h3>
|
|
|
<div>
|
|
|
- fov -- todo
|
|
|
+ sets the camera frustum vertical field of view in perspective view.
|
|
|
</div>
|
|
|
+
|
|
|
+ <h3>.setZoom([page:Number zoom]) [page:todo]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ zoom -- The zoom factor.
|
|
|
</div>
|
|
|
-
|
|
|
- <h3>.toBackView() [page:todo]</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the zoomfactor.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.setZoom([page:todo zoom]) [page:todo]</h3>
|
|
|
+ <h3>.setLens([page:number focalLength], [page:Number frameHeight]) [page:todo]</h3>
|
|
|
<div>
|
|
|
- zoom -- todo
|
|
|
+ focalLength -- The focal length of a lens is defined as the distance from the optical center of a lens (or, the secondary principal point for a complex lens like a camera lens) to the focal point (sensor) when the lens is focused on an object at infinity. <br />
|
|
|
+ frameHeight -- the size of the frame in mm. (default is *35*)
|
|
|
</div>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the fov based on lens data.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.setLens([page:todo focalLength], [page:todo frameHeight]) [page:todo]</h3>
|
|
|
+ <h3>.toFrontView()</h3>
|
|
|
<div>
|
|
|
- focalLength -- todo <br />
|
|
|
- frameHeight -- todo
|
|
|
+ Sets the camera to view the front of the target.
|
|
|
</div>
|
|
|
+
|
|
|
+ <h3>.toBackView() </h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the camera to view the back of the target.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.toFrontView() [page:todo]</h3>
|
|
|
+ <h3>.toLeftView() </h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the camera to view the left of the target.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.toLeftView() [page:todo]</h3>
|
|
|
+ <h3>.toRightView()</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the camera to view the right of the target.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.updateProjectionMatrix() [page:todo]</h3>
|
|
|
+ <h3>.toTopView()</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the camera to view the top.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.toTopView() [page:todo]</h3>
|
|
|
+ <h3>.toBottomView()</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Sets the camera to view the bottom.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.toOrthographic() [page:todo]</h3>
|
|
|
+ <h3>.setSize([page:Number width], [page:Number height]) </h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ width -- The width of the orthographic view.<br />
|
|
|
+ height -- The height of the orthographic view.
|
|
|
</div>
|
|
|
-
|
|
|
- <h3>.setSize([page:todo width], [page:todo height]) [page:todo]</h3>
|
|
|
<div>
|
|
|
- width -- todo <br />
|
|
|
- height -- todo
|
|
|
+ Sets the size of the orthographic view.
|
|
|
</div>
|
|
|
+
|
|
|
+ <h3>.toOrthographic()</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Change the camera to orthographic view.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.toPerspective() [page:todo]</h3>
|
|
|
+ <h3>.toPerspective()</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Change the camera to Perspective view.
|
|
|
</div>
|
|
|
|
|
|
- <h3>.toRightView() [page:todo]</h3>
|
|
|
+ <h3>.updateProjectionMatrix()</h3>
|
|
|
<div>
|
|
|
- todo
|
|
|
+ Updates the ProjectionMatrix.
|
|
|
</div>
|
|
|
|
|
|
<h2>Source</h2>
|
gero3