CameraRig
Defined in: camera/camera.ts:148
Mutable camera + viewport holder. Every mutation notifies onChange exactly once, which is
the single hook the render loop needs — no caller anywhere has to remember to request a draw.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CameraRig(
readViewport,camera):CameraRig
Defined in: camera/camera.ts:156
Parameters
Section titled “Parameters”readViewport
Section titled “readViewport”() => Viewport
camera
Section titled “camera”Returns
Section titled “Returns”CameraRig
Properties
Section titled “Properties”camera
Section titled “camera”camera:
Camera
Defined in: camera/camera.ts:150
The current camera. Change it through set, so onChange fires.
limit: ((
camera) =>Camera) |null=null
Defined in: camera/camera.ts:154
Keeps every camera set within limits (limitCamera), or null for none.
onChange
Section titled “onChange”onChange: (() =>
void) |null=null
Defined in: camera/camera.ts:152
Called after every change of camera.
Accessors
Section titled “Accessors”viewport
Section titled “viewport”Get Signature
Section titled “Get Signature”get viewport():
Viewport
Defined in: camera/camera.ts:164
The current viewport, read fresh each time.
Returns
Section titled “Returns”Methods
Section titled “Methods”panByScreen()
Section titled “panByScreen()”panByScreen(
dx,dy):void
Defined in: camera/camera.ts:176
Pan by a screen-space delta (the direction a finger/mouse moved: content follows it).
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
screenToWorld()
Section titled “screenToWorld()”screenToWorld(
screenX,screenY):ScreenPoint
Defined in: camera/camera.ts:197
Which world point is under a screen point now.
Parameters
Section titled “Parameters”screenX
Section titled “screenX”number
screenY
Section titled “screenY”number
Returns
Section titled “Returns”set(
camera):void
Defined in: camera/camera.ts:169
Moves the camera, clamping its scale and applying limit, and notifies onChange.
Parameters
Section titled “Parameters”camera
Section titled “camera”Returns
Section titled “Returns”void
worldToScreen()
Section titled “worldToScreen()”worldToScreen(
worldX,worldY):ScreenPoint
Defined in: camera/camera.ts:192
Where a world point is on screen now.
Parameters
Section titled “Parameters”worldX
Section titled “worldX”number
worldY
Section titled “worldY”number
Returns
Section titled “Returns”zoomAtScreen()
Section titled “zoomAtScreen()”zoomAtScreen(
screen,factor):void
Defined in: camera/camera.ts:181
Zooms by factor about a screen point, keeping that point still.
Parameters
Section titled “Parameters”screen
Section titled “screen”factor
Section titled “factor”number
Returns
Section titled “Returns”void