Object3DCamera

OrthographicCamera

Camera that uses orthographic projection.

In this projection mode, an object's size in the rendered image stays constant regardless of its distance from the camera.

This can be useful for rendering 2D scenes and UI elements, amongst other things.

Example

camera

interactive / cubes / ortho

materials / cubemap / dynamic

postprocessing / advanced

postprocessing / dof2

postprocessing / godrays

rtt

shaders / tonemapping

shadowmap

terrain / dynamic

var camera = new v3d.OrthographicCamera(width / - 2, width / 2, height / 2, height / - 2, 1, 1000); scene.add(camera);

Constructor

OrthographicCamera(left : Number, right : Number, top : Number, bottom : Number, near : Number, far : Number)

left — Camera frustum left plane.
right — Camera frustum right plane.
top — Camera frustum top plane.
bottom — Camera frustum bottom plane.
near — Camera frustum near plane.
far — Camera frustum far plane.

Together these define the camera's viewing frustum.

Properties

See the base Camera class for common properties.
Note that after making changes to most of these properties you will have to call .updateProjectionMatrix for the changes to take effect.

.bottom : Float

Camera frustum bottom plane.

.far : Float

Camera frustum far plane. Default is 2000.

The valid range is between the current value of the near plane and infinity.

.isOrthographicCamera : Boolean

Used to test whether this or derived classes are OrthographicCameras. Default is true.

This should not be changed as it is used internally by the renderer for optimisation.

.left : Float

Camera frustum left plane.

.near : Float

Camera frustum near plane. Default is 0.1.

The valid range is between 0 and the current value of the far plane. Note that, unlike for the PerspectiveCamera, 0 is a valid value for an OrthographicCamera's near plane.

.right : Float

Camera frustum right plane.

.top : Float

Camera frustum top plane.

.view : Object

Set by setViewOffset. Default is null.

.zoom : number

Gets or sets the zoom factor of the camera. Default is 1.

Methods

See the base Camera class for common methods.

.setViewOffset (fullWidth : Float, fullHeight : Float, x : Float, y : Float, width : Float, height : Float) : null

fullWidth — full width of multiview setup
fullHeight — full height of multiview setup
x — horizontal offset of subcamera
y — vertical offset of subcamera
width — width of subcamera
height — height of subcamera

Sets an offset in a larger viewing frustum. This is useful for multi-window or multi-monitor/multi-machine setups. For an example on how to use it see PerspectiveCamera.

.clearViewOffset () : null

Removes any offset set by the .setViewOffset method.

.updateProjectionMatrix () : null

Updates the camera projection matrix. Must be called after any change of parameters.

.toJSON () : JSON

Return the camera's data in JSON format.

Source

For more info on how to obtain the source code of this module see this page.