Class InfluencedCamera

A camera being influenced by target influences (like velocity) and cues (points of interest). Optionally it can be contained within specified bounds.

Hierarchy (view full)

Camera
- InfluencedCamera

Constructors

constructor

new InfluencedCamera(): InfluencedCamera
Create a new influenced camera.

Returns InfluencedCamera
Overrides Camera.constructor
- Defined in InfluencedCamera.ts:56

Properties

`Protected` bounds

bounds: null | CameraBounds = null

`Protected` `Readonly` cueConfigs

cueConfigs: CueConfig[] = []

`Protected` finalOffset

finalOffset: Vector2 = ...

`Protected` finalZoom

finalZoom: number = 1

`Readonly` modelView

modelView: Matrix4 = ...

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

`Protected` offset

offset: Vector2 = ...

`Readonly` projection

projection: Matrix4 = ...

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

`Protected` savedZoom

savedZoom: number

snapToPixel

snapToPixel: boolean = true

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

`Protected` target

target: null | InfluencedCameraTarget = null

`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

addCue

addCue(cue): void
Register a cue for this camera.
Parameters
- cue: InfluencedCameraCue
  The cue to add.
Returns void
- Defined in InfluencedCamera.ts:86

getBounds

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

getOffset

getOffset(): Readonly<Vector2>
Returns Readonly<Vector2>
The offset that has been added in the case of a target switch.
- Defined in InfluencedCamera.ts:64

getTarget

getTarget(): null | InfluencedCameraTarget
Returns null | InfluencedCameraTarget
The current camera target.
- Defined in InfluencedCamera.ts:149

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

moveTo

moveTo(): void
Move the camera to the specified coordinates and apply pixel snapping if configured.

Returns void
Overrides Camera.moveTo
- Defined in InfluencedCamera.ts:259

removeAllCues

removeAllCues(fadeTime?): void
Unregister all cues for this camera.
Parameters
- fadeTime: number = 0
  
  0 to fade out the cues instead of instantly removing them.
Returns void
- Defined in InfluencedCamera.ts:120

removeCue

removeCue(cue, fadeTime?): void
Unregister a cue for this camera.
Parameters
- cue: InfluencedCameraCue
  The cue to remove.
- fadeTime: number = 0
  
  0 to fade out this cue instead of instantly removing it.
Returns void
- Defined in InfluencedCamera.ts:101

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 InfluencedCamera.ts:254

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

setTarget

setTarget(target): void
Set or change the camera target.
Parameters
- target: null | InfluencedCameraTarget
  The new camera target or null.
Returns void
- Defined in InfluencedCamera.ts:139

setZoom

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

update

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

`Protected` updateFadingCues

updateFadingCues(deltaTime): void
Update all fading cues.
Parameters
- deltaTime: number
  The time that elapsed since the last frame.
Returns void
- Defined in InfluencedCamera.ts:240

`Protected` updateInfluences

updateInfluences(): void
Update all influences and calculate the final offset and zoom.

Returns void
- Defined in InfluencedCamera.ts:154

`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

`Protected` updateZoom

updateZoom(zoom): void
Lerp the zoom level towards a new value.
Parameters
- zoom: number
  The target zoom level.
Returns void
- Defined in InfluencedCamera.ts:76

Class InfluencedCamera

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns InfluencedCamera

Properties

Protected bounds

Protected Readonly cueConfigs

Protected finalOffset

Protected finalZoom

Readonly modelView

Protected offset

Readonly projection

Protected savedZoom

snapToPixel

Protected target

Protected viewportHeight

Protected viewportWidth

Protected x

Protected y

Protected zoom

Methods

addCue

Parameters

Returns void

getBounds

Returns null | CameraBounds

getOffset

Returns Readonly<Vector2>

getTarget

Returns null | InfluencedCameraTarget

getViewportHeight

Returns number

getViewportWidth

Returns number

getX

Returns number

getY

Returns number

getZoom

Returns number

moveTo

Returns void

removeAllCues

Parameters

Returns void

removeCue

Parameters

Returns void

resize

Parameters

Returns void

setBounds

Parameters

Returns void

Protected setPosition

Parameters

Returns void

setTarget

Parameters

Returns void

setZoom

Parameters

Returns void

update

Parameters

Returns void

Protected updateFadingCues

Parameters

Returns void

Protected updateInfluences

Returns void

Protected updateProjection

Returns void

Protected updateZoom

Parameters

`Protected` bounds

`Protected` `Readonly` cueConfigs

`Protected` finalOffset

`Protected` finalZoom

`Readonly` modelView

`Protected` offset

`Readonly` projection

`Protected` savedZoom

`Protected` target

`Protected` viewportHeight

`Protected` viewportWidth

`Protected` x

`Protected` y

`Protected` zoom

`Protected` setPosition

`Protected` updateFadingCues

`Protected` updateInfluences

`Protected` updateProjection

`Protected` updateZoom