Class CameraZoomUpdateBatcher

Index

Constructors

Methods

getDebugInfo processQueuedUpdates queueZoomByAtWorld queueZoomToAtWorld queueZoomUpdateBy queueZoomUpdateTo subscribe

Constructors

constructor

new CameraZoomUpdateBatcher(): CameraZoomUpdateBatcher
Returns CameraZoomUpdateBatcher
- Defined in src/board-camera/batcher/camera-zoom-update.ts:32

Methods

getDebugInfo

getDebugInfo(): {
    lastUpdateTotalCalls: number;
    queueZoomUpdateCalls: number;
    queueZoomUpdateToCalls: number;
}
Get debug information about queue method calls since last update

Returns {
    lastUpdateTotalCalls: number;
    queueZoomUpdateCalls: number;
    queueZoomUpdateToCalls: number;
}
- Defined in src/board-camera/batcher/camera-zoom-update.ts:146

processQueuedUpdates

processQueuedUpdates(): ZoomUpdate
Process and clear all queued zoom updates

Returns ZoomUpdate
the update to apply to the zoom level, with type information
- Defined in src/board-camera/batcher/camera-zoom-update.ts:106

queueZoomByAtWorld

queueZoomByAtWorld(delta: number, worldAnchor: Point): void
Queue a zoom update by delta at a world anchor to be processed in the next animation frame
Parameters
- delta: number
- worldAnchor: Point
Returns void
- Defined in src/board-camera/batcher/camera-zoom-update.ts:72

queueZoomToAtWorld

queueZoomToAtWorld(destination: number, worldAnchor: Point): void
Queue a zoom update to a specific destination at a world anchor to be processed in the next animation frame
Parameters
- destination: number
- worldAnchor: Point
Returns void
- Defined in src/board-camera/batcher/camera-zoom-update.ts:89

queueZoomUpdateBy

queueZoomUpdateBy(delta: number, anchor?: Point): void
Queue a zoom update by delta to be processed in the next animation frame
Parameters
- delta: number
- Optionalanchor: Point
Returns void
- Defined in src/board-camera/batcher/camera-zoom-update.ts:55

queueZoomUpdateTo

queueZoomUpdateTo(destination: number, anchor?: Point): void
Queue a zoom update to a specific destination to be processed in the next animation frame
Parameters
- destination: number
- Optionalanchor: Point
Returns void
- Defined in src/board-camera/batcher/camera-zoom-update.ts:39

subscribe

subscribe(
observer: Observer<[ZoomUpdate]>,
options?: SubscriptionOptions,
): () => void
Subscribe to zoom updates
Parameters
- observer: Observer<[ZoomUpdate]>
- Optionaloptions: SubscriptionOptions
Returns () => void
- Defined in src/board-camera/batcher/camera-zoom-update.ts:139