OrthographicCamera

A camera using an orthographic (parallel) projection.

Orthographic projection has no perspective foreshortening, so object size is independent of distance from the camera. This is the camera to use for 2D image viewing, where it pairs naturally with PanZoomControls. The initial frame is given in world coordinates; zoom and pan are applied as scale and translation on top of that frame.

Extends Camera and inherits all public properties and methods.

Constructor

Creates an orthographic camera framing the given world-space rectangle.

new OrthographicCamera(props): OrthographicCamera;

Parameter	Type	Description
props	OrthographicCameraProps	The view frame edges in world units, near/far clipping plane distances (default -1e6 and 1e6), and the slice orientation the camera faces (default "XY").

Accessors

viewportSize [number, number]

get viewportSize(): [number, number];

type CameraType overrides

get type(): CameraType;

orientation SliceOrientation

get orientation(): SliceOrientation;

Methods

setAspectRatio() void overrides

setAspectRatio(aspectRatio): void;

Parameter	Type
aspectRatio	number

setFrame() void

setFrame(__namedParameters): void;

Parameter	Type
__namedParameters	OrthographicCameraFrame

setOrientation() void

Changes the slice orientation the camera faces. The current frame and zoom carry over numerically to the new plane axes. Call setFrame to reframe the view for the new plane.

setOrientation(orientation): void;

Parameter	Type
orientation	SliceOrientation

zoom() void overrides

zoom(factor): void;

Parameter	Type
factor	number

getWorldViewRect() Box2

getWorldViewRect(): Box2;

updateProjectionMatrix() void overrides

protected updateProjectionMatrix(): void;