Class BaseCamera

Implements

BoardCamera

Constructors

constructor

new BaseCamera(
    viewPortWidth?: number,
    viewPortHeight?: number,
    position?: Point,
    rotation?: number,
    zoomLevel?: number,
    boundaries?: Boundaries,
    zoomLevelBoundaries?: ZoomLevelLimits,
    rotationBoundaries?: RotationLimits,
): BaseCamera
Parameters
- viewPortWidth: number = 1000
  The width of the viewport. (The width of the canvas in css pixels)
- viewPortHeight: number = 1000
  The height of the viewport. (The height of the canvas in css pixels)
- position: Point = ...
  The position of the camera in the world coordinate system
- rotation: number = 0
  The rotation of the camera in the world coordinate system
- zoomLevel: number = 1
  The zoom level of the camera
- boundaries: Boundaries = ...
  The boundaries of the camera in the world coordinate system
- zoomLevelBoundaries: ZoomLevelLimits = ...
  The boundaries of the zoom level of the camera
- rotationBoundaries: RotationLimits = undefined
  The boundaries of the rotation of the camera
Returns BaseCamera
- Defined in board-camera/base-camera.ts:34

Accessors

boundaries

get boundaries(): Boundaries
Returns Boundaries
Implementation of BoardCamera.boundaries
- Defined in board-camera/base-camera.ts:45
set boundaries(boundaries: Boundaries): void
Parameters
- boundaries: Boundaries
Returns void
Implementation of BoardCamera.boundaries
- Defined in board-camera/base-camera.ts:49

position

get position(): Point
Returns Point
Implementation of BoardCamera.position
- Defined in board-camera/base-camera.ts:69

rotation

get rotation(): number
Returns number
Implementation of BoardCamera.rotation
- Defined in board-camera/base-camera.ts:141

rotationBoundaries

get rotationBoundaries(): RotationLimits
Returns RotationLimits
Implementation of BoardCamera.rotationBoundaries
- Defined in board-camera/base-camera.ts:145
set rotationBoundaries(rotationBoundaries: RotationLimits): void
Parameters
- rotationBoundaries: RotationLimits
Returns void
Implementation of BoardCamera.rotationBoundaries
- Defined in board-camera/base-camera.ts:149

viewPortHeight

get viewPortHeight(): number
Returns number
Implementation of BoardCamera.viewPortHeight
- Defined in board-camera/base-camera.ts:61
set viewPortHeight(height: number): void
Parameters
- height: number
Returns void
Implementation of BoardCamera.viewPortHeight
- Defined in board-camera/base-camera.ts:65

viewPortWidth

get viewPortWidth(): number
Returns number
Implementation of BoardCamera.viewPortWidth
- Defined in board-camera/base-camera.ts:53
set viewPortWidth(width: number): void
Parameters
- width: number
Returns void
Implementation of BoardCamera.viewPortWidth
- Defined in board-camera/base-camera.ts:57

zoomBoundaries

get zoomBoundaries(): ZoomLevelLimits
Returns ZoomLevelLimits
Implementation of BoardCamera.zoomBoundaries
- Defined in board-camera/base-camera.ts:89
set zoomBoundaries(zoomBoundaries: ZoomLevelLimits): void
Parameters
- zoomBoundaries: ZoomLevelLimits
Returns void
Implementation of BoardCamera.zoomBoundaries
- Defined in board-camera/base-camera.ts:93

zoomLevel

get zoomLevel(): number
Returns number
Implementation of BoardCamera.zoomLevel
- Defined in board-camera/base-camera.ts:85

Methods

convertFromViewPort2WorldSpace

convertFromViewPort2WorldSpace(point: Point): Point
Parameters
- point: Point
Returns Point
Implementation of BoardCamera.convertFromViewPort2WorldSpace
- Defined in board-camera/base-camera.ts:212

convertFromWorld2ViewPort

convertFromWorld2ViewPort(point: Point): Point
Parameters
- point: Point
Returns Point
Implementation of BoardCamera.convertFromWorld2ViewPort
- Defined in board-camera/base-camera.ts:216

getCameraOriginInWindow

getCameraOriginInWindow(centerInWindow: Point): Point
Parameters
- centerInWindow: Point
Returns Point
Implementation of BoardCamera.getCameraOriginInWindow
- Defined in board-camera/base-camera.ts:208

getTransform

getTransform(
devicePixelRatio: number,
alignCoorindate: boolean,
): { a: number; b: number; c: number; d: number; e: number; f: number }
Parameters
- devicePixelRatio: number
  The device pixel ratio of the canvas
- alignCoorindate: boolean
  Whether to align the coordinate system to the camera's position
Returns { a: number; b: number; c: number; d: number; e: number; f: number }
The transformation matrix
Translation Block
The order of the transformation is as follows:
1. Scale (scale the context using the device pixel ratio)
2. Translation (move the origin of the context to the center of the canvas)
3. Rotation (rotate the context negatively the rotation of the camera)
4. Zoom (scale the context using the zoom level of the camera)
5. Translation (move the origin of the context to the position of the camera in the context coordinate system)
Implementation of BoardCamera.getTransform
- Defined in board-camera/base-camera.ts:170

invertFromWorldSpace2ViewPort

invertFromWorldSpace2ViewPort(point: Point): Point
Parameters
- point: Point
Returns Point
- Defined in board-camera/base-camera.ts:220

pointInView

pointInView(point: Point): boolean
Parameters
- point: Point
Returns boolean
- Defined in board-camera/base-camera.ts:258

setHorizontalBoundaries

setHorizontalBoundaries(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
Implementation of BoardCamera.setHorizontalBoundaries
- Defined in board-camera/base-camera.ts:228

setMaxZoomLevel

setMaxZoomLevel(maxZoomLevel: number): boolean
Parameters
- maxZoomLevel: number
Returns boolean
- Defined in board-camera/base-camera.ts:102

setMinZoomLevel

setMinZoomLevel(minZoomLevel: number): boolean
Parameters
- minZoomLevel: number
Returns boolean
Implementation of BoardCamera.setMinZoomLevel
- Defined in board-camera/base-camera.ts:113

setPosition

setPosition(destination: Point): boolean
Parameters
- destination: Point
Returns boolean
Implementation of BoardCamera.setPosition
- Defined in board-camera/base-camera.ts:73

setRotation

setRotation(rotation: number): boolean
Parameters
- rotation: number
Returns boolean
Implementation of BoardCamera.setRotation
- Defined in board-camera/base-camera.ts:192

setVerticalBoundaries

setVerticalBoundaries(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
Implementation of BoardCamera.setVerticalBoundaries
- Defined in board-camera/base-camera.ts:245

setZoomLevel

setZoomLevel(zoomLevel: number): boolean
Parameters
- zoomLevel: number
Returns boolean
Implementation of BoardCamera.setZoomLevel
- Defined in board-camera/base-camera.ts:127

Class BaseCamera

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseCamera

Accessors

boundaries

Returns Boundaries

Parameters

Returns void

position

Returns Point

rotation

Returns number

rotationBoundaries

Returns RotationLimits

Parameters

Returns void

viewPortHeight

Returns number

Parameters

Returns void

viewPortWidth

Returns number

Parameters

Returns void

zoomBoundaries

Returns ZoomLevelLimits

Parameters

Returns void

zoomLevel

Returns number

Methods

convertFromViewPort2WorldSpace

Parameters

Returns Point

convertFromWorld2ViewPort

Parameters

Returns Point

getCameraOriginInWindow

Parameters

Returns Point

getTransform

Parameters

Returns { a: number; b: number; c: number; d: number; e: number; f: number }

Translation Block

invertFromWorldSpace2ViewPort

Parameters

Returns Point

pointInView

Parameters

Returns boolean

setHorizontalBoundaries

Parameters

Returns void

setMaxZoomLevel

Parameters

Returns boolean

setMinZoomLevel

Parameters

Returns boolean

setPosition

Parameters

Returns boolean

setRotation

Parameters

Returns boolean

setVerticalBoundaries

Parameters

Returns void

setZoomLevel

Parameters

Returns boolean

Settings

On This Page