MockPointer

class MockPointer

Use this to mock mouse/touch/pointer events

Constructor


new MockPointer(stage: PIXI.Container, width: number, height: number, ensurePointerEvents: boolean) → {}
Parameters:
Name Type Attributes Default Description
stage PIXI.Container

<optional>

The root of the scene tree

width number

<optional>

100

Width of the renderer

height number

<optional>

100

Height of the renderer

ensurePointerEvents boolean

<optional>

false

If we should make sure that PointerEvents are 'supported'

Public Methods


cleanup MockPointer.ts:58
cleanup() → {}

Cleans up after tests

click MockPointer.ts:214
click(x: number, y: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

asPointer boolean

<optional>

if it should be a PointerEvent from a mouse

createEvent MockPointer.ts:90
createEvent(eventType: string, x: number, y: number, identifier: number, asPointer: boolean, onCanvas: boolean) → {Event}

[createEvent description]

Parameters:
Name Type Attributes Default Description
eventType string

type of event

x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id for touch events

asPointer boolean

<optional>

If it should be a PointerEvent from a mouse or touch

onCanvas boolean

<optional>

true

If the event should be on the canvas (as opposed to a different element)

Returns:
Type Description
Event

Generated MouseEvent, TouchEvent, or PointerEvent

mousedown MockPointer.ts:225
mousedown(x: number, y: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

asPointer boolean

<optional>

if it should be a PointerEvent from a mouse

mousemove MockPointer.ts:190
mousemove(x: number, y: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

asPointer boolean

<optional>

if it should be a PointerEvent from a mouse

mouseup MockPointer.ts:235
mouseup(x: number, y: number, onCanvas: boolean, asPointer: boolean) → {}
Parameters:
Name Type Attributes Default Description
x number

pointer x position

y number

pointer y position

onCanvas boolean

<optional>

true

if the event happened on the Canvas element or not

asPointer boolean

<optional>

false

if it should be a PointerEvent from a mouse

pendown MockPointer.ts:302
pendown(x: number, y: number, identifier: number) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

penmove MockPointer.ts:312
penmove(x: number, y: number, identifier: number) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

penup MockPointer.ts:322
penup(x: number, y: number, identifier: number) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

tap MockPointer.ts:246
tap(x: number, y: number, identifier: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

asPointer boolean

<optional>

if it should be a PointerEvent from a touch

touchend MockPointer.ts:280
touchend(x: number, y: number, identifier: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

asPointer boolean

<optional>

if it should be a PointerEvent from a touch

touchleave MockPointer.ts:291
touchleave(x: number, y: number, identifier: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

asPointer boolean

<optional>

if it should be a PointerEvent from a touch

touchmove MockPointer.ts:269
touchmove(x: number, y: number, identifier: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

asPointer boolean

<optional>

if it should be a PointerEvent from a touch

touchstart MockPointer.ts:258
touchstart(x: number, y: number, identifier: number, asPointer: boolean) → {}
Parameters:
Name Type Attributes Description
x number

pointer x position

y number

pointer y position

identifier number

<optional>

pointer id

asPointer boolean

<optional>

if it should be a PointerEvent from a touch


Powered by webdoc!