BatchedDOMEvent¶

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery/blob/main/js/input/BatchedDOMEvent.ts for the most up-to-date information.

Overview¶

Pooled structure to record batched events efficiently. How it calls the callback is based on the type (pointer/mspointer/touch/mouse). There is one BatchedDOMEvent for each DOM Event (not for each touch).

@author Jonathan Olson <jonathan.olson@colorado.edu>

Class BatchedDOMEvent¶

import { BatchedDOMEvent } from 'scenerystack/scenery';

Constructor¶

new BatchedDOMEvent( eventContext : EventContext, type : BatchedDOMEventType, callback : BatchedDOMEventCallback )¶

Instance Methods¶

initialize( eventContext : EventContext, type : BatchedDOMEventType, callback : BatchedDOMEventCallback ) : this¶

run( input : Input )¶

dispose()¶

Releases references

freeToPool()¶

Static Properties¶

pool : Pool¶

(readonly)

Type BatchedDOMEventCallback¶

import type { BatchedDOMEventCallback } from 'scenerystack/scenery';

( ...args: IntentionalAny[] ) => void

Class BatchedDOMEventType¶

import { BatchedDOMEventType } from 'scenerystack/scenery';

Static Properties¶

POINTER_TYPE : BatchedDOMEventType¶

(readonly)

MS_POINTER_TYPE : BatchedDOMEventType¶

(readonly)

TOUCH_TYPE : BatchedDOMEventType¶

(readonly)

MOUSE_TYPE : BatchedDOMEventType¶

(readonly)

WHEEL_TYPE : BatchedDOMEventType¶

(readonly)

ALT_TYPE : BatchedDOMEventType¶

(readonly)

enumeration : Enumeration¶

(readonly)

Source Code¶

See the source for BatchedDOMEvent.ts in the scenery repository.