Class Camera

classdesc: Creates a DuckEngine Camera
description: The Camera Class. Creates and uses a viewport that acts like a camera
since: 1.0.0-beta

Hierarchy

Camera

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Camera(game: Game, scene: Scene): Camera

- Defined in core/camera/camera.ts:111
description
Creates a Camera instance.

since
1.0.0-beta

Parameters
- game: Game
  
  Game instance
- scene: Scene
  
  Scene instance
Returns Camera

Properties

Protected aspectRatio

aspectRatio: undefined | number

Protected bounds

bounds: undefined | { h: number; position: { x: number; y: number }; w: number }

distance

distance: number

memberof: Camera
description: The Camera's current zoom
since: 2.1.0

fieldOfView

fieldOfView: number

memberof: Camera
description: The Camera's current FOV
since: 2.1.0

following

following: undefined | Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>

memberof: Camera
description: A gameobject that the Camera is currently following
since

game

game: Game

memberof: Camera
description: Game instance
since: 1.0.0-beta

Readonly isMain

isMain: boolean

memberof: Camera
description: Determines if the camera is a main camera in the attached scene. Must be added by Scene.mainCamera
since: 1.0.0-beta

Protected lerpX

lerpX: number = 1

Protected lerpY

lerpY: number = 1

Protected lookAt

lookAt: number[]

scene

scene: Scene

memberof: Camera
description: Scene instance
since: 2.0.0

viewport

viewport: { bottom: number; h: number; left: number; right: number; scale: number[]; top: number; w: number }

memberof: Camera
description: Camera's viewport, has info about the viewport
since: 1.0.0-beta

Type declaration

bottom: number
h: number
left: number
right: number
scale: number[]
top: number
w: number

Accessors

defaultFOV

get defaultFOV(): number

- Defined in core/camera/camera.ts:738
memberof
Camera

description
Returns the default FOV

since
1.0.0

Returns number

defaultZoom

get defaultZoom(): number

- Defined in core/camera/camera.ts:720
memberof
Camera

description
Returns the default zoom, also uses DPR scaling if enabled

since
1.0.0

Returns number

Methods

Protected applyScale

applyScale(): void

- Defined in core/camera/camera.ts:232
Returns void

Protected applyTranslation

applyTranslation(): void

- Defined in core/camera/camera.ts:239
Returns void

autoCull

autoCull(options?: CullingOptions): void

- Defined in core/camera/camera.ts:614
memberof
Camera

description
A form of Frustum Culling that gets all objects visible to the player by the viewport's width and height and culls those objects and does not render objects outside/not-visible to the player/camera

since
2.0.0

Parameters
- Optional options: CullingOptions
Returns void

begin

begin(): void

- Defined in core/camera/camera.ts:146
memberof
Camera

description
Begins camera path

DO NOT CALL MANUALLY, CALLED IN GAME -> SCENE LOOP AUTOMATICALLY

since
1.0.0-beta

Returns void

cull

cull(renderableObjects: Renderable[], options?: CullingOptions): void

- Defined in core/camera/camera.ts:542
memberof
Camera

description
Culls/Renders objects that are passed and does not render other object that are not passed

since
2.0.0

Parameters
- renderableObjects: Renderable[]
  
  Objects that should be culled/rendered
- Optional options: CullingOptions
Returns void

end

end(): void

- Defined in core/camera/camera.ts:228
memberof
Camera

description
Ends camera path

DO NOT CALL MANUALLY, CALLED IN GAME -> SCENE LOOP AUTOMATICALLY

since
1.0.0-beta

Returns void

moveTo

moveTo(x: number, y: number): void

- Defined in core/camera/camera.ts:338
memberof
Camera

description
Moves the camera to a position

since
1.0.0-beta

Parameters
- x: number
  
  X position
- y: number
  
  Y position
Returns void

resetFOV

resetFOV(): void

- Defined in core/camera/camera.ts:467
memberof
Camera

description
Resets the FOV to the default value

since
1.0.0-beta

Returns void

resetZoom

resetZoom(): void

- Defined in core/camera/camera.ts:476
memberof
Camera

description
Resets the Zoom to the default value

since
1.0.0-beta

Returns void

screenToWorld

screenToWorld(x: number, y: number, obj: Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>): Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>

- Defined in core/camera/camera.ts:379
memberof
Camera

description
Transforms a coordinate pair from screen coordinates (relative to the canvas) into world coordinates

since
1.0.0-beta

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- obj: Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>
  
  GameObject
Returns Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>

setBounds

setBounds(bounds: { h: number; position: { x: number; y: number }; w: number }): void

- Defined in core/camera/camera.ts:486
memberof
Camera

description
Bounds of the Camera, an area the camera can be in

since
1.0.0-beta

Parameters
- bounds: { h: number; position: { x: number; y: number }; w: number }
  - h: number
  - position: { x: number; y: number }
    - x: number
    - y: number
  - w: number
Returns void

setFOV

setFOV(f: number): void

- Defined in core/camera/camera.ts:414
memberof
Camera

description
Sets the FOV

since
1.0.0-beta

Parameters
- f: number
  
  FOV value
Returns void

setFOVSmooth

setFOVSmooth(intervalMS: number, smoothValue: number, f: number): void

- Defined in core/camera/camera.ts:426
memberof
Camera

description
Sets the FOV smoothly

since
1.0.0-beta

Parameters
- intervalMS: number
  
  How often FOV is modified by smoothValue
- smoothValue: number
  
  The number that is added to FOV on an interval
- f: number
  
  Target FOV value
Returns void

setZoom

setZoom(z: number): void

- Defined in core/camera/camera.ts:282
memberof
Camera

description
Sets the zoom

since
1.0.0-beta

Parameters
- z: number
  
  Zoom value
Returns void

setZoomSmooth

setZoomSmooth(intervalMS: number, smoothValue: number, z: number): void

- Defined in core/camera/camera.ts:295
memberof
Camera

description
Sets the zoom smoothly

since
1.0.0-beta

Parameters
- intervalMS: number
  
  How often zoom is modified by smoothValue
- smoothValue: number
  
  The number that is added to zoom on an interval
- z: number
  
  Target Zoom value
Returns void

shake

shake(intervalMS: number, timeMS: number, v: number): void

- Defined in core/camera/camera.ts:502
memberof
Camera

description
Shakes the camera

since
1.0.0

Parameters
- intervalMS: number
  
  How often (in milliseconds) the passed value is added/subtracted from the Camera viewport position
- timeMS: number
  
  For how long in milliseconds the shake lasts
- v: number
  
  Value to be added/subtracted from the Camera viewport position
Returns void

startFollow

startFollow(gameObject: Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>, lerpX?: number, lerpY?: number): void

- Defined in core/camera/camera.ts:352
memberof
Camera

description
Follows a GameObject

since
1.0.0-beta

Parameters
- gameObject: Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>
  
  Game object to follow
- lerpX: number = 1
- lerpY: number = 1
Returns void

stopFollow

stopFollow(): void

- Defined in core/camera/camera.ts:367
memberof
Camera

description
Stops following a gameobject

since
1.0.0-beta

Returns void

Protected updateViewport

updateViewport(): void

- Defined in core/camera/camera.ts:243
Returns void

worldToScreen

worldToScreen(x: number, y: number, obj: Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>): Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>

- Defined in core/camera/camera.ts:398
memberof
Camera

description
Transforms a coordinate pair from world coordinates into screen coordinates (relative to the canvas) - useful for interacting with a Button while having a camera

since
1.0.0-beta

Parameters
- x: number
  
  X position
- y: number
  
  Y position
- obj: Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>
  
  GameObject
Returns Duck.TypeClasses.GameObjects.GameObject<Duck.Types.Texture.Type>

Generated using TypeDoc