diff --git a/docs/api/extras/cameras/CombinedCamera.html b/docs/api/extras/cameras/CombinedCamera.html index c46470778d5a605b3a3e75325eef68aa90ef54a8..78803298f5a3924d22e63d5ac1f0fd9bf297d931 100644 --- a/docs/api/extras/cameras/CombinedCamera.html +++ b/docs/api/extras/cameras/CombinedCamera.html @@ -9,24 +9,27 @@

[name]

-
todo
+
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

Constructor

-

[name]([page:todo width], [page:todo height], [page:todo fov], [page:todo near], [page:todo far], [page:todo orthoNear], [page:todo orthoFar])

+

[name]([page:Number width], [page:Number height], [page:Number fov], [page:Number near], [page:Number far], [page:Number orthoNear], [page:Number orthoFar])

- width -- todo
- height -- todo
- fov -- todo
- near -- todo
- far -- todo
- orthoNear -- todo
- orthoFar -- todo + width -- Camera frustum width.
+ height -- Camera frustum height.
+ fov — Camera frustum vertical field of view in perspective view.
+ near — Camera frustum near plane in perspective view.
+ far — Camera frustum far plane in perspective view.
+ orthoNear — Camera frustum near plane in orthographic view.
+ orthoFar — Camera frustum far plane in orthographic view.
- todo + Creates a [name]. This initializes 2 cameras, an OrthographicCamera and a PerspectiveCamera. The default is the perspective Camera.
@@ -34,147 +37,145 @@ -

.[page:todo fov]

+

.[page:Number fov]

- todo + Gets or sets the camera frustum vertical field of view in perspective view.
-

.[page:number right]

+

.[page:number left]

- todo + Gets or sets the camera frustum left plane in orthographic view.
-

.[page:number bottom]

+

.[page:Number right]

- todo + Gets or sets the camera frustum right plane in orthographic view.
-

.[page:PerspectiveCamera cameraP]

+

.[page:number top]

- todo + Gets or sets the camera frustum top plane in orthographic view.
-

.[page:number top]

+

.[page:Number bottom]

- todo + Gets or sets the camera frustum bottom plane in orthographic view.

.[page:number zoom]

- todo + Gets or sets the zoom factor of the camera.

.[page:number far]

- todo + Gets camera frustum far plane.

.[page:number near]

- todo + Gets camera frustum near plane.
-

.[page:boolean inPerspectiveMode]

+

.[page:OrthographicCamera cameraO]

- todo + Gets or sets the internal OrthographicCamera used as camera.
-

.[page:OrthographicCamera cameraO]

+

.[page:PerspectiveCamera cameraP]

- todo + Gets or sets the internal PerspectiveCamera used as camera.

.[page:boolean inOrthographicMode]

- todo + Gets whether the combinedCamera is in Orthographic Mode.
-

.[page:number left]

+

.[page:boolean inPerspectiveMode]

- todo + Gets whether the combinedCamera is in Perspective Mode.

Methods

- - -

.toBottomView() [page:todo]

+

.setFov([page:Number fov])

- todo + fov -- Camera frustum vertical field of view in perspective view.
- -

.setFov([page:todo fov]) [page:todo]

- fov -- todo + sets the camera frustum vertical field of view in perspective view.
+ +

.setZoom([page:Number zoom]) [page:todo]

- todo + zoom -- The zoom factor.
- -

.toBackView() [page:todo]

- todo + Sets the zoomfactor.
-

.setZoom([page:todo zoom]) [page:todo]

+

.setLens([page:number focalLength], [page:Number frameHeight]) [page:todo]

- 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.
+ frameHeight -- the size of the frame in mm. (default is *35*)
- todo + Sets the fov based on lens data.
-

.setLens([page:todo focalLength], [page:todo frameHeight]) [page:todo]

+

.toFrontView()

- focalLength -- todo
- frameHeight -- todo + Sets the camera to view the front of the target.
+ +

.toBackView()

- todo + Sets the camera to view the back of the target.
-

.toFrontView() [page:todo]

+

.toLeftView()

- todo + Sets the camera to view the left of the target.
-

.toLeftView() [page:todo]

+

.toRightView()

- todo + Sets the camera to view the right of the target.
-

.updateProjectionMatrix() [page:todo]

+

.toTopView()

- todo + Sets the camera to view the top.
-

.toTopView() [page:todo]

+

.toBottomView()

- todo + Sets the camera to view the bottom.
-

.toOrthographic() [page:todo]

+

.setSize([page:Number width], [page:Number height])

- todo + width -- The width of the orthographic view.
+ height -- The height of the orthographic view.
- -

.setSize([page:todo width], [page:todo height]) [page:todo]

- width -- todo
- height -- todo + Sets the size of the orthographic view.
+ +

.toOrthographic()

- todo + Change the camera to orthographic view.
-

.toPerspective() [page:todo]

+

.toPerspective()

- todo + Change the camera to Perspective view.
-

.toRightView() [page:todo]

+

.updateProjectionMatrix()

- todo + Updates the ProjectionMatrix.

Source