Class: Camera

Methods

---

copy()

Creates a deep copy of the camera instance.

Source:

• Camera.js, line 58

Returns:

A new Camera instance with copied properties

Type

Camera

---

deltaZoom(dt, dz [, x] [, y])

Applies a relative zoom change at a specific point.

Parameters:

Name	Type	Argument	Default	Description
dt	number			Animation duration in milliseconds
dz	number			Relative zoom change factor
x	number	<optional>	0	X coordinate to zoom around
y	number	<optional>	0	Y coordinate to zoom around

Source:

• Camera.js, line 237

---

fit(box [, dt])

Adjusts the camera to frame a specified bounding box.

Parameters:

Name	Type	Argument	Default	Description
box	BoundingBox			The box to frame in canvas coordinates
dt	number	<optional>	0	Animation duration in milliseconds

Source:

• Camera.js, line 300

---

fitCameraBox(dt)

Resets the camera to show the entire scene.

Parameters:

Name	Type	Description
dt	number	Animation duration in milliseconds

Source:

• Camera.js, line 320

---

getCurrentTransform(time)

Gets the camera transform at a specific time.

Parameters:

Name	Type	Description
time	number	Current time in milliseconds (from performance.now())

Source:

• Camera.js, line 265

Returns:

The interpolated transform at the specified time with isComplete flag

Type

Transform

---

getGlCurrentTransform(time)

Gets the camera transform at a specific time in device coordinates.

Parameters:

Name	Type	Description
time	number	Current time in milliseconds (from performance.now())

Source:

• Camera.js, line 287

Returns:

The interpolated transform scaled for device pixels

Type

Transform

---

glViewport()

Returns the current viewport in device coordinates (accounting for device pixel ratio).

Source:

• Camera.js, line 83

Returns:

The current viewport scaled for device pixels

Type

Viewport

---

hasReachedTarget(currentTransform)

Checks if the camera animation has completed.

Parameters:

Name	Type	Description
currentTransform	Transform	The current transform (optional, will be calculated if not provided)

Source:

• Camera.js, line 275

Returns:

True if the camera has reached its target position

Type

boolean

---

pan(dt, dx, dy)

Pans the camera by a specified amount in canvas coordinates.

Parameters:

Name	Type	Description
dt	number	Animation duration in milliseconds
dx	number	Horizontal displacement
dy	number	Vertical displacement

Source:

• Camera.js, line 184

---

rotate(dt, a)

Rotates the camera around its z-axis.

Parameters:

Name	Type	Description
dt	number	Animation duration in milliseconds
a	number	Rotation angle in degrees

Source:

• Camera.js, line 222

---

setPosition(dt, x, y, z, a [, easing])

Sets the camera target parameters for a new position.

Parameters:

Name	Type	Argument	Description
dt	number		Animation duration in milliseconds
x	number		X component of translation
y	number		Y component of translation
z	number		Zoom factor
a	number		Rotation angle in degrees
easing	string	<optional>	Easing function name for animation

Source:

• Camera.js, line 134

Fires:

• Camera#event:update

---

setViewport(view)

Updates the viewport while maintaining the camera position as close as possible to the previous one.

Parameters:

Name	Type	Description
view	Viewport	The new viewport in CSS coordinates

Source:

• Camera.js, line 68

---

zoom(dt, z [, x] [, y])

Zooms the camera to a specific point in canvas coordinates.

Parameters:

Name	Type	Argument	Default	Description
dt	number			Animation duration in milliseconds
z	number			Target zoom level
x	number	<optional>	0	X coordinate to zoom towards
y	number	<optional>	0	Y coordinate to zoom towards

Source:

• Camera.js, line 199

Events

---

update

The event is fired when the camera target is changed.

Source:

• Camera.js, line 135

---

update

The event is fired when a uniform shader variable is changed.

Source:

• Shader.js, line 142