PixelPerfectCamera

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:62

An orthographic camera that maps world units to an integer number of physical framebuffer pixels.

One world unit is one source pixel. In automatic mode the camera chooses the largest fitting integer scale, then centers an integer-sized viewport inside the framebuffer. Leftover physical pixels become letterbox or pillarbox bars instead of fractional world space. The automatic scale never drops below 1; a surface smaller than the requested design extent therefore crops rather than downsampling.

Call setDrawingBufferSize with physical framebuffer dimensions. Flatland does this automatically for its viewport and render target.

Example

const camera = new PixelPerfectCamera({ viewSize: 240 })
camera.setDrawingBufferSize(1280, 720)
// resolvedPixelScale === 3; viewport is 1278 × 720 physical pixels
// and visible world is 426 × 240 units

Extends

• OrthographicCamera 

Constructors

Constructor

new PixelPerfectCamera(options?): PixelPerfectCamera

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:88

Parameters

options?

PixelPerfectCameraOptions = {}

Returns

PixelPerfectCamera

Overrides

OrthographicCamera.constructor

Properties

animations

animations: AnimationClip []

Defined in: three.js/core/Object3D:animations 

Array with object’s animation clips.

Default Value

[]

Inherited from

OrthographicCamera.animations

---

bottom

bottom: number

Defined in: three.js/cameras/OrthographicCamera:bottom 

The bottom plane of the camera’s frustum.

Default

-1

Inherited from

OrthographicCamera.bottom

---

castShadow

castShadow: boolean

Defined in: three.js/core/Object3D:castShadow 

Whether the object gets rendered into shadow map.

Default Value

false

Inherited from

OrthographicCamera.castShadow

---

children

children: Object3D <Object3DEventMap >[]

Defined in: three.js/core/Object3D:children 

Array with object’s children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

Inherited from

OrthographicCamera.children

---

coordinateSystem

coordinateSystem: CoordinateSystem 

Defined in: three.js/cameras/Camera:coordinateSystem 

The coordinate system in which the camera is used.

Inherited from

OrthographicCamera.coordinateSystem

---

count?

optional count?: number

Defined in: three.js/renderers/common/Backend:count 

Inherited from

OrthographicCamera.count

---

customDepthMaterial?

optional customDepthMaterial?: Material <MaterialEventMap >

Defined in: three.js/core/Object3D:customDepthMaterial 

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

Default Value

undefined

Inherited from

OrthographicCamera.customDepthMaterial

---

customDistanceMaterial?

optional customDistanceMaterial?: Material <MaterialEventMap >

Defined in: three.js/core/Object3D:customDistanceMaterial 

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

Inherited from

OrthographicCamera.customDistanceMaterial

---

far

far: number

Defined in: three.js/cameras/OrthographicCamera:far 

The camera’s far plane. Must be greater than the current value of OrthographicCamera#near.

Default

2000

Inherited from

OrthographicCamera.far

---

frustumCulled

frustumCulled: boolean

Defined in: three.js/core/Object3D:frustumCulled 

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default Value

true

Inherited from

OrthographicCamera.frustumCulled

---

id

readonly id: number

Defined in: three.js/core/Object3D:id 

Unique number for this Object3D  instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object. Expects a Integer

Inherited from

OrthographicCamera.id

---

isCamera

readonly isCamera: boolean

Defined in: three.js/cameras/Camera:isCamera 

This flag can be used for type testing.

Default

true

Inherited from

OrthographicCamera.isCamera

---

isObject3D

readonly isObject3D: true

Defined in: three.js/core/Object3D:isObject3D 

Flag to check if a given object is of type Object3D .

Remarks

This is a constant value

Default Value

true

Inherited from

OrthographicCamera.isObject3D

---

isOrthographicCamera

readonly isOrthographicCamera: boolean

Defined in: three.js/cameras/OrthographicCamera:isOrthographicCamera 

This flag can be used for type testing.

Default

true

Inherited from

OrthographicCamera.isOrthographicCamera

---

isPixelPerfectCamera

readonly isPixelPerfectCamera: true = true

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:66

Canonical Three.js-style runtime type guard.

---

layers

layers: Layers 

Defined in: three.js/core/Object3D:layers 

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

Default Value

new THREE.Layers()

Inherited from

OrthographicCamera.layers

---

left

left: number

Defined in: three.js/cameras/OrthographicCamera:left 

The left plane of the camera’s frustum.

Default

-1

Inherited from

OrthographicCamera.left

---

manual

readonly manual: true = true

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:69

Prevent React Three Fiber from replacing the authored projection.

---

matrix

matrix: Matrix4 

Defined in: three.js/core/Object3D:matrix 

The local transform matrix.

Default Value

new THREE.Matrix4()

Inherited from

OrthographicCamera.matrix

---

matrixAutoUpdate

matrixAutoUpdate: boolean

Defined in: three.js/core/Object3D:matrixAutoUpdate 

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

Inherited from

OrthographicCamera.matrixAutoUpdate

---

matrixWorld

matrixWorld: Matrix4 

Defined in: three.js/core/Object3D:matrixWorld 

The global transform of the object.

Remarks

If the Object3D  has no parent, then it’s identical to the local transform THREE.Object3D.matrix | .matrix.

Default Value

new THREE.Matrix4()

Inherited from

OrthographicCamera.matrixWorld

---

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

Defined in: three.js/core/Object3D:matrixWorldAutoUpdate 

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn’t, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

Inherited from

OrthographicCamera.matrixWorldAutoUpdate

---

matrixWorldInverse

matrixWorldInverse: Matrix4 

Defined in: three.js/cameras/Camera:matrixWorldInverse 

The inverse of the camera’s world matrix.

Inherited from

OrthographicCamera.matrixWorldInverse

---

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

Defined in: three.js/core/Object3D:matrixWorldNeedsUpdate 

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default Value

false

Inherited from

OrthographicCamera.matrixWorldNeedsUpdate

---

modelViewMatrix

readonly modelViewMatrix: Matrix4 

Defined in: three.js/core/Object3D:modelViewMatrix 

Default Value

new THREE.Matrix4()

Inherited from

OrthographicCamera.modelViewMatrix

---

name

name: string

Defined in: three.js/core/Object3D:name 

Optional name of the object

Remarks

(doesn’t need to be unique).

Default Value

""

Inherited from

OrthographicCamera.name

---

near

near: number

Defined in: three.js/cameras/OrthographicCamera:near 

The camera’s near plane. The valid range is greater than 0 and less than the current value of OrthographicCamera#far.

Note that, unlike for the PerspectiveCamera, 0 is a valid value for an orthographic camera’s near plane.

Default

0.1

Inherited from

OrthographicCamera.near

---

normalMatrix

readonly normalMatrix: Matrix3 

Defined in: three.js/core/Object3D:normalMatrix 

Default Value

new THREE.Matrix3()

Inherited from

OrthographicCamera.normalMatrix

---

occlusionTest?

optional occlusionTest?: boolean

Defined in: three.js/renderers/common/Backend:occlusionTest 

Inherited from

OrthographicCamera.occlusionTest

---

parent

parent: Object3D <Object3DEventMap > | null

Defined in: three.js/core/Object3D:parent 

Object’s parent in the scene graph .

Remarks

An object can have at most one parent.

Default Value

null

Inherited from

OrthographicCamera.parent

---

pivot

pivot: Vector3  | null

Defined in: three.js/core/Object3D:pivot 

The pivot point for rotation and scale transformations. When set, rotation and scale are applied around this point instead of the object’s origin.

Default

null

Inherited from

OrthographicCamera.pivot

---

position

readonly position: Vector3 

Defined in: three.js/core/Object3D:position 

Object’s local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

Inherited from

OrthographicCamera.position

---

projectionMatrix

projectionMatrix: Matrix4 

Defined in: three.js/cameras/Camera:projectionMatrix 

The camera’s projection matrix.

Inherited from

OrthographicCamera.projectionMatrix

---

projectionMatrixInverse

projectionMatrixInverse: Matrix4 

Defined in: three.js/cameras/Camera:projectionMatrixInverse 

The inverse of the camera’s projection matrix.

Inherited from

OrthographicCamera.projectionMatrixInverse

---

quaternion

readonly quaternion: Quaternion 

Defined in: three.js/core/Object3D:quaternion 

Object’s local rotation as a THREE.Quaternion | Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

Inherited from

OrthographicCamera.quaternion

---

receiveShadow

receiveShadow: boolean

Defined in: three.js/core/Object3D:receiveShadow 

Whether the material receives shadows.

Default Value

false

Inherited from

OrthographicCamera.receiveShadow

---

renderOrder

renderOrder: number

Defined in: three.js/core/Object3D:renderOrder 

This value allows the default rendering order of scene graph  objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group , all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.

Default Value

0

Inherited from

OrthographicCamera.renderOrder

---

right

right: number

Defined in: three.js/cameras/OrthographicCamera:right 

The right plane of the camera’s frustum.

Default

1

Inherited from

OrthographicCamera.right

---

rotation

readonly rotation: Euler 

Defined in: three.js/core/Object3D:rotation 

Object’s local rotation (Euler angles ), in radians.

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

Inherited from

OrthographicCamera.rotation

---

scale

readonly scale: Vector3 

Defined in: three.js/core/Object3D:scale 

The object’s local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

Inherited from

OrthographicCamera.scale

---

static

static: boolean

Defined in: three.js/core/Object3D:static 

Whether the 3D object is supposed to be static or not. If set to true, it means the 3D object is not going to be changed after the initial renderer. This includes geometry and material settings. A static 3D object can be processed by the renderer slightly faster since certain state checks can be bypassed.

Only relevant in context of WebGPURenderer.

Default

false

Inherited from

OrthographicCamera.static

---

top

top: number

Defined in: three.js/cameras/OrthographicCamera:top 

The top plane of the camera’s frustum.

Default

1

Inherited from

OrthographicCamera.top

---

type

type: string = 'PixelPerfectCamera'

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:63

A Read-only string to check this object type.

Remarks

This can be used to find a specific type of Object3D in a scene. Sub-classes will update this value.

Default Value

Object3D

Overrides

OrthographicCamera.type

---

up

up: Vector3 

Defined in: three.js/core/Object3D:up 

This is used by the lookAt  method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

Inherited from

OrthographicCamera.up

---

userData

userData: Record<string, any>

Defined in: three.js/core/Object3D:userData 

An object that can be used to store custom data about the Object3D .

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

Inherited from

OrthographicCamera.userData

---

uuid

uuid: string

Defined in: three.js/core/Object3D:uuid 

UUID  of this object instance.

Remarks

This gets automatically assigned and shouldn’t be edited.

Inherited from

OrthographicCamera.uuid

---

view

view: { enabled: boolean; fullHeight: number; fullWidth: number; height: number; offsetX: number; offsetY: number; width: number; } | null

Defined in: three.js/cameras/OrthographicCamera:view 

Represents the frustum window specification. This property should not be edited directly but via PerspectiveCamera#setViewOffset and PerspectiveCamera#clearViewOffset.

Default

null

Inherited from

OrthographicCamera.view

---

viewport

readonly viewport: Vector4 

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:77

Centered physical-pixel viewport (x, y, width, height) for this projection. Canvas renderers accept logical pixels, so divide by their DPR before calling renderer.setViewport(). Render-target viewports already use physical texels and can copy this value directly.

Overrides

OrthographicCamera.viewport

---

visible

visible: boolean

Defined in: three.js/core/Object3D:visible 

Object gets rendered if true.

Default Value

true

Inherited from

OrthographicCamera.visible

---

zoom

zoom: number

Defined in: three.js/cameras/OrthographicCamera:zoom 

The zoom factor of the camera.

Default

1

Inherited from

OrthographicCamera.zoom

---

DEFAULT_MATRIX_AUTO_UPDATE

static DEFAULT_MATRIX_AUTO_UPDATE: boolean

Defined in: three.js/core/Object3D:DEFAULT_MATRIX_AUTO_UPDATE 

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

Inherited from

OrthographicCamera.DEFAULT_MATRIX_AUTO_UPDATE

---

DEFAULT_MATRIX_WORLD_AUTO_UPDATE

static DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

Defined in: three.js/core/Object3D:DEFAULT_MATRIX_WORLD_AUTO_UPDATE 

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

Inherited from

OrthographicCamera.DEFAULT_MATRIX_WORLD_AUTO_UPDATE

---

DEFAULT_UP

static DEFAULT_UP: Vector3 

Defined in: three.js/core/Object3D:DEFAULT_UP 

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight, THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Inherited from

OrthographicCamera.DEFAULT_UP

Accessors

drawingBufferHeight

Get Signature

get drawingBufferHeight(): number

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:155

Last valid physical framebuffer height supplied to the camera.

Returns

number

---

drawingBufferWidth

Get Signature

get drawingBufferWidth(): number

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:150

Last valid physical framebuffer width supplied to the camera.

Returns

number

---

pixelScale

Get Signature

get pixelScale(): PixelScale

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:129

Requested pixel scale, or 'auto' for integer scale-to-fit.

Returns

PixelScale

Set Signature

set pixelScale(value): void

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:133

Parameters

value

PixelScale

Returns

void

---

resolvedPixelScale

Get Signature

get resolvedPixelScale(): number

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:140

Physical framebuffer pixels occupied by one world unit.

Returns

number

---

reversedDepth

Get Signature

get reversedDepth(): boolean

Defined in: three.js/cameras/Camera:reversedDepth 

The flag that indicates whether the camera uses a reversed depth buffer.

Default

false

Returns

boolean

Inherited from

OrthographicCamera.reversedDepth

---

viewSize

Get Signature

get viewSize(): number

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:106

Minimum vertical world span used by automatic scale selection.

Returns

number

Set Signature

set viewSize(value): void

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:110

Parameters

value

number

Returns

void

---

viewWidth

Get Signature

get viewWidth(): number | undefined

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:117

Optional exact horizontal design extent used by automatic fitting.

Returns

number | undefined

Set Signature

set viewWidth(value): void

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:121

Parameters

value

number | undefined

Returns

void

---

worldUnitsPerPixel

Get Signature

get worldUnitsPerPixel(): number

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:145

One physical framebuffer pixel expressed in world units.

Returns

number

Methods

add()

add(…object): this

Defined in: three.js/core/Object3D:add 

Adds another Object3D  as child of this Object3D .

Parameters

object

…Object3D <Object3DEventMap >[]

Returns

this

Remarks

An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D  can have at most one parent.

See

• attach 
• THREE.Group | Group for info on manually grouping objects.

Inherited from

OrthographicCamera.add

---

addEventListener()

addEventListener<T>(type, listener): void

Defined in: three.js/core/EventDispatcher:addEventListener 

Adds a listener to an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of event to listen to.

listener

EventListener <Object3DEventMap [T], T, PixelPerfectCamera>

The function that gets called when the event is fired.

Returns

void

Inherited from

OrthographicCamera.addEventListener

---

applyMatrix4()

applyMatrix4(matrix): void

Defined in: three.js/core/Object3D:applyMatrix4 

Applies the matrix transform to the object and updates the object’s position, rotation and scale.

Parameters

matrix

Matrix4 

Returns

void

Inherited from

OrthographicCamera.applyMatrix4

---

applyQuaternion()

applyQuaternion(quaternion): this

Defined in: three.js/core/Object3D:applyQuaternion 

Applies the rotation represented by the quaternion to the object.

Parameters

quaternion

Quaternion 

Returns

this

Inherited from

OrthographicCamera.applyQuaternion

---

attach()

attach(object): this

Defined in: three.js/core/Object3D:attach 

Adds a Object3D  as a child of this, while maintaining the object’s world transform.

Parameters

object

Object3D 

Returns

this

Remarks

Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See

add 

Inherited from

OrthographicCamera.attach

---

clear()

clear(): this

Defined in: three.js/core/Object3D:clear 

Removes all child objects.

Returns

this

Inherited from

OrthographicCamera.clear

---

clearViewOffset()

clearViewOffset(): void

Defined in: three.js/cameras/OrthographicCamera:clearViewOffset 

Removes the view offset from the projection matrix.

Returns

void

Inherited from

OrthographicCamera.clearViewOffset

---

clone()

clone(): this

Defined in: three.js/cameras/Camera:clone 

Returns a clone of this object and optionally all descendants.

Returns

this

Inherited from

OrthographicCamera.clone

---

copy()

copy(source, recursive?): this

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:237

Parameters

source

this

recursive?

boolean

Returns

this

Overrides

OrthographicCamera.copy

---

dispatchEvent()

dispatchEvent<T>(event): void

Defined in: three.js/core/EventDispatcher:dispatchEvent 

Fire an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

event

BaseEvent <T> & Object3DEventMap [T]

The event that gets fired.

Returns

void

Inherited from

OrthographicCamera.dispatchEvent

---

getLogicalViewport()

getLogicalViewport(pixelRatio?, target?): Vector4 

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:163

Copy the physical viewport into the logical coordinate space expected by a canvas renderer’s setViewport(). Pass 1 for render-target texels.

Parameters

pixelRatio?

number = 1

target?

Vector4  = ...

Returns

Vector4 

---

getNormalizedDeviceCoordinates()

getNormalizedDeviceCoordinates(x, y, pixelRatio?, target?): Vector2 

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:183

Convert a top-left-origin canvas point in logical pixels to this camera’s normalized device coordinates. Values outside [-1, 1] are in the letterbox or pillarbox region and should not participate in picking.

Parameters

x

number

y

number

pixelRatio?

number = 1

target?

Vector2  = ...

Returns

Vector2 

---

getObjectById()

getObjectById(id): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectById 

Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

Parameters

id

number

Unique number of the object instance. Expects a Integer

Returns

Object3D <Object3DEventMap > | undefined

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, …, incrementing by one for each new object.

See

id

Inherited from

OrthographicCamera.getObjectById

---

getObjectByName()

getObjectByName(name): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectByName 

Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

Parameters

name

string

String to match to the children’s Object3D.name property.

Returns

Object3D <Object3DEventMap > | undefined

Remarks

Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.

Inherited from

OrthographicCamera.getObjectByName

---

getObjectByProperty()

getObjectByProperty(name, value): Object3D <Object3DEventMap > | undefined

Defined in: three.js/core/Object3D:getObjectByProperty 

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

the property name to search for.

value

any

value of the given property.

Returns

Object3D <Object3DEventMap > | undefined

Inherited from

OrthographicCamera.getObjectByProperty

---

getObjectsByProperty()

getObjectsByProperty(name, value, optionalTarget?): Object3D <Object3DEventMap >[]

Defined in: three.js/core/Object3D:getObjectsByProperty 

Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

Parameters

name

string

The property name to search for.

value

any

Value of the given property.

optionalTarget?

Object3D <Object3DEventMap >[]

target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).

Returns

Object3D <Object3DEventMap >[]

Inherited from

OrthographicCamera.getObjectsByProperty

---

getWorldDirection()

getWorldDirection(target): Vector3 

Defined in: three.js/core/Object3D:getWorldDirection 

Returns a vector representing the direction of object’s positive z-axis in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

OrthographicCamera.getWorldDirection

---

getWorldPosition()

getWorldPosition(target): Vector3 

Defined in: three.js/core/Object3D:getWorldPosition 

Returns a vector representing the position of the object in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

OrthographicCamera.getWorldPosition

---

getWorldQuaternion()

getWorldQuaternion(target): Quaternion 

Defined in: three.js/core/Object3D:getWorldQuaternion 

Returns a quaternion representing the rotation of the object in world space.

Parameters

target

Quaternion 

The result will be copied into this Quaternion.

Returns

Quaternion 

Inherited from

OrthographicCamera.getWorldQuaternion

---

getWorldScale()

getWorldScale(target): Vector3 

Defined in: three.js/core/Object3D:getWorldScale 

Returns a vector of the scaling factors applied to the object for each axis in world space.

Parameters

target

Vector3 

The result will be copied into this Vector3.

Returns

Vector3 

Inherited from

OrthographicCamera.getWorldScale

---

hasEventListener()

hasEventListener<T>(type, listener): boolean

Defined in: three.js/core/EventDispatcher:hasEventListener 

Checks if listener is added to an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of event to listen to.

listener

EventListener <Object3DEventMap [T], T, PixelPerfectCamera>

The function that gets called when the event is fired.

Returns

boolean

Inherited from

OrthographicCamera.hasEventListener

---

localToWorld()

localToWorld(vector): Vector3 

Defined in: three.js/core/Object3D:localToWorld 

Converts the vector from this object’s local space to world space.

Parameters

vector

Vector3 

A vector representing a position in this object’s local space.

Returns

Vector3 

Inherited from

OrthographicCamera.localToWorld

---

lookAt()

Call Signature

lookAt(vector): void

Defined in: three.js/core/Object3D:lookAt 

Rotates the object to face a point in world space.

Parameters

vector

Vector3 

A vector representing a position in world space to look at.

Returns

void

Remarks

This method does not support objects having non-uniformly-scaled parent(s).

Inherited from

OrthographicCamera.lookAt

Call Signature

lookAt(x, y, z): void

Defined in: three.js/core/Object3D:lookAt 

Rotates the object to face a point in world space.

Parameters

x

number

Expects a Float

y

number

Expects a Float

z

number

Expects a Float

Returns

void

Remarks

This method does not support objects having non-uniformly-scaled parent(s).

Inherited from

OrthographicCamera.lookAt

---

onAfterRender()

onAfterRender(renderer, scene, camera, geometry, material, group): void

Defined in: three.js/core/Object3D:onAfterRender 

An optional callback that is executed immediately after a 3D object is rendered.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

geometry

BufferGeometry 

material

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

OrthographicCamera.onAfterRender

---

onAfterShadow()

onAfterShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void

Defined in: three.js/core/Object3D:onAfterShadow 

An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

shadowCamera

Camera 

geometry

BufferGeometry 

depthMaterial

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

OrthographicCamera.onAfterShadow

---

onBeforeRender()

onBeforeRender(renderer, scene, camera, geometry, material, group): void

Defined in: three.js/core/Object3D:onBeforeRender 

An optional callback that is executed immediately before a 3D object is rendered.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

geometry

BufferGeometry 

material

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

OrthographicCamera.onBeforeRender

---

onBeforeShadow()

onBeforeShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void

Defined in: three.js/core/Object3D:onBeforeShadow 

An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

Parameters

renderer

WebGLRenderer 

scene

Scene 

camera

Camera 

shadowCamera

Camera 

geometry

BufferGeometry 

depthMaterial

Material 

group

Group 

Returns

void

Remarks

This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D , Group  or Bone are not renderable and thus this callback is not executed for such objects.

Inherited from

OrthographicCamera.onBeforeShadow

---

raycast()

raycast(raycaster, intersects): void

Defined in: three.js/core/Object3D:raycast 

Abstract (empty) method to get intersections between a casted ray and this object

Parameters

raycaster

Raycaster 

intersects

Intersection <Object3D <Object3DEventMap >>[]

Returns

void

Remarks

Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

See

THREE.Raycaster | Raycaster

Default Value

() => {}

Inherited from

OrthographicCamera.raycast

---

remove()

remove(…object): this

Defined in: three.js/core/Object3D:remove 

Removes a Object3D  as child of this Object3D .

Parameters

object

…Object3D <Object3DEventMap >[]

Returns

this

Remarks

An arbitrary number of objects may be removed.

See

THREE.Group | Group for info on manually grouping objects.

Inherited from

OrthographicCamera.remove

---

removeEventListener()

removeEventListener<T>(type, listener): void

Defined in: three.js/core/EventDispatcher:removeEventListener 

Removes a listener from an event type.

Type Parameters

T

T extends keyof Object3DEventMap 

Parameters

type

T

The type of the listener that gets removed.

listener

EventListener <Object3DEventMap [T], T, PixelPerfectCamera>

The listener function that gets removed.

Returns

void

Inherited from

OrthographicCamera.removeEventListener

---

removeFromParent()

removeFromParent(): this

Defined in: three.js/core/Object3D:removeFromParent 

Removes this object from its current parent.

Returns

this

Inherited from

OrthographicCamera.removeFromParent

---

rotateOnAxis()

rotateOnAxis(axis, angle): this

Defined in: three.js/core/Object3D:rotateOnAxis 

Rotate an object along an axis in object space.

Parameters

axis

Vector3 

A normalized vector in object space.

angle

number

The angle in radians. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized.

Inherited from

OrthographicCamera.rotateOnAxis

---

rotateOnWorldAxis()

rotateOnWorldAxis(axis, angle): this

Defined in: three.js/core/Object3D:rotateOnWorldAxis 

Rotate an object along an axis in world space.

Parameters

axis

Vector3 

A normalized vector in world space.

angle

number

The angle in radians. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized Method Assumes no rotated parent.

Inherited from

OrthographicCamera.rotateOnWorldAxis

---

rotateX()

rotateX(angle): this

Defined in: three.js/core/Object3D:rotateX 

Rotates the object around x axis in local space.

Parameters

angle

number

Returns

this

Inherited from

OrthographicCamera.rotateX

---

rotateY()

rotateY(angle): this

Defined in: three.js/core/Object3D:rotateY 

Rotates the object around y axis in local space.

Parameters

angle

number

Returns

this

Inherited from

OrthographicCamera.rotateY

---

rotateZ()

rotateZ(angle): this

Defined in: three.js/core/Object3D:rotateZ 

Rotates the object around z axis in local space.

Parameters

angle

number

Returns

this

Inherited from

OrthographicCamera.rotateZ

---

setDrawingBufferSize()

setDrawingBufferSize(width, height): this

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:215

Fit the camera to physical framebuffer dimensions.

Invalid or temporarily unmeasured sizes are ignored, leaving the last valid projection intact.

Parameters

width

number

height

number

Returns

this

---

setRotationFromAxisAngle()

setRotationFromAxisAngle(axis, angle): void

Defined in: three.js/core/Object3D:setRotationFromAxisAngle 

Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.

Parameters

axis

Vector3 

A normalized vector in object space.

angle

number

Angle in radians. Expects a Float

Returns

void

Inherited from

OrthographicCamera.setRotationFromAxisAngle

---

setRotationFromEuler()

setRotationFromEuler(euler): void

Defined in: three.js/core/Object3D:setRotationFromEuler 

Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.

Parameters

euler

Euler 

Euler angle specifying rotation amount.

Returns

void

Inherited from

OrthographicCamera.setRotationFromEuler

---

setRotationFromMatrix()

setRotationFromMatrix(m): void

Defined in: three.js/core/Object3D:setRotationFromMatrix 

Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

Parameters

m

Matrix4 

Rotate the quaternion by the rotation component of the matrix.

Returns

void

Remarks

Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

Inherited from

OrthographicCamera.setRotationFromMatrix

---

setRotationFromQuaternion()

setRotationFromQuaternion(q): void

Defined in: three.js/core/Object3D:setRotationFromQuaternion 

Copy the given THREE.Quaternion | Quaternion into .quaternion.

Parameters

q

Quaternion 

Normalized Quaternion.

Returns

void

Inherited from

OrthographicCamera.setRotationFromQuaternion

---

setViewOffset()

setViewOffset(fullWidth, fullHeight, x, y, width, height): void

Defined in: three.js/cameras/OrthographicCamera:setViewOffset 

Sets an offset in a larger frustum. This is useful for multi-window or multi-monitor/multi-machine setups.

Parameters

fullWidth

number

The full width of multiview setup.

fullHeight

number

The full height of multiview setup.

x

number

The horizontal offset of the subcamera.

y

number

The vertical offset of the subcamera.

width

number

The width of subcamera.

height

number

The height of subcamera.

Returns

void

See

PerspectiveCamera#setViewOffset

Inherited from

OrthographicCamera.setViewOffset

---

setViewportSize()

setViewportSize(width, height, pixelRatio?): this

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:232

Convenience form for CSS viewport dimensions plus device pixel ratio. Render targets should use setDrawingBufferSize directly.

Parameters

width

number

height

number

pixelRatio?

number = 1

Returns

this

---

snapPositionToPixelGrid()

snapPositionToPixelGrid(): this

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:202

Round this camera’s local X/Y position to one physical-pixel steps.

Call this after a custom pan controller updates the camera. The operation is explicit because camera position is application state; the render path never mutates it behind the caller’s back.

Returns

this

---

toJSON()

toJSON(meta?): OrthographicCameraJSON 

Defined in: three.js/cameras/OrthographicCamera:toJSON 

Convert the object to three.js JSON Object/Scene format .

Parameters

meta?

JSONMeta 

Object containing metadata such as materials, textures or images for the object.

Returns

OrthographicCameraJSON 

Inherited from

OrthographicCamera.toJSON

---

translateOnAxis()

translateOnAxis(axis, distance): this

Defined in: three.js/core/Object3D:translateOnAxis 

Translate an object by distance along an axis in object space

Parameters

axis

Vector3 

A normalized vector in object space.

distance

number

The distance to translate. Expects a Float

Returns

this

Remarks

The axis is assumed to be normalized.

Inherited from

OrthographicCamera.translateOnAxis

---

translateX()

translateX(distance): this

Defined in: three.js/core/Object3D:translateX 

Translates object along x axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

OrthographicCamera.translateX

---

translateY()

translateY(distance): this

Defined in: three.js/core/Object3D:translateY 

Translates object along y axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

OrthographicCamera.translateY

---

translateZ()

translateZ(distance): this

Defined in: three.js/core/Object3D:translateZ 

Translates object along z axis in object space by distance units.

Parameters

distance

number

Expects a Float

Returns

this

Inherited from

OrthographicCamera.translateZ

---

traverse()

traverse(callback): void

Defined in: three.js/core/Object3D:traverse 

Executes the callback on this object and all descendants.

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

OrthographicCamera.traverse

---

traverseAncestors()

traverseAncestors(callback): void

Defined in: three.js/core/Object3D:traverseAncestors 

Executes the callback on all ancestors.

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

OrthographicCamera.traverseAncestors

---

traverseVisible()

traverseVisible(callback): void

Defined in: three.js/core/Object3D:traverseVisible 

Like traverse, but the callback will only be executed for visible objects

Parameters

callback

(object) => any

A function with as first argument an Object3D  object.

Returns

void

Remarks

Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.

Inherited from

OrthographicCamera.traverseVisible

---

updateMatrix()

updateMatrix(): void

Defined in: three.js/core/Object3D:updateMatrix 

Updates local transform.

Returns

void

Inherited from

OrthographicCamera.updateMatrix

---

updateMatrixWorld()

updateMatrixWorld(force?): void

Defined in: three.js/core/Object3D:updateMatrixWorld 

Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

Parameters

force?

boolean

A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

Returns

void

Inherited from

OrthographicCamera.updateMatrixWorld

---

updateProjectionMatrix()

updateProjectionMatrix(): void

Defined in: packages/three-flatland/src/cameras/PixelPerfectCamera.ts:255

Rebuild the projection after canonical Three.js controls mutate zoom. Zoom is folded into the nearest positive integer pixel scale so it can never introduce fractional source-pixel coverage.

Returns

void

Overrides

OrthographicCamera.updateProjectionMatrix

---

updateWorldMatrix()

updateWorldMatrix(updateParents?, updateChildren?, force?): void

Defined in: three.js/core/Object3D:updateWorldMatrix 

An alternative version of Object3D#updateMatrixWorld  with more control over the update of ancestor and descendant nodes.

Parameters

updateParents?

boolean

Whether ancestor nodes should be updated or not.

updateChildren?

boolean

Whether descendant nodes should be updated or not.

force?

boolean

When set to true, a recomputation of world matrices is forced even when Object3D#matrixWorldNeedsUpdate is false.

Returns

void

Inherited from

OrthographicCamera.updateWorldMatrix

---

worldToLocal()

worldToLocal(vector): Vector3 

Defined in: three.js/core/Object3D:worldToLocal 

Converts the vector from world space to this object’s local space.

Parameters

vector

Vector3 

A vector representing a position in world space.

Returns

Vector3 

Inherited from

OrthographicCamera.worldToLocal