Class Camera

A simple 2D camera, which optionally snaps position values to pixels.

Hierarchy (view full)

Constructors

constructor

Properties

bounds modelView projection snapToPixel viewportHeight viewportWidth x y zoom

Methods

getBounds getViewportHeight getViewportWidth getX getY getZoom moveTo resize setBounds setPosition setZoom updateProjection

Constructors

constructor

Properties

Protected bounds

bounds: null | CameraBounds = null

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.

snapToPixel

snapToPixel: boolean = true

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

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

getViewportHeight

  • getViewportHeight(): number

  • Returns number

    The current viewport height.

getViewportWidth

  • getViewportWidth(): number

  • Returns number

    The current viewport width.

getX

  • getX(): number

  • Returns number

    The current x position of the camera (before snapping to pixels).

getY

  • getY(): number

  • Returns number

    The current y position of the camera (before snapping to pixels).

getZoom

  • getZoom(): number

  • Returns number

    The zoom value of the camera.

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

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

setBounds

  • setBounds(bounds): void

  • Set camera bounds.

    Parameters

    • bounds: null | CameraBounds

      The new bounds or null to remove the current bounds.

    Returns void

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

setZoom

  • setZoom(zoom): void

  • Set the zoom value and update the projection matrix accordingly.

    Parameters

    • zoom: number

      The new zoom value.

    Returns void

Protected updateProjection

  • updateProjection(): void

  • Update the projection matrix to adjust for new viewport size or zoom value.

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorboundsmodelViewprojectionsnapToPixelviewportHeightviewportWidthxyzoomgetBoundsgetViewportHeightgetViewportWidthgetXgetYgetZoommoveToresizesetBoundssetPositionsetZoomupdateProjection