Class FollowingCamera

A camera that smoothly follows a point. Optionally it can be contained within specified bounds.

Hierarchy (view full)

Camera
- FollowingCamera

Constructors

constructor

new FollowingCamera(): FollowingCamera
Creates a new camera object.

Returns FollowingCamera
Inherited from Camera.constructor
- Defined in Camera.ts:32

Properties

acceleration

acceleration: number = 20

`Protected` bounds

bounds: null | CameraBounds = null

`Protected` desired

desired: Vector2 = ...

lockDistance

lockDistance: number = 1

maxSpeed

maxSpeed: number = 900

`Readonly` modelView

modelView: Matrix4 = ...

The model view matrix of this camera. Do not modify outside of camera code.

`Readonly` projection

projection: Matrix4 = ...

The projection matrix of this camera. Do not modify outside of camera code.

slowDistance

slowDistance: number = 100

snapToPixel

snapToPixel: boolean = true

If set to true, the position will be snapped to pixels.

`Protected` speed

speed: number = 0

`Protected` viewportHeight

viewportHeight: number = 0

`Protected` viewportWidth

viewportWidth: number = 0

`Protected` x

x: number = 0

`Protected` y

y: number = 0

`Protected` zoom

zoom: number = 1

Methods

getBounds

getBounds(): null | CameraBounds
Returns null | CameraBounds
The current camera bounds or null.
Inherited from Camera.getBounds
- Defined in Camera.ts:136

getDesired

getDesired(): Readonly<Vector2>
Returns Readonly<Vector2>
The position where the camera wants to be.
- Defined in FollowingCamera.ts:23

getSpeed

getSpeed(): number
Returns number
The current (calculated) camera speed.
- Defined in FollowingCamera.ts:28

getViewportHeight

getViewportHeight(): number
Returns number
The current viewport height.
Inherited from Camera.getViewportHeight
- Defined in Camera.ts:63

getViewportWidth

getViewportWidth(): number
Returns number
The current viewport width.
Inherited from Camera.getViewportWidth
- Defined in Camera.ts:58

getX

getX(): number
Returns number
The current x position of the camera (before snapping to pixels).
Inherited from Camera.getX
- Defined in Camera.ts:43

getY

getY(): number
Returns number
The current y position of the camera (before snapping to pixels).
Inherited from Camera.getY
- Defined in Camera.ts:48

getZoom

getZoom(): number
Returns number
The zoom value of the camera.
Inherited from Camera.getZoom
- Defined in Camera.ts:53

moveInstantly

moveInstantly(): void
Make the camera move instantly to the desired position instead of gradually moving it.

Returns void
- Defined in FollowingCamera.ts:66

moveTo

moveTo(x, y): void
Move the camera to the specified coordinates and apply pixel snapping if configured.
Parameters
- x: number
  The new x position of the camera.
- y: number
  The new y position of the camera.
Returns void
Overrides Camera.moveTo
- Defined in FollowingCamera.ts:70

resize

resize(width, height): void
Set the new viewport size of the camera.
Parameters
- width: number
  The new width of the viewport.
- height: number
  The new height of the viewport.
Returns void
Overrides Camera.resize
- Defined in FollowingCamera.ts:75

setBounds

setBounds(bounds): void
Set camera bounds.
Parameters
- bounds: null | CameraBounds
  The new bounds or null to remove the current bounds.
Returns void
Inherited from Camera.setBounds
- Defined in Camera.ts:130

`Protected` setPosition

setPosition(x, y): void
Set the camera to the specified coordinates and apply pixel snapping if configured.
Parameters
- x: number
  The new x position of the camera.
- y: number
  The new y position of the camera.
Returns void
Inherited from Camera.setPosition
- Defined in Camera.ts:81

setZoom

setZoom(zoom): void
Set the zoom value and update the projection matrix accordingly.
Parameters
- zoom: number
  The new zoom value.
Returns void
Inherited from Camera.setZoom
- Defined in Camera.ts:71

update

update(deltaTime): void
Perform camera movement.
Parameters
- deltaTime: number
  The time that elapsed since the last frame.
Returns void
- Defined in FollowingCamera.ts:36

`Protected` updateProjection

updateProjection(): void
Update the projection matrix to adjust for new viewport size or zoom value.

Returns void
Inherited from Camera.updateProjection
- Defined in Camera.ts:121

Class FollowingCamera

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FollowingCamera

Properties

acceleration

Protected bounds

Protected desired

lockDistance

maxSpeed

Readonly modelView

Readonly projection

slowDistance

snapToPixel

Protected speed

Protected viewportHeight

Protected viewportWidth

Protected x

Protected y

Protected zoom

Methods

getBounds

Returns null | CameraBounds

getDesired

Returns Readonly<Vector2>

getSpeed

Returns number

getViewportHeight

Returns number

getViewportWidth

Returns number

getX

Returns number

getY

Returns number

getZoom

Returns number

moveInstantly

Returns void

moveTo

Parameters

Returns void

resize

Parameters

Returns void

setBounds

Parameters

Returns void

Protected setPosition

Parameters

Returns void

setZoom

Parameters

Returns void

update

Parameters

Returns void

Protected updateProjection

Returns void

Settings

Member Visibility

Theme

On This Page

`Protected` bounds

`Protected` desired

`Readonly` modelView

`Readonly` projection

`Protected` speed

`Protected` viewportHeight

`Protected` viewportWidth

`Protected` x

`Protected` y

`Protected` zoom

`Protected` setPosition

`Protected` updateProjection