PointerEventReceiver

The PointerEventProcessor is responsible for collecting all the events from the canvas and transforming them into GlobalCoordinates

Index

Constructors

• constructor

Properties

• currentFrameCancel
• currentFrameDown
• currentFrameMove
• currentFramePointerCoords
• currentFramePointerDown
• currentFrameUp
• currentFrameWheel
• engine
• events
• lastFramePointerCoords
• lastFramePointerDown
• primary
• target

Methods

• at
• clear
• count
• detach
• emit
• init
• isDown
• isDragEnd
• isDragStart
• isDragging
• off
• on
• once
• recreate
• toggleEnabled
• triggerEvent
• wasDown

Constructors

constructor

• new PointerEventReceiver(target: GlobalEventHandlers & EventTarget, engine: Engine<any>): PointerEventReceiver

• Parameters

  • target: GlobalEventHandlers & EventTarget

  • engine: Engine<any>

  Returns PointerEventReceiver

Properties

publiccurrentFrameCancel

currentFrameCancel: PointerEvent[] = []

publiccurrentFrameDown

currentFrameDown: PointerEvent[] = []

publiccurrentFrameMove

currentFrameMove: PointerEvent[] = []

publiccurrentFramePointerCoords

currentFramePointerCoords: Map<number, GlobalCoordinates> = ...

publiccurrentFramePointerDown

currentFramePointerDown: Map<number, boolean> = ...

publiccurrentFrameUp

currentFrameUp: PointerEvent[] = []

publiccurrentFrameWheel

currentFrameWheel: WheelEvent[] = []

publicengine

engine: Engine<any>

publicevents

events: EventEmitter<PointerEvents> = ...

publiclastFramePointerCoords

lastFramePointerCoords: Map<number, GlobalCoordinates> = ...

publiclastFramePointerDown

lastFramePointerDown: Map<number, boolean> = ...

publicprimary

primary: PointerAbstraction = ...

publicreadonlytarget

target: GlobalEventHandlers & EventTarget

Methods

publicat

• at(index: number): PointerAbstraction

• Locates a specific pointer by id, creates it if it doesn't exist

  ---

  Parameters

  • index: number

  Returns PointerAbstraction

publicclear

• clear(): void

• Clears the current frame event and pointer data

  ---

  Returns void

publiccount

• count(): number

• The number of pointers currently being tracked by excalibur

  ---

  Returns number

publicdetach

• detach(): void

• Returns void

publicemit

• emit<TEventName>(eventName: TEventName, event: PointerEvents[TEventName]): void
• emit(eventName: string, event?: any): void

• Type parameters

  • TEventName: EventKey<PointerEvents>

  Parameters

  • eventName: TEventName

  • event: PointerEvents[TEventName]

  Returns void

publicinit

• init(options?: PointerInitOptions): void

• Initializes the pointer event receiver so that it can start listening to native browser events.

  ---

  Parameters

  • optionaloptions: PointerInitOptions

  Returns void

publicisDown

• isDown(pointerId: number): boolean

• Is the specified pointer id down this frame

  ---

  Parameters

  • pointerId: number

  Returns boolean

publicisDragEnd

• isDragEnd(pointerId: number): boolean

• Whether the Pointer just ended dragging.

  ---

  Parameters

  • pointerId: number

  Returns boolean

publicisDragStart

• isDragStart(pointerId: number): boolean

• Whether the Pointer just started dragging.

  ---

  Parameters

  • pointerId: number

  Returns boolean

publicisDragging

• isDragging(pointerId: number): boolean

• Whether the Pointer is currently dragging.

  ---

  Parameters

  • pointerId: number

  Returns boolean

publicoff

• off<TEventName>(eventName: TEventName, handler: Handler<PointerEvents[TEventName]>): void
• off(eventName: string, handler: Handler<unknown>): void
• off(eventName: string): void

• Type parameters

  • TEventName: EventKey<PointerEvents>

  Parameters

  • eventName: TEventName

  • handler: Handler<PointerEvents[TEventName]>

  Returns void

publicon

• on<TEventName>(eventName: TEventName, handler: Handler<PointerEvents[TEventName]>): Subscription
• on(eventName: string, handler: Handler<unknown>): Subscription

• Type parameters

  • TEventName: EventKey<PointerEvents>

  Parameters

  • eventName: TEventName

  • handler: Handler<PointerEvents[TEventName]>

  Returns Subscription

publiconce

• once<TEventName>(eventName: TEventName, handler: Handler<PointerEvents[TEventName]>): Subscription
• once(eventName: string, handler: Handler<unknown>): Subscription

• Type parameters

  • TEventName: EventKey<PointerEvents>

  Parameters

  • eventName: TEventName

  • handler: Handler<PointerEvents[TEventName]>

  Returns Subscription

publicrecreate

• recreate(target: GlobalEventHandlers & EventTarget, engine: Engine<any>): PointerEventReceiver

• Creates a new PointerEventReceiver with a new target and engine while preserving existing pointer event handlers.

  ---

  Parameters

  • target: GlobalEventHandlers & EventTarget

  • engine: Engine<any>

  Returns PointerEventReceiver

publictoggleEnabled

• toggleEnabled(enabled: boolean): void

• Parameters

  • enabled: boolean

  Returns void

publictriggerEvent

• triggerEvent(type: down | up | move | cancel, pos: Vector): void

• Triggers an excalibur pointer event in a world space pos

  Useful for testing pointers in excalibur

  ---

  Parameters

  • type: down | up | move | cancel

  • pos: Vector

  Returns void

publicwasDown

• wasDown(pointerId: number): boolean

• Was the specified pointer id down last frame

  ---

  Parameters

  • pointerId: number

  Returns boolean